Pipefy

App · 20 actions

Manage cards, phases, comments and database records using Pipefy GraphQL.

Actions

ActionWhat it does
Create cardCreates a card in a pipe with a title and optional field values, due date, assignees and labels.
Create commentAdds a text comment to a card by its card ID.
Create table recordCreates a record in a database table with a title and optional field values and due date.
Delete cardDeletes a card from its pipe by its card ID.
Delete commentDeletes a comment from a card by its comment ID.
Delete table recordDeletes a table record by its record ID.
Get cardGets one card by its card ID, including its title, phase, field values, assignees, labels and due date.
Get current userGets the connected Pipefy user's ID, name and email.
Get organizationGets one organization by its ID, including its name and the pipes and tables in it.
Get pipeGets one pipe by its pipe ID, including its phases, fields and labels, which you need to create and move cards.
Get tableGets one database table by its table ID, including its name and fields.
Get table recordGets one table record by its record ID, including its title, field values and due date.
List cardsLists the cards in a pipe by its pipe ID, with each card's ID, title, current phase and due date.
List organizationsLists the Pipefy organizations the connected user belongs to, with each organization's ID and name.
List table recordsLists the records in a database table by its table ID, with each record's ID, title and field values.
Move cardMoves a card to another phase of its pipe, by card ID and phase ID.
Update cardChanges a card's title, due date, assignees or labels, by its card ID.
Update card fieldSets the value of one field on a card, by card ID and field ID.
Update commentReplaces the text of a comment by its comment ID.
Update table recordChanges a table record's title or due date, by its record ID.

Create card

Creates a card in a pipe with a title and optional field values, due date, assignees and labels. Returns the new card's ID.

Inputs

Pipepipe_idtextRequired
Pipe ID.
TitletitletextRequired
Title.
Fieldsfieldsobject
Fields.
Due datedue_datedate and time
Due date.
Assignee IDsassignee_idslist
Assignee IDs.
Label IDslabel_idslist
Label IDs.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "createdAt": "example",
    "current_phase": {
      "id": "example",
      "name": "example"
    },
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}

Create comment

Adds a text comment to a card by its card ID. Returns the new comment's ID.

Inputs

Card IDcard_idtextRequired
Card ID.
TexttexttextRequired
Text.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "id": "example",
    "text": "example"
  }
}

Create table record

Creates a record in a database table with a title and optional field values and due date. Returns the new record's ID.

Inputs

Table IDtable_idtextRequired
Table ID.
TitletitletextRequired
Title.
Fieldsfieldsobject
Fields.
Due datedue_datedate and time
Due date.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "created_at": "example",
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}

Delete card

Deletes a card from its pipe by its card ID. Returns whether it succeeded.

Inputs

Card IDcard_idtextRequired
Card ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "success": false
  }
}

Delete comment

Deletes a comment from a card by its comment ID. Returns whether it succeeded.

Inputs

Comment IDcomment_idtextRequired
Comment ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "success": false
  }
}

Delete table record

Deletes a table record by its record ID. Returns whether it succeeded.

Inputs

Record IDrecord_idtextRequired
Record ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "success": false
  }
}

Get card

Gets one card by its card ID, including its title, phase, field values, assignees, labels and due date.

Inputs

Card IDcard_idtextRequired
Card ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "createdAt": "example",
    "current_phase": {
      "id": "example",
      "name": "example"
    },
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}

Get current user

Gets the connected Pipefy user's ID, name and email.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "email": "example",
    "id": "example",
    "name": "example"
  }
}

Get organization

Gets one organization by its ID, including its name and the pipes and tables in it.

Inputs

Organizationorganization_idtextRequired
Organization ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "id": "example",
    "name": "example",
    "pipes": [],
    "tables": {
      "edges": []
    }
  }
}

Get pipe

Gets one pipe by its pipe ID, including its phases, fields and labels, which you need to create and move cards.

Inputs

Pipepipe_idtextRequired
Pipe ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "id": "example",
    "labels": [],
    "name": "example",
    "phases": [],
    "start_form_fields": [],
    "users": []
  }
}

Get table

Gets one database table by its table ID, including its name and fields.

Inputs

Table IDtable_idtextRequired
Table ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "id": "example",
    "name": "example",
    "table_fields": []
  }
}

Get table record

Gets one table record by its record ID, including its title, field values and due date.

Inputs

Record IDrecord_idtextRequired
Record ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "created_at": "example",
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}

List cards

Lists the cards in a pipe by its pipe ID, with each card's ID, title, current phase and due date. Returns one page; use the paging fields for the next page.

Inputs

Pipepipe_idtextRequired
Pipe ID.
Firstfirstnumber
First.From 1 to 50.
Afteraftertext
After.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "items": [],
    "page_info": {
      "endCursor": "example",
      "hasNextPage": false
    }
  }
}

List organizations

Lists the Pipefy organizations the connected user belongs to, with each organization's ID and name.

Inputs

None.

Outputs

datalist
Response.
Example output
{
  "data": []
}

List table records

Lists the records in a database table by its table ID, with each record's ID, title and field values. Returns one page; use the paging fields for the next page.

Inputs

Table IDtable_idtextRequired
Table ID.
Firstfirstnumber
First.From 1 to 50.
Afteraftertext
After.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "items": [],
    "page_info": {
      "endCursor": "example",
      "hasNextPage": false
    }
  }
}

Move card

Moves a card to another phase of its pipe, by card ID and phase ID.

Inputs

Pipepipe_idtextRequired
The pipe containing this card.
Card IDcard_idtextRequired
Card ID.
Phasephase_idtextRequired
Phase ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "createdAt": "example",
    "current_phase": {
      "id": "example",
      "name": "example"
    },
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}

Update card

Changes a card's title, due date, assignees or labels, by its card ID.

Inputs

Card IDcard_idtextRequired
Card ID.
Titletitletext
Title.
Due datedue_datedate and time
Due date.
Assignee IDsassignee_idslist
Assignee IDs.
Label IDslabel_idslist
Label IDs.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "createdAt": "example",
    "current_phase": {
      "id": "example",
      "name": "example"
    },
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}

Update card field

Sets the value of one field on a card, by card ID and field ID.

Inputs

Card IDcard_idtextRequired
Card ID.
Field IDfield_idtextRequired
Field ID.
New valuenew_valuelistRequired
New value.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "createdAt": "example",
    "current_phase": {
      "id": "example",
      "name": "example"
    },
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}

Update comment

Replaces the text of a comment by its comment ID.

Inputs

Comment IDcomment_idtextRequired
Comment ID.
TexttexttextRequired
Text.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "id": "example",
    "text": "example"
  }
}

Update table record

Changes a table record's title or due date, by its record ID.

Inputs

Record IDrecord_idtextRequired
Record ID.
Titletitletext
Title.
Due datedue_datedate and time
Due date.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "created_at": "example",
    "id": "example",
    "title": "example",
    "updated_at": "example",
    "url": "example"
  }
}

On this page