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!

242 Topics
Lais Laudari
Lais Laudari
published in API
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 PIPE mutation { 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: [ {type_id: "short_text", label: "Taks Name", editable: true} {type_id: "email", label: "Contact Email"} ] preferences: { inbox

4546
Karine Cristina
Pipefy Staff
Lais Laudari
Lais Laudari
published in 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.

1471
marcosmelo
Lais Laudari
Lais Laudari
published in API
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 { hasNextPage endCursor } edges { node { id } } } } 🔹 Example 2 > query findCard

6273
leonardo-mendonca
Lais Laudari
Lais Laudari
published in API
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 CARD mutation{ 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:

6016
genietim
Lais Laudari
Lais Laudari
published in API
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, search:{fieldId:"xxx", fieldValue:"xxxx"}){ edges{ node{ title id } } }} 🛠Mutations 📍CREATE TABLE RECORD mutation { createTableRecord( input: { table_id: "xxxxx" title: "my record" due_date: "2017-12-31T00:00-03:00" fields_attribu

3232
Ezequiel Souza
Lais Laudari
Lais Laudari
published in 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 } }}

5111
marcosmelo
Lais Laudari
Lais Laudari
published in 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) { fileURL state startedAt requestedBy { 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.

2492
Ezequiel Souza
Lais Laudari
Lais Laudari
published in API
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 {id text }}} 📍DELETE COMMENT mutation {deleteComment(input:{id: XXXX}) {success}}

2001
marcosmelo
Lais Laudari
Lais Laudari
published in API
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 LABEL mutation { createLabel( input: { pipe_id: XXXX name: "Important!" color: "#FF0000" } ) { label { id name } }} 📍UPDATE LABEL mutation { updateLabel( input: { id: XXXXX name: "Very Important!" color: "#FF6347" } ) { label { id name } }} 📍DELETE LABEL mutation { deleteLabel(input: { id: XXXX }) { success }}

