Skip to main content

- - Knowledge base
Products Updates
Ideas
Events

Home
Community overview
Pipefy Developers
API

API

Pipefy API

148 Topics
516 Replies

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

148 Topics

Recently active

Most replies Most views Newest first

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

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

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!

moraesgNew Member

How to retrieve value from Due Date

When I retrieve a query from a specific card, it doesn’t return this field: and I can’t seem to find where it is stored and connected to the card.How would I get this value?

ivonascimentoNew Member

API - Pipe/Table Relation

I look for a way to list the connections between a Pipe and a table.It is easy to query for card/record connections but I find no way to have this information from the pipe/table.For instance, I have this pipe “pipe 1” with a start form with a field “Customer Name” connected to the table “Customer”.query{ pipe(id:304611228){ start_form_fields{ id type connectedRepo{ __typename } } }}In this response I know it is a connector field connected with a PublicTable and I look for a way to know the tableName and Table Field name.the response is as follow.{ "data": { "pipe": { "start_form_fields": [ { "id": "customer_name", "type": "connector", "connectedRepo": { "__typename": "PublicTable" } } ] } }}

marianamayermadeiraNew Member

Query all cards and all comments

I’m looking for a way to query all the cards and their comments (with created date and authors) of a pipe. If possible, in Python.Is there any way to do it?

diretoria101New Member

DROPDOWN FIELD MUTATION OPTIONS UPDATE

DROPDOWN FIELD MUTATION OPTIONS UPDATE Hello! I need to update the options of dropdown field using Graphql, but so far I was not able to create a mutation to do so. Anyone can help?

enrique.herbellaNew Member

Syntax error when doing createCard using GuzzleHttp

Hello,Could you please assist me understanding why I am getting a 400 Bad Request response when trying to use createCard using graphql?Ex: $client = new \GuzzleHttp\Client();$response = $client->request('POST', 'https://api.pipefy.com/graphql', [ 'body' => '{"query":"mutation { createCard( input: { pipe_id: '.$pipe_id.', phase_id: '.$phase_id.', title: "LOREM IPSUM", fields_attributes: [ { field_id: "title", field_value: "LOREM IPSUM1" }, { field_id: "email", field_value: "my-email@email.com" } ] }) { clientMutationId card { id title } } } ', 'headers' => $headers,]);Thanks!

produtos7New Member

Como limpar a data de vencimento do card via API, por exemplo eu consigo atribuir o valor do due_date, porem e em casos onde eu preciso remover o valor deste campo e deixar em branco como q é feito via api, tentei deixar em branco mas fica dando erro informando que o campo é de date que precisa d um valor

Gabriel CandidoNew Participant

Atualizar campos específicos da Database

Gostaria de saber como faço para atualizar campos específicos de uma Database. Tentei seguir o mesmo caminho de adicionar um registro mas não deu certo.

edgar-silva-brNew Member

ow to Get Conditional Information for a Field in Pipefy?

Hey everyone,I'm currently working on a project using Pipefy and I need some guidance on how to retrieve conditional information associated with a field using the Pipefy API. Specifically, I'm looking to understand how to:Retrieve conditional rules or expressions set for a particular field. Determine if a field has any conditions attached to it programmatically. Access details such as when these conditions trigger or how they affect field behavior.I've explored the Pipefy API documentation but couldn’t find a direct method to query this information. If anyone has experience or insights into how this can be achieved, I would greatly appreciate your advice or pointers.Thank you in advance for your help!

LuísaNew Member

Condicional para criador de Card

Estimado Time, Estou em busca de como criar uma condicional de campo para criador no formulário inicial. Essa opção existe para criação, mas não funciona para formulário inicial. No meu caso, tenho um formulário inicial que é preenchido entre os campos nome e contato do cliente. Essas informações são salvas em uma Database, de forma que ao criar outro card para o mesmo cliente, basta buscá-lo pela conexão. No entanto, o mesmo formulário é preenchido por uma empresa parceira com o link do formulário, e não podemos deixar aberto para essa empresa as informações do cliente. Logo, tento colocar uma condicional de campo para o criador, como anexo da imagem.

Maurício Rocha - PibernatNew Member

Passar mais de um campo no método updatePhaseField

Boa tarde pessoal, É possível passar mais de um campo para atualização por chamada usando o método updatePhaseField?Ex: Tenho campos obrigatórios que possuem regras de exibição em tela, então alguns campos estão ocultos em determinados momentos. Porém, ao tentar criar um card pela API, todos os campos obrigatórios são necessários.A ideia seria fazer com que os campos deixassem de ser obrigatórios antes da chamada, e depois de criar o card, voltar para obrigatório.

gabriel-ferronatoNew Member

Gerar link da fase atual do card usando API

Recentemente tentei utilizar a mutação configurePublicPhaseFormLink porém todas as informações e direcionamentos para ela foram removidas até mesmo da documentação. Em meu caso, estou montando uma mensagem para direcionar para o Slack e o objetivo era integrar um botão direcionado para a tarefa do card, assim a pessoa em questão iria apenas responder a fase em questão com o card atrelado. O que me intriga é que consigo gerar o link da tarefa de forma fácil por um campo dinâmico no formulário e também enviar por e-mail mas não consigo de forma alguma copiar essa informação ou direcionar ela via HTTP em uma mensagem POST para o Slack já que não dá para se referir aos campos dinâmicos. Tentei achar maiores informações mas a página que sempre referenciam não carrega, não tem nada na documentação e as únicas informações que encontrei acerca foram da própria IA que me recomendou usar essa mutação e de um link mostrando o roadmap do produto

contact-r2gNew Member

How to register lead source in his card?

I’m creating a CRM Pipe and it is so important to have the lead source. I was thinking to get the information from URL parameters, since all my campaigns URL has parameters.Anyone know how to solve this problem? The HTTP automation can help with that?

Maria coronelNew Member

Sequencial Card ID

I want to know how can I create a sequencial Card ID using the http request, for exameple when I create a card start with 1, the next card start with ID 2 and so go on.

1
2
3
4
...
6

Page 1 / 6

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