Back

Query


The query root of Pipefy's GraphQL interface

Field : ObjectDescription
agentsUsageDetails: AgentsDetails Returns information about the usage of agents in the organization.
aiAgent: AiAgent Returns information about the agent.
aiAgents: AiAgentConnection Returns information about the agents in the pipe.
aiCreditUsageStats: UsageStatsAiCreditDetails Getting AI credits usage data
allCards: CardConnection Fetches all pipe cards based on arguments
autoFillFields: [AutoFillFieldUnion] Lookup the values that will automatically fill the child-card's start form fields
automatedFormulaOperations: [[ID]] Lookup available formula operations for automated formula type automations
automation: Automation Lookup an automation by its ID
automationActions: [[ID]] Lookup information about the automation's actions
automationEventAttributes: AutomationEventAttributes Automations event attributes
automationEvents: [[ID]] Lookup information about the automation's events
automationEventsByPhase: [[ID]] Lookup information about the automation's events by phase
automationInitialValues: Automation Lookup initial values for automation
automationJobsExport: AutomationJobsExport Lookup an automation jobs export by its ID
automationLogs: AutomationLogConnection Search automation logs by automation
automationLogsByRepo: AutomationLogConnection Search automation logs by repo
automationSimulation: AutomationSimulation Automation simulation result
automations: AutomationConnection Lookup automations by organization and filters
automationsUsageDetails: AutomationsDetails Returns information about the usage of agents in the organization.
availableRoles: [String] The avaiable roles for logged user
card: Card Lookup a card by its ID
cards: CardConnection Fetches a group of cards based on arguments
cardsImportations: [CardsImportation] Lookup the cards importer history by the pipe ID
channelConfigurations: ChannelConfigurationConnection Show channel configurations available for the organization (allows filtering by channel name, channel status, channel type and provider identifier)
conditionalField: ConditionalField Conditional Field
connectedTableRecords: PublicTableRecordConnection Connected Table Records
field: FieldDependency Show all resources that depend on the target field
fieldCondition: FieldCondition Field condition
filterAuthorizedFormsToMe: [[ID]] Filter authorized forms to me by organization
findCards: CardConnection Fetch cards based on fields' inputs
findRecords: CardConnection Fetch records based on fields' inputs
groups: GroupConnection Get groups of given organization
inbox_emails: [[ID]] Lookup the card's emails by its ID
me: User Returns informations of the current authenticated user
notifications: Notifications Returns notifications of the current authenticated user
organization: Organization Lookup an organization by its ID
organizationReport: OrganizationReport Lookup a organization report by ID
organizationReportExport: OrganizationReportExport Lookup a organization report export by its ID
organizationReports: OrganizationReportConnection Lookup a organization reports by organization
organizationSettings: OrganizationSettings Lookup an organization settings by its ID
organizations: [Organization] Lookup organizations by their ID
phase: Phase Lookup a phase by its ID
pipe: Pipe Lookup a pipe by its ID
pipeFlow: PipeFlow Lookup a pipe's flow by its UUID
pipeReportColumns: [[ID]] Lookup columns for pipe report.
pipeReportExport: PipeReportExport Lookup a pipe report export by its ID
pipeReportFilterableFields: [[ID]] Lookup filterable fields for pipe report.
pipeReports: PipeReportConnection Lookup pipe reports
pipe_relations: [PipeRelation] Lookup pipe relations by their ID
pipe_templates: [PipeTemplate] Lookup all pipe templates available on Pipefy
pipes: [Pipe] Lookup pipes by their ID
platformAppConfiguration: AppConfigurationData Get configuration data related to a platform app in the scope of a resource
publicUser: PublicUserType Return limited user information
recordsImportations: [RecordsImportation] Lookup the records importer history by the table ID
repoItemForm: RepoItemFormUnion Repo Item form
table: Table Lookup a database table by its ID
table_record: TableRecord Lookup a record by its ID
table_records: TableRecordWithCountConnection Fetches a group of records based on arguments
table_relations: [TableRelation] Lookup table relations by their ID
tables: [Table] Lookup database tables by their ID
tagCategories: [[ID]] Get all tag categories by organization
tagsByCategory: [[ID]] Get all tags grouped by category by organization
tagsByCategoryOnResource: TagsByCategoryOnResourceConnection Get all tags by categories and if they are on the resource
templateAgents: [[ID]] Return the agents on that template.
ticket: Ticket Lookup a ticket by its ID
troubleshootLlmError: TroubleshootError Troubleshoot error from BYOLLM config
usersSuggestions: UsersSuggestionsConnection Get users suggestion by OrganizationUuid