Skip to main content

- - Knowledge base
Pipefy Updates
Ideas
Events
Pipefy Academy

🚀 New on Pipefy Academy: Learning Paths to Grow Your Career!

4 days ago

Home
Community overview
Pipefy Developers
API

API

Pipefy API

175 Topics
567 Replies

When you subscribe we will email you when there is a new topic in this category

175 Topics

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,

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 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

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.

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 {hasNextPageendCursor}edges {node {id}}}}🔹E

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 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"

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 } }}

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) {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.

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 {idtext}}}📍DELETE COMMENTmutation {deleteComment(input:{id: XXXX}) {success}}

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 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 }}

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 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 }

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 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.

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!

Victor CarvalhoNew Member

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?

nphilipsExplorer

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.

ti-ihcNew Member

API POWER AUTOMATE > PIPEFY - UPDATECARDVALUE

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

gustavo_serbenaExplorer

Extrair histórico de atividades

Bom dia pessoal, Alguém já teve a necessidade de extrair o histórico de atividades do card? Se sim, conseguiu resolver essa questão de alguma forma? Via API ou outra forma Estava precisando para ter um relatório de envolvidos nos processos que já foram desligados da organização e não são mais usuários, porém nas atividades do card eu tenho a informação de quem foi responsável e estava envolvido.

miguel-rodolphoExplorer

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},

erica-ongaroNew Member

Enacaminhar e-mails de um card.

Estou tentando de todas maneiras enviar os e-mails de um card para um destinatario espeifico, mas nada funciona, de forma automatizada via API. Alguma sugestão?

brennovnInspiring

Due Date (Data de vencimento) | Automation | Webhook / Card Overdue

Qual o sentido de existir o Field Type Due Date se eu não consigo ter um gatilho para todos os campos que eu criar desse tipo?Quando eu tenho mais de 1 campo do tipo Due Date, o Fixed Field Due Date sempre fica com o vencimento mais longo por padrão. Se eu deixo o Due Date vazio, apesar de todos os campos Due Date estarem preenchidos, nenhum gatilho é disparado, nem pelo Automation e nem pelo Webhook.Do meu ponto de vista, parece não existir nenhuma diferença significativa entre o campo Due Date e Datetime.

rafaelbueno-evidenzitNew Member

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

gbenassiExplorer

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": {

m-rosa1Explorer

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?

michel-dimelnetInspiring

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?

miguel-rodolphoExplorer

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},"er

mark-theotcentreInspiring

Pipefy API - Immutable Object Identifiers

Can someone tell me, categorically, which identifier(s) are immutable for each Pipefy Object;Pipe Phase Card FieldWhen 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 helpMark

1
2
3
4
...
7

Page 1 / 7

Community Experts Leaderboard

Powered by Gainsight

Terms & Conditions Cookie settings

Sign Up Now!

Already have an account? Login

Login with your Pipefy credentials

or

Username *

Company's email *

Phone Number

Department *

Are you already a Pipefy user?

(Private)

Only you and moderators can see this information

*

Yes Not yet

Job Title *

Company *

Company Size *

Country *

Password *

I accept the terms & conditions

loginBox.register.email_repeat

Join us in the Pipefy Community! 🚀

No account yet? Create an account

Login with your Pipefy credentials

or

Username or Email

Password

Remember me

Forgot password?

Enter your E-mail address. We'll send you an e-mail with instructions to reset your password.

Enter your e-mail address

Back to overview

Scanning file for viruses.

Sorry, we're still checking this file's contents to make sure it's safe to download. Please try again in a few minutes.

OK

This file cannot be downloaded

Sorry, our virus scanner detected that this file isn't safe to download.

OK

Eficiência impulsionada pela IA

Company

Careers

Success stories

Ethics and Compliance

Products

HR Service Delivery

Custom Workflows

Platform

Pricing

Business Solutions

Process Management

Service Management

ITSM

Help & Support

Pipefy Community

Resources

Blog

Guides and E-books

Events and Webinars

Process Improvement 101