Back

Queries Overview

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

Connections

allCards

Fetches all pipe cards based on arguments

Query : Return Object
allCards: CardConnection
Argument : ObjectDescription
first: Int Returns the first _n_ elements from the list.
after: String Returns the elements in the list that come after the specified global ID.
last: Int Returns the last _n_ elements from the list.
before: String Returns the elements in the list that come before the specified global ID.
pipeId: ID!Required. The pipe ID
filter: AdvancedSearch Search filter
autoFillFields

Lookup the values that will automatically fill the child-card's start form fields

Query : Return Object
autoFillFields: [AutoFillFieldUnion]
Argument : ObjectDescription
parentCardId: ID!Required.
connectorId: ID!Required.
connectorType: String!Required.
card

Lookup a card by its ID

Query : Return Object
card: Card
Argument : ObjectDescription
id: ID!Required. The card ID
cards

Fetches a group of cards based on arguments

Query : Return Object
cards: CardConnection
Argument : ObjectDescription
first: Int Returns the first _n_ elements from the list.
after: String Returns the elements in the list that come after the specified global ID.
last: Int Returns the last _n_ elements from the list.
before: String Returns the elements in the list that come before the specified global ID.
pipe_id: ID!Required. The pipe ID
search: CardSearch Arguments that can be used to filter the search
cardsImportations

Lookup the cards importer history by the pipe ID

Query : Return Object
cardsImportations: [CardsImportation]
Argument : ObjectDescription
pipeId: ID!Required. The pipe ID
status: [String] Filter importation by status, which can be either "enqueued", "importing", "failed" or "imported"
conditionalField

Query : Return Object
conditionalField: ConditionalField
Argument : ObjectDescription
repoId: ID!Required.
cardId: ID
overrideFieldValue: [FilledField]
connectedTableRecords

Query : Return Object
connectedTableRecords: PublicTableRecordConnection
Argument : ObjectDescription
first: Int Returns the first _n_ elements from the list.
after: String Returns the elements in the list that come after the specified global ID.
last: Int Returns the last _n_ elements from the list.
before: String Returns the elements in the list that come before the specified global ID.
tableId: ID!Required.
throughConnectors: ReferenceConnectorFieldInput!Required.
search: TableRecordSearch
fieldCondition

Query : Return Object
fieldCondition: FieldCondition
Argument : ObjectDescription
id: ID!Required.
inbox_emails

Lookup the card's emails by its ID

Query : Return Object
inbox_emails: [InboxEmail]
Argument : ObjectDescription
card_id: ID!Required. The card ID
me

Returns informations of the current authenticated user

Query : Return Object
me: User
organization

Lookup an organization by its ID

Query : Return Object
organization: Organization
Argument : ObjectDescription
id: ID!Required. The organization ID
organizations

Lookup organizations by their ID

Query : Return Object
organizations: [Organization]
Argument : ObjectDescription
ids: [ID] The organizations IDs
phase

Lookup a phase by its ID

Query : Return Object
phase: Phase
Argument : ObjectDescription
id: ID!Required. The phase ID
pipe

Lookup a pipe by its ID

Query : Return Object
pipe: Pipe
Argument : ObjectDescription
id: ID!Required. The pipe ID
pipe_relations

Lookup pipe relations by their ID

Query : Return Object
pipe_relations: [PipeRelation]
Argument : ObjectDescription
ids: [[ID]]!Required. The pipe relation ID
pipe_templates

Lookup all pipe templates available on Pipefy

Query : Return Object
pipe_templates: [PipeTemplate]
pipes

Lookup pipes by their ID

Query : Return Object
pipes: [Pipe]
Argument : ObjectDescription
ids: [[ID]]!Required. The pipes IDs
recordsImportations

Lookup the records importer history by the table ID

Query : Return Object
recordsImportations: [RecordsImportation]
Argument : ObjectDescription
tableId: ID!Required. The table ID
status: [String] Filter importation by status
repoItemForm

Query : Return Object
repoItemForm: RepoItemFormUnion
Argument : ObjectDescription
repoId: ID!Required.
throughConnectors: ReferenceConnectorFieldInput
table

Lookup a database table by its ID

Query : Return Object
table: Table
Argument : ObjectDescription
id: ID!Required. The table ID
table_record

Lookup a record by its ID

Query : Return Object
table_record: TableRecord
Argument : ObjectDescription
id: ID!Required. The record ID
table_records

Fetches a group of records based on arguments

Query : Return Object
table_records: TableRecordWithCountConnection
Argument : ObjectDescription
first: Int Returns the first _n_ elements from the list.
after: String Returns the elements in the list that come after the specified global ID.
last: Int Returns the last _n_ elements from the list.
before: String Returns the elements in the list that come before the specified global ID.
table_id: ID!Required. The table ID
search: TableRecordSearch Arguments that can be used to filter the search
table_relations

Lookup table relations by their ID

Query : Return Object
table_relations: [TableRelation]
Argument : ObjectDescription
ids: [[ID]]!Required. The table relation ID
tables

Lookup database tables by their ID

Query : Return Object
tables: [Table]
Argument : ObjectDescription
ids: [[ID]]!Required. The tables IDs