Before You Begin
🔗 Use the GraphQL Playground to execute the queries in this guide.
➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.
Prerequisites
- Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
- Permissions: Ensure your token has the necessary permissions.
Here are examples of how to get IDs for multiple pipefy resources through graphql. Every example will have a query and an example response.
Organization ID
{
organizations {
name
id
}
}
Example Response:
{
"data": {
"organizations": [
{
"id": "2",
"name": "AlphaCorp"
},
{
"id": "3",
"name": "GammaInc"
},
{
"id": "4",
"name": "BetaWorks"
}
]
}
}
Pipe ID
You’ll need the Organization ID for this query.
{
organization(id: 3) {
pipes {
id
name
}
}
}
Example Response:
{
"data": {
"organization": {
"pipes": [
{
"id": "15",
"name": "Alpha Team"
},
{
"id": "16",
"name": "Beta Team"
},
{
"id": "17",
"name": "Gamma Team"
},
{
"id": "21",
"name": "Delta Team"
}
]
}
}
}
Table ID
You’ll need the Organization ID for this query.
{
organization(id: 2) {
tables {
edges {
node {
id
name
uuid
}
}
}
}
}
Example Response:
{
"data": {
"organization": {
"tables": {
"edges": [
{
"node": {
"id": "T0cZ0fUi",
"name": "People Team",
"uuid": "06573aec-0cf0-4231-8328-2903280e208e"
}
}
]
}
}
}
}
Phase ID
You’ll need the Pipe ID for this query.
{
pipe(id: 16) {
phases {
id
name
}
}
}
Example Response:
{
"data": {
"pipe": {
"phases": [
{
"id": "294",
"name": "1 Pending Review"
},
{
"id": "295",
"name": "2 In Progress"
},
{
"id": "296",
"name": "3 Completed"
},
{
"id": "297",
"name": "4 Cancelled"
}
]
}
}
}
Start Form Phase ID
You’ll need the Pipe ID for this query.
{
pipe(id: 24) {
startFormPhaseId
}
}
Example Response:
{
"data": {
"pipe": {
"startFormPhaseId": "123"
}
}
}
Start Form Field IDs
You’ll need the Pipe ID for this query.
{
pipe(id: 16) {
start_form_fields {
id
label
}
}
}
Example Response:
{
"data": {
"pipe": {
"start_form_fields": [
{
"id": "name",
"label": "Name"
},
{
"id": "email",
"label": "Email"
},
{
"id": "additional_id",
"label": "Additional ID"
}
]
}
}
}
Phase Fields IDs
You’ll need the Phase ID for this query.
{
phase(id: 294) {
fields {
id
label
}
}
}
Example Response:
{
"data": {
"phase": {
"fields": [
{
"id": "reason_for_hold",
"label": "Reason for Hold"
},
{
"id": "assigned_contact",
"label": "Assigned Contact"
}
]
}
}
}
Label IDs
You’ll need the Pipe ID for this query.
{
pipe(id: 1) {
labels {
id
name
}
}
}
Example Response:
{
"data": {
"pipe": {
"labels": [
{
"id": "8",
"name": "High priority"
},
{
"id": "9",
"name": "Pending Approval"
},
{
"id": "10",
"name": "Blocked"
},
{
"id": "11",
"name": "Awaiting Response"
}
]
}
}
}
Card IDs
You’ll need the Pipe ID for this query. If you have many cards in your pipe, check our Introduction to Pagination to navigate through all the cards.
{
cards(pipe_id: 303001213) {
edges {
node {
id
title
current_phase {
id
name
}
}
}
}
}
Example Response:
{
"data": {
"cards": {
"edges": [
{
"node": {
"id": "123456789",
"title": "Project Alpha",
"current_phase": {
"id": "318551446",
"name": "Doing"
}
}
},
{
"node": {
"id": "234567890",
"title": "Task Beta",
"current_phase": {
"id": "318551446",
"name": "Doing"
}
}
},
{
"node": {
"id": "345678901",
"title": "Initiative Gamma",
"current_phase": {
"id": "318551446",
"name": "Doing"
}
}
},
{
"node": {
"id": "456789012",
"title": "Operation Delta",
"current_phase": {
"id": "318551446",
"name": "Doing"
}
}
},
{
"node": {
"id": "567890123",
"title": "Plan Epsilon",
"current_phase": {
"id": "318551446",
"name": "Doing"
}
}
}
]
}
}
}
Organization Members IDs
You’ll need the Organization ID for this query.
{
organization(id: 2) {
users {
id
name
}
}
}
Example Response:
{
"data": {
"organization": {
"users": [
{
"id": "10",
"name": "Morgan"
},
{
"id": "11",
"name": "Casey"
},
{
"id": "12",
"name": "Riley"
},
{
"id": "13",
"name": "Jamie"
}
]
}
}
}
Card Emails IDs
You’ll need the Card ID for this query.
{
inbox_emails(card_id: 1090621871) {
id
subject
state
}
}
Example Response:
{
"data": {
"card": {
"inbox_emails": [
{
"id": "123456789",
"subject": "Project Kickoff",
"state": "processed"
},
{
"id": "987654321",
"subject": "Weekly Status Update",
"state": "processed"
}
]
}
}
}
Reports IDs
You’ll need the Pipe ID for this query.
{
pipe(id: 123) {
reports {
id
name
}
}
}
Example Response:
{
"data": {
"pipe": {
"reports": [
{
"id": "1",
"name": "Monthly Performance Summary"
},
{
"id": "2",
"name": "Project Progress Tracker"
},
{
"id": "3",
"name": "Team Task Allocation"
}
]
}
}
}