Skip to main content

- - Knowledge base
Products Updates
Ideas
Events

Home
Community overview
Pipefy Developers
API

API

Pipefy API

147 Topics
514 Replies

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

147 Topics

Newest first

Recently active Most replies Most views

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.

API query limit

Hello,I've begun some PHP integrations to extract statistics from Pipefy, using this query: $query = <<<GRAPHQL { pipe(id: xxxxxxxxx) { phases { name cards(first: 100) { edges { node { id fields { name value } assignees { name } } } } } } } GRAPHQL; The data is being displayed in a vertical menu format, and it's working wonderfully. However, there's one issue: a specific phase only shows a maximum of 30 records. I understand this is due to an API pagination limitation, but I need a workaround. For instance, if we have 100 cards in one phase, how can I retrieve all of them? How do

Lucas DemochPipefy Legend

Number of Columns via API

Is there any limitation on returning columns via the API?I didn't find anything about it in the API documentation, but when querying a table with many columns (+100), some columns are not appearing in the query.https://api-docs.pipefy.com/reference/queries/table_records/#table_records

antonio-nykaelBrainy

Problema de integração entre Pipefy e Make

Olá,Pessoal, estou passando por algumas dificuldades, que começaram a ocorrer a cerda de 2h atrás. Tentei achar uma solução, mas sigo sem sucesso.Recebi vários emails de erro das automações do make. Tem alguns módulos do pipefy que não estão funcionando, dentro o (Get a Card Info). Mesmo crianco um Cenário novo, colocando somente 1 módulo, e insrindo o ID de um card, ele retorna com esse erro:Alguém já passou por isso? Alguma ideia de como resolver?Alguns webhook também estão com erro, como Watch Done Cards.

Gabriel CandidoNew Participant

Integrate specific Pipefy reports data into Power BI

Hello,I would like to know if there's a way to integrate specific Pipefy report data into Power BI using M language of Power Query.In the API reference, there are options for Report Query and Export Report. However, the Report Query only returns the report properties (ID, name, field names), and the Export Query generates a URL to download the report ( Would I still need to continue to upload it manually? )

daniel-rodrigues-toolzzNew Member

Listar cards etiquetados com uma label específica

Atualmente é possível listar cards etiquetados com uma label específica?Consigo usar a seguinte request para listar todos os cards cujo campo_X (exemplo: um campo do tipo short text) possui o valor_Y:query MyQuery { findCards(pipeId: "302926544", search: {fieldId: "campo_X", fieldValue: "valor_Y"}) { edges { node { id } } } } Existe alguma request semelhante que utilize o campo “labels” ?

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,

Christian NunesRegular Participant

Apollo Database Graphql Search

Hello, I’m look for a solution similar to the query findCard bellow, but to get IDs from records in apollo databases. Is there a way to get the ID passing as parameters like fields and fields values? query GetCardIdByFieldValue($pipeId: ID!, $fieldId: String!, $fieldValue: String!) { findCards( pipeId: $pipeId search: { fieldId: $fieldId, fieldValue: $fieldValue } ) { edges { node { id } } } }

pferrariogNew Member

What done means in a table record?

I’m trying to clean a database with only active records from a third-party source. I’m concerned about what deleting records could make to old cards in pipes.So, i’m searching a way to set a record as “inactive” and found here TableRecord - Pipefy GraphQL API, an option “done” but i don’t know what this do to the record.Someone can explain, please?

antonio-nykaelBrainy

Limite em uma query com filtro

Olá, Estou fazendo uma automação e eu preciso, que me retorne todos os cards de um pipe, que foram atualizados nos últimos X tempo.Eu achei uma query que me atende muito bem:query allCardUpdatedYesterday { allCards(first: 20, pipeId: 123,filter: { field: "updated_at", operator: gt, value: "2018-08-01T23:50:11-03:00"}) { edges { node { id title } } } }Porém, descobri que ela tem um limite. Ela retorna um máximo de 50 resultados. Mas se nesse meio tempo, entre uma execução e outra, se mais que 50 cards furam atualizados, alguns serão perdidos no processo. Eu sei que o módulo LIST CARDS, não tem esse limite. Pelo menos, ja fiz com mais de 2000 resultados. Há alguma forma de remover esse limite? Agradeço quem souber. Obrigado.

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

marcosmeloPipefy Legend

Erro API Pipefy x Make

Olá, pessoalEstou tentando conectar o make ao pipefy, mas recebo essa mensagem de erro no Make ao inserir a API KEYwrite EPROTO 139810707130304:error:14094410:SSL routines:ssl3_read_bytes:sslv3 alert handshake failure:../deps/openssl/openssl/ssl/record/rec_layer_s3.c:1565:SSL alert number 40Alguem ja passou por esse erro?

published in API

How to get the sent and received emails of a card via APIF.A.Q.

To get all the emails sent and received from a card, just run the following query:query{ card(id: XXXXX) { title comments { id author_name created_at text } inbox_emails { from fromName subject to cc bcc body sent_via_automation state } }}

published in API

How do I update the record status field via API?F.A.Q.

To update the status of a record via API, just follow the steps below.👉🏼First you need to know the Status ID. The following query will give you this information:{ table(id: "XXXXXXXXXX") { statuses { name id } }} 👉🏼Next, you will use the Status ID obtained to update the field of a record by executing the following mutation:mutation { updateTableRecord(input: {statusId: XXXXX, id: XXXXXXXX}) { table_record { title status { name } } }}⚠To find out the record's ID, simply access the database and when you open the record identify the final number that appears in the browser's address bar. Or via API by running the query below:{ table_records(table_id: "XXXXXXXXX") { edges { cursor node { id title } } pageInfo { endCursor hasNextPage hasPreviousPage startCursor } }}

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

alejandroparraNew Member

updateCardField dont work

Hi, im trying tu create a card relation mutation {createCardRelation(input: {parentId : 8050[my card parent id],childId : 6552[mi card child id],sourceType : "PipeRelation",sourceId : "some[i donr not what put here!]"}) {clientMutationId}}If i setup the sourceId as my organization id then i get “"Validation failed: Source Source PipeRelation is not connected to repo”

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"

felipe-leite-matrixenergiaRegular Participant

Eu consigo atualizar mais de um campo em só uma requisição GrathQL?

Atualmente estou utilizando a seguinte estrutura para atualizar um card, porem como são muitas requisições em tão pouco tempo estou tendo problemas com o tempo de resposta da api, existiria algum modo de juntar todas elas? payloads = [ {'field_id': 'tipo_de_pessoa', 'value': info_cliente['Tipo Pessoa']}, {'field_id': 'cpf', 'value': info_cliente['CPF Representante']}, {'field_id': 'cnpj', 'value': info_cliente['CNPJ']}, {'field_id': 'nome_da_empresa', 'value': info_cliente['Nome']}, {'field_id': 'nome_do_contato', 'value': info_cliente['Nome']}, {'field_id': '1_n_telefone_do_contato', 'value': info_cliente['Telefone']}, {'field_id': 'e_mail_do_contato', 'value': info_cliente['Email']}, {'field_id': 'valor_da_fatura_r', 'value': info_cliente['Valor Conta']}, {'field_id': 'm_dia_de_consumo_kwh', 'value': info_cliente['Consumo Medio']}, {'field_id': 'soma_do_consumo_kwh', 'value':

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

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

renan-araujo-creditasRegular Participant

Como criar uma Query para retornar os dados "FirstTime Enter" e "LastTime Exit" de um card em uma fase

Gostaria de construir uma API que retornasse para mim o "LastTime Exit” e o "FirtTime Enter” de um card em uma fase ID XAlguém tem a ideia de uma query?

caio-pagliaraniNew Participant

Update title of a card

I’m trying to update a title of a card without changing the field linked to that. for example. in this pipe, the title field is the “ applicant's name “. but later in the process, we want to change the title to the applicant’s company name, instead of the applicant's name , and i cannot simply delete the applicant's name and put the company name that i want, because i would lose that information The mutation that i am using is:“mutation{ updateFieldsValues(input: { clientMutationId: "test" nodeId:"card id", values:[{ fieldId: "title" value: "New title" }] }) { clientMutationId }}”the return is:“{ "data": { "updateFieldsValues": { "clientMutationId": "teste" } }}”But the card remain with the origin title, without chance.

1
2
3
4
5
6

Page 2 / 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