2204
Lais Laudari
Lais Laudari
Lais Laudari
published in API
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 PHASE mutation { deletePhase( input: { id: XXXX }) { success }} 📍CREATE PHASE FIELD mutation { 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 {

2162
Ezequiel Souza
Marcos Carvalho
Pipefy Staff
Marcos CarvalhoPipefy Staff
published in API
💎 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 i t's important to remember that our official documentation page is https://developers.pipefy.com This 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.

7832
Marcos Carvalho
Pipefy Staff
Marcos Carvalho
Pipefy Staff
Marcos CarvalhoPipefy Staff
published in 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!

4390
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 ! 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:

3500
Juliana Spinardi
Pipefy Staff
miguel-rodolpho
miguel-rodolphoNew Member
asked in API
Can't retrieve alls cards from a pipe

Hello everyone. I am trying to obtain all the cards from a pipe using the following query/code: pagina = true while pagina == True: # Define quais informações serão extraídas dos cards do pipe query = """ { allCards(pipeId: %s, first: 50, after: "%s") { pageInfo { hasNextPage endCursor } edges { node { id current_phase { name } done fields { name value } } cursor } } } """ % (pipe_id, endCursor if endCursor else "") response = requests.post(pipefy_url, json={'query': query}, headers=pipefy_headers) if response.status_code == 200: dados_resposta = response.json() endCursor = dados_resposta['data']['allCards']['pageInfo']['endCursor'] pagina = dados_resposta['data']['allCards']['pageInfo']['hasNextPage'] if pagina == False: break time.sleep(0.5) else: print(f"Erro na requisição: {response.status_code}, {response.text}") Right now, it returns data from 2313 cards. However, I noticed some records are not being retrieved by this request (the pipe has a total of 2363 cards). Does anyone know

50
miguel-rodolpho
rafaelbueno-evidenzit
rafaelbueno-evidenzitNew Member
asked in API
Atualizar campo cards_can_be_moved_to_phases via api

Olá! Como atualizar as fases que um card pode ser movido via API?Algo como: mutation {updatePhase(input: {id: "1", cards_can_be_moved_to_phases: [{id:"2", name:"Perdido"}, {id:"3", name:"Apresentação"}]}) { phase { name } }} Obrigado

40
rafaelbueno-evidenzit
renan-tanzillo-demendes
renan-tanzillo-demendesNew Member
asked in Customs Apps & Integrations
DataBase em lote

Preciso subir uma carga de dados em um database do pipefy. Basicamente criei um database para centros de custo e já tenho 200 aqui do meu ERP. Preciso subir esses dados no Pipefy de alguma forma no code. Vocês sabem como?

221
T
cynthia5
cynthia5New Member
asked in Customs Apps & Integrations
Combining

At times some of our current customers will fill out our web form. In doing so it creates a duplicate in our “contacts database” and my question is is there anyway to combine contacts so we do not have multiple copies of the same information? Thank you.

543
T
andrey-aires-voiicr
andrey-aires-voiicrNew Member
asked in Customs Apps & Integrations
Missing Fields at Make.com

Hello! About Make.com integration. There are some special fields like CNPJ (BR Tax Number) and Phone Number that are not loaded in Make.com. How can I fill in these fields without changing the field type?

1104
T
carlos-silva-intlmkt
carlos-silva-intlmktNew Member
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.

431
T
m-rosa1
m-rosa1New Member
asked in API
Como posso realizar o download de um anexo em um card no pipefy?

Estou usando uma integração para realizar o download de anexos de um card quando ele chegar em uma determinada fase, estou usando a automação do próprio pipe para enviar a URL do arquivo para a minha API via requisição HTTP, porem quando eu recebo o link do arquivo para realizar o download passo para uma chamada de API usando o GET, mas sempre da o erro 401 de não autorizado, tentei passar o token no header mas está indicando a mesma coisa, testei usando o próprio python e uma automação no power automate, ambas indicando a mesma coisa, mas quando pego essa URL e adiciono no navegador o download é realizado com sucesso, existe algum tratamento a mais que preciso realizar para conseguir realizar o download do anexo?

221
marcelo.shiba
Pipefy Staff
michel-dimelnet
michel-dimelnetNew Member
asked in API
Extração de Relatórios da Empresa

mutation { exportPipeReport(input: {pipeId: 301163145, pipeReportId: 300241456}) { pipeReportExport { id } }} Hoje via API GraphQL é possível exrair relatórios de pipes via exportPipeReport, porém necessito extrair um relatório da empresa que não fica dentro de nenhum pipe, fica somente na organização, mas está rota exige o preeenhcimento do pipeId. Como posso fazer para extrair este relatório? Ou teria uma previsão para está funcionalidade?

380
michel-dimelnet
D
david56New Member
asked in Customs Apps & Integrations
Issue with Header/Footer Display – Need Help!

Hi everyone,I’m currently facing an issue where my website's header and footer are not displaying correctly. I’ve tried multiple troubleshooting methods but still can’t figure out what's causing it. Has anyone experienced something similar? If so, please let me know how you resolved it! It would be really helpful if someone could Check Out my site and provide any suggestions. I’m stuck and could really use the assistance! Thanks in advance!

1624
I
miguel-rodolpho
miguel-rodolphoNew Member
asked in API
Error when moving a card to another phase

Hi everyone! I am currently using python to move a card to a certain phase in my pipe, using the following code: payload = { "query": f""" mutation {{ moveCardToPhase (input: {{ card_id: "1085486680", destination_phase_id: "329687449" }}) {{ card {{ id current_phase {{ name }} }} }} }} """ } response = requests.request("POST", pipefy_url, json=payload, headers=pipefy_headers) print(response.text) However, right now response.text gives me the following error: {"data":{"moveCardToPhase":null},"errors":[{"message":"Card could not be moved to phase id: 329687449","locations":[{"line":3,"column":29}],"path":["moveCardToPhase"]}]} Has anyone encountered this issue before? Thanks in advance!

241
V
mark-theotcentre
mark-theotcentreNew Participant
asked in API
Pipefy API - Immutable Object Identifiers

Can someone tell me, categorically, which identifier(s) are immutable for each Pipefy Object; Pipe Phase Card Field When discussing “Fields”, my understanding is that “field_id” or “id” is reliably immutable. However, there are other identifiers “internal_id”, “index” and “uuid” each of which would suggest they too could be immutable. Thanks for any help Mark

884
mark-theotcentre
ingrid-nunes
ingrid-nunesNew Member
asked in Customs Apps & Integrations
Melhoria na Exibição de Status de Cards na Aba Tarefas e Solicitações

Olá, equipe Pipefy, Gostaríamos de sugerir uma melhoria na exibição do status dos cards na aba Tarefas e Solicitações. Antes de uma atualização recente, a plataforma refletia corretamente o status atual do card no pipe, mostrando a fase em que o card se encontrava no momento. No entanto, após essa atualização, o sistema passou a exibir o status conforme a fase em que o card foi originalmente enviado, o que tem causado confusão para os solicitantes, que agora veem um status desatualizado, que não corresponde mais ao estágio real do processo. Para melhorar a experiência dos usuários e evitar mal-entendidos, sugerimos que o status exibido na aba Tarefas e Solicitações seja sempre atualizado para refletir a fase atual do card dentro do pipe, assim como acontecia antes da atualização. Acreditamos que essa mudança ajudaria a proporcionar uma navegação mais clara e precisa para os usuários. Sabemos que ajustes podem levar algum tempo, mas gostaríamos de reforçar que essa funcionalidade era um

381
Leonardo Lucena
Pipefy Staff

Community Experts Leaderboard

Popular tags

Terms & ConditionsCookie settings

Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings