API

Pipefy API

  • 99 Topics
  • 314 Replies

99 Topics

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

5562
Marcos Carvalho
Pipefy Staff
1 year ago
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!  

2780
Marcos Carvalho
Pipefy Staff
1 year ago
renan-araujo-creditas
renan-araujo-creditasRegular Participant
asked in API

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?

5
natalia-manffre
Pipefy Staff
1 day ago
caio-pagliarani
caio-pagliaraniNew Participant
asked in API

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
lucas-lacerda-pipefy
Pipefy Staff
2 days ago
yeiser-mirabal
yeiser-mirabalRegular Participant
asked in API

Querying Cards from the Last Year Sorted by Update Date via API

Hey there!, I am reaching out to inquire about fetching data using the Pipefy API. Specifically, I'd like to retrieve all cards from the last year and have them sorted by their update date.Is there a specific GraphQL query that would allow me to accomplish this? I'm looking for a way to obtain this dataset for analysis and reporting purposes.Any guidance or example queries you could provide would be greatly appreciated!

4
genietim
8 days ago
yeiser-mirabal
yeiser-mirabalRegular Participant
asked in API

Tracking Assignee History for Each Phase in a Process

Hello Pipefy Community,In my workflow, it's essential that every phase has an assigned user. I'm looking to retrieve the history of assignees for each phase a card has passed through.I've tried using the following GraphQL query:{ cards(pipe_id: "CARD_ID") { nodes { phases_history { phase { name cards { nodes { assignees { email } } } } } } }} However, this only gives me the history of phases without the respective assignees. How can I modify this query or use another approach to retrieve the assignee history for each phase?Thank you for your assistance!

4
yeiser-mirabal
9 days ago
juliana-opis
juliana-opisNew Participant
asked in API

Contagem de chamadas API

  Bom dia! Criei um código que faz chamadas na API do pipefy e busca todos os cards de um determinado pipe.No total eu tenho um pouco mais de 1000 cards nesse pipe, pela lógica, sendo 50 registros por página, seriam aproximadamente 20 chamadas na API. Acredito que as chamadas não estão sendo contabilizadas corretamente, já que no último mês nosso consumo passou de 100k. No dia 01/09 o consumo estava em 2k, sendo que não havia feito nenhuma chamada. Existe alguma maneira de contabilizar as chamadas por aqui? Quero saber porque esse consumo está tão alto.Segue trecho do código que faz as chamadas: def get_all_cards(pipe_id, page_size): all_cards = [] after = None has_next_page = True while has_next_page: query = ''' query GetCards($pipeId: ID!, $pageSize: Int!, $after: String) { cards(pipe_id: $pipeId, first: $pageSize, after: $after) { edges { node { id fields { date_value date

1
Lais Laudari
Community Manager
19 days ago
ramongb
ramongbRegular Participant
asked in API

GraphQL: How to clear a connection field value

Hi there! Im trying to get a card and clear the value of a field using GraphQL. The field is not string or number, it is a pipe connector. I’m not trying to delete the relation field, just clearing it out. I’m trying the following:mutation { updateFieldsValues(input: {nodeId: "{cardId}", values: {fieldId: "{name}", value: [] }}) { clientMutationId } } I have tryed usin “” or [“”] in the value but I got always an error sayin is an invalid input.Have anyone did this before?

5
Ezequiel Souza
24 days ago
antonio-nykael
antonio-nykaelInspiring
asked in API

Como fazer upload de arquivo para um card via API (make)?

Olá,Como fazer, via integração (make), pra criar um card e anexar arquivos nesse card? Estou tentando várias formas, mas ainda sem sucesso. 

10
arthurlins
25 days ago
Daniel Angelini Serviços
Daniel Angelini ServiçosRegular Participant
asked in API

Criação de card via api com conexão de database

Olá.Estou tentando criar um card em um pipe, via API, sendo que o form inicial só tem um campo que é uma conexão com um database. A idéia é criar um card para cada linha do database, conforme uma determinada condição.No postman estou usando a seguinte mutation query:mutation {  createCard(input: {    pipe_id: 303443432,    title: "teste api",    fields_attributes:      {field_id: "estagi_rio", field_value: {          table_records:{              edges:{                  node:{                      id: "746422898",                        title: "Julia Cazarim"                        }                  }              }          }      },    }  ) {    card {      title    }  }} O payload que retorna é: "data": {        "createCard": null    },    "errors": [        {            "message": "Invalid input: estagi_rio ([{\"table_records\"=>{\"edges\"=>{\"node\"=>{\"id\"=>\"746422898\", \"title\"=>\"Julia Cazarim\"}}}}])",            "locations": [                {             

1
Daniel Angelini Serviços
1 month ago
Daniel Angelini Serviços
Daniel Angelini ServiçosRegular Participant
asked in API

Delete multiple cards by GraphQL mutation

Hey there, anyone knows how to delete multiple cards, by their Id, with graphQL mutation? I tried this:mutation {  deleteCard(input: {id: [751517290,751517292,751517294,751517296,751517297,751517299,751517300,751517305,751517318,751517343,751517344,751517345,751517346,751517347,751517348,751517349,751517352,751517353,751517355,751517356,751517358,751517360,751517361,751517363,751517364,751517366,751517367,751517368]}) {    success  }}and received this:{    "errors": [        {            "message": "Argument 'id' on InputObject 'DeleteCardInput' has an invalid value ([751517290, 751517292, 751517294, 751517296, 751517297, 751517299, 751517300, 751517305, 751517318, 751517343, 751517344, 751517345, 751517346, 751517347, 751517348, 751517349, 751517352, 751517353, 751517355, 751517356, 751517358, 751517360, 751517361, 751517363, 751517364, 751517366, 751517367, 751517368]). Expected type 'ID!'.",            "locations": [                {                    "line": 3,                    

1
genietim
1 month ago
P
pferrariogRegular Participant
asked in API

Error while creating card via API

I’m trying to create a card via API in a pipe that has many required fields in the form. I already tried a lot of things, mapped all the ids and the formats i should build the payload. Even with the connector’s fields, that i’m using the record id to send the value that i want. But, i still get an error and i can’t figure out what it says to me or what should i change. My query looks like:mutation MyQuery {  createCard(    input: {pipe_id: "12345678", fields_attributes: [                 {field_id: “xxxxx”, field_value: “yyyy”},                  {field_id: “xxxxx”, field_value: “yyyy”}              ]           }        )   {    clientMutationId  }}  And the error: {  "data": {    "createCard": null  },  "errors": [    {      "message": "Something went wrong",      "locations": [        {          "line": 2,          "column": 3        }      ],      "path": [        "createCard"      ]    }  ]}  Pls, i need help on this

2
P
2 months ago
Paulo Rodrigues
Paulo RodriguesRegular Participant
asked in API

Is the docs about api usage limits updated?

Hi, or I’m missing something or the docs about api usage limits are outdated, let me explain.I’m on the starter (free) plan while evaluating the usage of Pipefy for my business and the integration (api) part of this is crucial for us.On the free tier I already did much more than 20 api call in a month as mention on this doc as a limit.https://help.pipefy.com/en/articles/5580799-how-to-use-pipefy-s-api#h_a506831afcIs this right?As on the below link there is no way to check programmatically how is my monthly usage (this is bad, very bad)Any Pipefy master could clarify this for me?Thank you!

1
leonardo-lucena-pipefy
Pipefy Staff
2 months ago
Juliana Spinardi
Community Manager
Juliana SpinardiCommunity Manager
published in API

New GraphQL update: Retrieve Card attachments

We added support to retrieve card attachments -- we will return both attachments attached through the card and by the fields of type attachment. We added a new type called Attachment and we also added the attachments attribute inside the Card type.Sample query: Changelogadded: Attachment type added: attachments  attribute inside the Card type

3176
genietim
2 months ago
Paulo Rodrigues
Paulo RodriguesRegular Participant
asked in API

Send e-mail as reply using API

Hello!Can I send an email via API as a reply to the previously received e-mail?For example, I´d receive and email from client@exemple.com with the subject "Need your help" and tried to reply using the api as follow: mutation { createInboxEmail( input: { repo_id: [pipe_id] card_id: [card_id] subject: "Re: Need your help", from: "pipe[pipe_id]+[card_id]@mail.pipefy.com" to: "[address I'd received the email from]", html: "<b>just a reply test</b>", } ) { inbox_email { id, state } }} But at least on my Gmail I receive the answer in a new thread not as a reply on the previous one.Any idea? Thanks!

3
genietim
2 months ago
vitor221
vitor221Inspiring
asked in API

Criar card conectado via API

Atualmente no pipefy possuimos a possibilidade de criar um card conectado por meio de um campo de conexão com outro pipe e via automação, minha dúvida é: seria possível criar um card conectado (card filho) via API?

1
Lais Laudari
Community Manager
2 months ago
sistemas-orbita
sistemas-orbitaRegular Participant
asked in API

Limitação da api

Estou com uma dúvida, é possível fazer paginação ao puxar os pipes pela api ?

1
leandro-almeida
Pipefy Staff
2 months ago
daniel-rodrigues-toolzz
daniel-rodrigues-toolzzNew Participant
asked in API

Is it possible to crate a card with more than one label?

Is it possible to crate a card with more than one label? The bellow request works only for the first tag “309139499”  mutation {  createCard(input:{    pipe_id: 303361474    phase_id: 320602338    title: "title of card" label_ids: 309139499label_ids: 309139539  }){

1
Lais Laudari
Community Manager
3 months ago
andre-infineat
andre-infineatRegular Participant
asked in API

Not possible to retrieve cards from a specific pipe with its start_form_fields

I'm trying to use the api to fetch all cards from a specific pipe and read through a few of start_form_fields from each of those cards. But I have not found any way to retrieve start_form_fields...

3
leandro-almeida
Pipefy Staff
3 months ago
C
cbezerra-orbitaNew Participant
asked in API

Extract moved event from the card

Hello,Please, could someone tell me if the Pipefy API can extract moved event data from a card and get the current phase?Example:The user moved from Phase 1 to Phase 2;The user moved from  Phase 2 to Phase 3I need to have the life of the card and current phase, entrances and exits of the phases in an accumulative way.Example:The user moved from Phase 2 to Phase 3 at 21:00The user moved from Phase 3 to Phase 2(again); 21:30And so on ...

1
natalia-manffre
Pipefy Staff
3 months ago
mark-theotcentre
mark-theotcentreInspiring
asked in API

Dynamically populate permissible values for a Card or Phase drop-down field via API

We have a field on an external system which is a drop-down, for example;UK Counties:AvonCarmarthenshireetcWe want to ensure that the same field on a Pipefy Card has the same drop-down value list whenever the Card enters the Phase which has the County field.Does the Pipefy API allow us to dynamically create the drop-down options for a “dropdown select” field. We can’t work that out from the API documentation, sorry!Thanks

3
Lucas Democh
4 months ago
mark-theotcentre
mark-theotcentreInspiring
asked in API

Field Update Webhook API and Pipefy Public Start Form

Can someone clarify for sure whether the Field Update Webhook is triggered when a field on the Start Form is updated.We are using Pipefy APIs and are finding that the Field Update Webhook *is* triggered when a field is updated on a Phase Form but does not trigger when a field is updated on a Public Start Form.I’m getting conflicting information on this!Thanks

4
Lucas Democh
4 months ago
enrique.herbella
enrique.herbellaParticipating Frequently
asked in API

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!

12
enrique.herbella
4 months ago
joel-santos-crediallsolucoes
joel-santos-crediallsolucoesRegular Participant
asked in API

Selecionar apenas os campos necessários

Bom dia. Estou trabalhando com ‘cards’ que possuem muitos campos (+30)  e na API não retorna todos os campos do ‘card’. Gostaria de saber como faço para recuperar todos os campos ou selecionar apenas os necessários?Consulta utilizada:query MyQuery {    allCards(pipeId: ####) {        edges {            node {                fields {                    field {                        id                    }                    name                    value                }                id                title            }        }        pageInfo {            endCursor            hasNextPage            hasPreviousPage            startCursor        }    }}

3
felipealves
Pipefy Staff
4 months ago
karoline-impulseodonto
karoline-impulseodontoNew Participant
asked in API

How can I retrieve a StatementField phasefield value

I've found that answer about retrieving phase field values: Unfortunately, it seems that StatementFields are not included in the in the normal fields list of a card. How can I retrieve the value of a StatementField?

3
Lucas Democh
4 months ago

Community Experts Leaderboard

Terms & ConditionsCookie settings