Skip to main content

Pipefy Developers

Welcome to the Pipefy Developer hub. You'll find comprehensive guides and documentation to help you start working with pipefy as quickly as possible, as well as support if you get stuck. Let's jump right in!

256 Topics
Lais Laudari
Lais Laudari
published in API
API Reference > Database
API Reference > DatabaseF.A.Q.

Do you need help with your API queries and/or mutation?Here are a few that might help you!😉 🔎Queries📍 GET TABLE RECORDS WITH PAGINATION - TABLE ID{  table_records(first: 10, table_id: "XXXXXXX") {    edges {      cursor      node {        id        title        url      }    }    pageInfo {      endCursor      hasNextPage      hasPreviousPage      startCursor    }  }}📍 GET TABLE RECORDS  -  TABLE RECORD ID{  table_record(id: XXX) {    assignees {      id      name    }    created_at    created_by {      id      name    }    due_date    finished_at    id    labels {      id      name    }    parent_relations {      name      source_type    }    record_fields {      array_value      date_value      datetime_value      filled_at      float_value      name      required      updated_at      value    }    summary {      title      value    }    table {      id    }    title    updated_at    url  }}📍 FIND TABLE RECORDS  -  FIELD ID | FIELD VALUE{  findRecords(tableId:"xxxx", first: 50,

4476
rvitoriano
Lais Laudari
Lais Laudari
published in API
API Reference > Pipes
API Reference > PipesF.A.Q.

Do you need help with your API queries and/or mutation?Here are a few that might help you!😉🔎Queries📍LIST PIPES{pipes(ids: [ID1, ID2]) { id name phases {  name  cards (first: x) {    edges {    node {     id     title     }    }   }  } }} 📍SHOW PIPE{ pipe(id: 123456) {  id  name  start_form_fields {   label   id } labels {  name  id} phases {  name  fields {  label  id }  cards(first: X) {   edges {   node {   id   title    }    }   }  } }} 📍SHOW ALL FIELDS FROM PIPE{  pipe(id: XXXXX) {    start_form_fields {      id      internal_id      label      type      options    }    phases {      fields {        label        internal_id        type        options      }    }  }}🛠Mutations📍CREATE PIPEmutation { createPipe( input: { organization_id: XXXX name: "XXXX" labels: [ {name: "Label 01", color: "#FF0042"} ] members: [ {user_id: 00000, role_name: "admin"} {user_id: 00001, role_name: "member"} ] phases: [ {name: "First Step"} {name: "Finished", done: true} ] start_form_fields: [ {typ

5486
Karine Cristina
Pipefy Staff
Lais Laudari
Lais Laudari
published in API
How to bulk invite pipe members via API
How to bulk invite pipe members via APIF.A.Q.

First you will need the ID of the pipe you want to add members. Then just run the following mutation: mutation { n1: inviteMembers(input: {pipe_id: pipe ID, emails: { email: "email@email.com", role_name: "permission level"}}){ clientMutationId n2: inviteMembers(input: {pipe_id: pipe ID, emails: { email: "email@email.com", role_name: "permission level"}}){ clientMutationId n3: inviteMembers(input: {pipe_id: pipe ID, emails: { email: "email@email.com", role_name: "permission level"}}){ clientMutationId }} ⚠For the permission level use:- admin for pipe admin;- member for pipe member;- read_and_comment for restricted view;- my_cards_only for read only and- creator for start form only. 

1871
marcosmelo
Lais Laudari
Lais Laudari
published in API
API Pagination
API PaginationF.A.Q.

API queries to dense databases could potentially return millions, if not billions, of results. Pagination thus helps to limit the number of results. It’s a process used to divide a large dataset into smaller chunks (pages).⚠ Pipefy API endpoint supports pagination with a limit of 50 cards/records per pipe or 30 cards per phase.👉🏼Here are two examples of how to use pagination:🔹Example 1 > query allCards {    allCards(pipeId: xxxx, first: 50) {    pageInfo {      hasNextPage      endCursor    }    edges {      node {        id      }    }  }}You will set the pageInfo attribute and it will return the "endcursor", with the endcursor you can see the other cards within that phase, putting it as an argument in the "after" command. And  hasNextPage will show you if there are more pages. You can then use the ID returned by the endCursor to get to the next page: {allCards(pipeId:XXXXX, first:50, after:"WyIyLjI1IiwiMTg1LjAiLDI2ODc1OTNd"){pageInfo {hasNextPageendCursor}edges {node {id}}}}🔹E

7763
leonardo-mendonca
Lais Laudari
Lais Laudari
published in API
API Reference > Cards
API Reference > CardsF.A.Q.

Do you need help with your API queries and/or mutation?Here are a few that might help you!😉🔎Queries 📍LIST CARDS{ cards(pipe_id: XXXX, first: 10, search: {title: "XXXXX"}) { edges { node { id title assignees { id } comments { text } comments_count current_phase { name } done due_date fields { name value } labels { name } phases_history { phase { name } firstTimeIn lastTimeOut } url } } }}⚠This query has a limit of 50 cards/records per page, so it is necessary to use pagination, you can find this information here.  📍SHOW CARD{ card(id: XXXX) { title assignees { id } comments { text } comments_count current_phase { name } done due_date fields { name value } labels { name } phases_history { phase { name } firstTimeIn lastTimeOut } url }} 🛠Mutations 📍CREATE CARDmutation{ createCard( input: { pipe_id: XXXX fields_attributes: [ {field_id: "assignee", field_value:[00000, 00001]} {field_id: "checklist_vertical", field_value: ["a", "b"]} {field_id: "checklist_horizontal", field_value: ["b"

7266
genietim
Lais Laudari
Lais Laudari
published in API
How to get pipe and cards attachments via API
How to get pipe and cards attachments via APIF.A.Q.

You can download the attached files in a pipe!😃 To get the links to the card attachments from a pipe via API, these are the queries you will need: ◾Attachments to cards on the pipe{  cards(pipe_id:XXX){    pageInfo{      hasNextPage      endCursor    }    edges{      node{        id        title        attachments{          url        }      }    }  }}◾Card attachments{  card(id:XXXX) {    attachments {      createdAt      path      url    }  }}

6241
marcosmelo
Lais Laudari
Lais Laudari
published in API
How to generate a report via API?
How to generate a report via API?F.A.Q.

First you need to have a report already defined, with the filters you want.Then you can run the following mutation:mutation {exportPipeReport(input: { pipeId: X, pipeReportId: X}) {pipeReportExport {id}}}The answer to this call will contain a numeric ID. Using this ID obtained in the previous call, you can execute the following query:{pipeReportExport(id: XX) {fileURLstatestartedAtrequestedBy {id}}}The result of this second call will generate a link, which you can copy and paste into your browser and the file will be generated!⚠Important: Requests are counted from the last request the client made before taking the request limit and not when the day ends.You have 24 hours to make a new request after receiving the daily request limit message, but not from 00:00 to 00:00 but from the last request the client made. In this case, if you made the last request before receiving the message, for example, at 9 a.m., you can only redo the request at 9 a.m. the next day.  

3102
Ezequiel Souza
Lais Laudari
Lais Laudari
published in API
API References > Comments
API References > CommentsF.A.Q.

Do you need help with your API queries and/or mutation?Here are a few that might help you!😉 🔎Queries 📍LIST COMMENTS FROM A CARD{  card(id:xxxxxxxx) {    title    comments {      id      author_name      created_at      text    }  }}🛠Mutations 📍CREATE COMMENTmutation {createComment(input: {card_id: XXXXXXXtext: "Life is like a box of chocolates.."}) {comment {idtext}}}📍UPDATE COMMENTmutation {updateComment(input: {id: XXXXXtext: "Let me explain something to you."}) {comment {idtext}}}📍DELETE COMMENTmutation {deleteComment(input:{id: XXXX}) {success}}

2761
marcosmelo
Lais Laudari
Lais Laudari
published in API
API Reference > Label
API Reference > LabelF.A.Q.

Do you need help with your API queries and/or mutation?Here are a few that might help you!😉 🛠Mutations📍CREATE LABELmutation { createLabel( input: { pipe_id: XXXX name: "Important!" color: "#FF0000" } ) { label { id name } }} 📍UPDATE LABELmutation { updateLabel( input: { id: XXXXX name: "Very Important!" color: "#FF6347" } ) { label { id name } }}📍DELETE LABELmutation { deleteLabel(input: { id: XXXX }) { success }}

2814
Lais Laudari
Lais Laudari
Lais Laudari
published in API
API Reference > Phases
API Reference > PhasesF.A.Q.

Do you need help with your API queries and/or mutation?Here are a few that might help you!😉🔎Queries📍SHOW PHASE{ phase(id: XXX) { id name cards_count cards { edges { node { id title } } } fields { id } }}📍SHOW ALL PHASES FROM PIPE{pipe(id:XXXXX){phases{idnamecards_count}}}🛠Mutations📍CREATE PHASEmutation { createPhase( input: { pipe_id: XXXX name: "First Phase" done: false lateness_time: 172800 description: "XXXXXXXXXX" can_receive_card_directly_from_draft: true } ) { phase { id name } }}📍UPDATE PHASEmutation { updatePhase( input: { id: XXXXXXX name: "New name" done: true description: "New phase description" can_receive_card_directly_from_draft: false } ) { phase { id name } }}📍DELETE PHASEmutation { deletePhase( input: { id: XXXX }) { success }} 📍CREATE PHASE FIELDmutation { createPhaseField( input: { phase_id: XXXXX type: "radio_horizontal" label: "Did you finish the task?" options: ["Yes", "No"] description: "XXXX" required: true editable: false } ) { phase_field { id label }

2872
Ezequiel Souza
Marcos Carvalho
Pipefy Staff
Marcos CarvalhoPipefy Staff
published in API
💎 Pipefy GraphQL API Reference documentation is now updated!
💎 Pipefy GraphQL API Reference documentation is now updated!

Hey everyone! Pipefy GraphQL API Reference documentation https://api-docs.pipefy.com is now updated!In this new version we fixed some broken links and also all latest mutations, queries or any other changes in our GraphQL API are now available. This is way of improving even more Pipefy integrations capabilities and deliver better documentation to our customers and developers community.But it's important to remember that our official documentation page is https://developers.pipefy.comThis is the home page where developers can have access to other documentation features like code examples, articles about GraphQL and many more.When it’s necessary a more in depth documentation, then the GraphQL API Reference is the place for it! It's a reference containing all possibilities to work with the Pipefy API explaining the concepts of Card, Pipe, Table, etc. and also available fields, required fields and their data types.We hope you like it and feel free to give us feedbacks and ideas. 

8592
Marcos Carvalho
Pipefy Staff
Marcos Carvalho
Pipefy Staff
Marcos CarvalhoPipefy Staff
published in API
💡 Pipefy User Management API
💡 Pipefy User Management API

Hi everyone! It’s Marcos from Pipefy Engineering team.  Pipefy has released a new set of functionalities in our GraphQL API to enable user management in Organizations (a company’s account in Pipefy), Pipes (processes) and Tables (databases). New mutations, queries and webhooks were created in order to manage users and their roles through API, enabling many possibilities of integrations between Pipefy and Active Directory or any other user provisioning application and helping administrators to have more control, governance and security over organization users. Here some more details about these new possibilities in our API documentation Changelogs:  User Management Mutations ​​​​​​User Management Webhooks For more information, please refer to Pipefy Developers page. Hope you like it and if you have any questions or suggestions, please let us know!  

4600
Marcos Carvalho
Pipefy Staff
Juliana Spinardi
Pipefy Staff
Juliana SpinardiPipefy Staff
published in Customs Apps & Integrations
Welcome to the Pipefy Developers!
Welcome to the Pipefy Developers!

Welcome to the Pipefy Developers ! Here you can find documentation on how to develop your own Pipefy App and on how to use GraphQL API query language to extend Pipefy capabilities.Pipefy is a process platform designed to standardize and advance business workflow processes. Users can create custom workflows, generate reports to find process bottlenecks, centralize communications, and improve overall productivity by using Pipefy.The Pipefy Developers is an open space where developers can build powerful products on Pipefy’s platform. Create game-changing process advancements for your team or for managers in +15k companies around the world.What you can do on the Pipefy Developers: 

3850
Juliana Spinardi
Pipefy Staff
ramongb
ramongbInspiring
asked in API
Webhook filter for update fields

Hi there,In the documentation of Webhooks Filters is mentioned that you can filter by field ID, but it is waitng an array of integers. As far as I know, I have used ids like (id) “field_2_string” when reading fields and “this_type_of_id” (index_name) for writing. There is also the uuid. But how can I get a numeric ID for fields that can be used in filters?It says:mutation { createWebhook(input: { actions: ["card.field_update"], name: "Field Update Webhook", pipe_id: 123456, url: "https://your-endpoint.com/", filters: { field_id: [ 123, 345 ] } }) { webhook { id actions url } } }  I try using the following mutation:mutation { createWebhook( input: { actions: ["card.field_update"], filters: { field_id: [ "field_37_string" ] }, name: "card.field_update", url: "myserver.app", email: "myemail@gobusinessinc.com", pipe_id: 1234 } ) { webhook { id actions ur

121
ramongb
Marcelo-Movtec
Marcelo-MovtecNew Member
asked in API
Criar card com campos preenchidos via n8n

Fala, galera.Estou conseguindo criar os cards via n8n porém os campos não estão sendo preenchidos.Funciona quando eu mando somente como título mas quando peço para preencher os campos não funciona. {  "query": "mutation ($input: CreateCardInput!) { createCard(input: $input) { card { id title url } } }",  "variables": {    "input": {      "pipe_id": x,      "title": "Criar card via n8n",      ]    }  }} Coloquei no GPT 5 e ele pede para codar com a seguinte linha após o title:        { "field_id": "nome_do_solicitante", "field_value": "Fulano da Silva" },        { "field_id": "email_contato",        "field_value": "fulano@exemplo.com" },        { "field_id": "telefone",             "field_value": "+55 11 99999-0000" },        { "field_id": "descricao",            "field_value": "Texto livre aqui" } Porém sem sucesso.Conseguem me ajudar?

110
Marcelo-Movtec
Francooo94
Francooo94Explorer
asked in API
Qual é o campo do currence_phase_age para saber a idade da ultima mensagem vinculada ao cartão

Bom dia Pessoal, todos bem? Gostaria de ajuda para saber qual é o campo do currence_phase_age (esse campo é para saber quando o cartão foi criado dentro daquela fase) preciso saber o campo que representa a idade da ultima mensagem que está vinculada nesse cartão?Desde já agradeço pela atenção. 

171
joao-quint
Pipefy Staff
dtanci
dtanciNew Member
asked in Customs Apps & Integrations
Buscar card especifico no n8n

Boa tarde, estou querendo buscar um card especifico pelo campo cpf do card mas sem sucesso até agora.Requisição POSTurl: https://api.pipefy.com/graphqlbody:{ "query": "query { allCards(pipeId: id_pipe, filter: {field: \"cpf_proponente\", operator: equal, value: \"cpf_da_busca\"}) { edges { node { id title createdAt fields { name value } } } } }"}erro retornado:[  {    "data": {      "allCards": null    },    "errors": [      {        "message": "Algo deu errado",        "locations": [          {            "line": 1,            "column": 9          }        ],        "path": [          "allCards"        ],        "extensions": {          "code": "INTERNAL_SERVER_ERROR",          "correlation_id": "97241d9fbb55d0c0-CDG"        }      }    ]  }] 

130
dtanci
renan_marcelo
renan_marceloInspiring
asked in Customs Apps & Integrations
Dúvida Requisição HTTP para n8n

Pessoal, bom dia. Espero que estejam bem. Gostaria que alguém me ajudasse a como configurar uma automação do tipo ‘Faça uma requisição HTTP’ da Pipefy, de maneira que quando um card for criado em determinado pipe, todos os dados do formulário inicial sejam enviados para a n8n (https://n8n.io/) Alguém já fez isso? Obrigado.  

883
Felipe Alves
Pipefy Staff
Jay2241
Jay2241
asked in API
inbox_emails

Hello,I am building a custom dashboard to display the latest emails from the pipe. I understand there is an API endpoint called inbox_email, but I do not see many parameters available for configuration. Therefore, I believe I need to integrate the inbox_email endpoint with other API endpoints to retrieve the information I need.If, for example, a card has 50 emails and I use the inbox_email endpoint, will it display all 50 emails, or is there a way to limit the results to only the most recent ones? If it retrieves all 50 emails, does that mean it will consume 50 API calls or just one? Our system is not very busy, so it is not necessary to create a cron job to pull these records at regular intervals. Is there a way to configure the API, perhaps using webhooks, so that the API is only triggered when a new email arrives?The dashboard should display the latest emails, ideally those received within the past 24 hours. Any ideas or guidance would be appreciated. 

232
Yuri Costa
Pipefy Staff
carlos-silva-intlmkt
carlos-silva-intlmktExplorer
asked in Customs Apps & Integrations
Link público Workato

Bom dia, pessoal! Gostaria de saber se há alguma maneira de inserir o link público da fase em uma integração da Workato.A automação é o seguinte, quando o card entrar numa fase, dispara uma mensagem no Slack com um resumo da solicitação e aí gostaria de inserir o link do fase nessa mensagem.  

921
joao-quint
Pipefy Staff
gbenassi
gbenassiExplorer
asked in API
GraphQl Query - updateFieldsValues - Campo tipo Numeros

Estou usando o GraphQl pelo Make(Integromat) para atualizar vários campos ao mesmo tempo de um CARD. Mas coincidentemente, dois campos que são do tipo número estão retornando com mensagens de Field not found. Já mudei o nome da campo colocando a inicial maiúscula mas a mesma mensagem persiste.Entrei em contato com o suporte do MAKE e me disseram que o problema é no Pipefy.Será que estou fazendo algo errado?     Abaixo o Código:mutation {updateFieldsValues(input: {nodeId: 1097512534values: [{ fieldId: “nome” value: “Gilberto” },{ fieldId: “telefone” value: “65999730296” },{ fieldId: “data_de_nascimento” value: “20/02/1983” },{ fieldId: “nome_contato_emergencia” value: “Ana” },{ fieldId: “telefone_contato_emergencia” value: “65999834949” },{ fieldId: “vinculo_contato_emergencia” value: “Outros” },]}) {successuserErrors { field message }updatedNode {… on Card {idfields {namevalue}}}}} O suporte do Make me pediu pra compartilhar com o Pipefy o API Request e API Response: {    "response": {

301
diogo.pessoa
Pipefy Staff
ti-ihc
ti-ihcNew Member
asked in API
API POWER AUTOMATE > PIPEFY - UPDATECARDVALUE

ERRO TO SEND API UPDATE ON POWER AUTOMATE.ERROR: errors.0.messageUnexpected end of document   

221
joao-quint
Pipefy Staff
Igor P.
Igor P.Explorer
asked in Customs Apps & Integrations
"Como enviar mensagem personalizada no WhatsApp ao mover um card, sem usar Zapier?

Olá, pessoal! Tudo bem?Gostaria de saber se é possível, ao mover um card, disparar uma mensagem via WhatsApp para o cliente com conteúdo personalizado, utilizando alguma ferramenta que não seja o Zapier. Pelo que verifiquei, o Zapier só permite o envio de mensagens com template previamente aprovado, o que limita bastante a personalização.Alguém conhece alguma alternativa que permita esse tipo de automação com mensagens personalizadas?

411
joao-quint
Pipefy Staff
Victor Carvalho
Victor CarvalhoNew Member
asked in API
API - Sharepoint > Workato > Pipefy

I need to connect a SharePoint spreadsheet to Pipefy via Workato. I have already created the connections, but when creating the SharePoint Recipe I cannot find the Excel file via URL. Has anyone made this connection?

111
Leonardo Lucena
Pipefy Staff
nphilips
nphilipsExplorer
asked in API
See parent connections via the API

When I query the API for database records, how can I tell if a record is connected to a parent card?From what I can tell, the ‘Parent Connection’ property only shows if a connection exists, not whether any specific record is actually connected to a card.If this is not possible, is there a way to do this from the other end - use the API to see if a card has any child records connected?Thank you.

191
natalia-manffre
Pipefy Staff

Community Experts Leaderboard

Terms & ConditionsCookie settings