API Reference
Support from Community ↗︎

See a Ticket by ID

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

  1. Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
  2. Permissions: Ensure your token has permission to see a ticket.

Step 1: Find Your Card ID

Tickets are cards, so you can fetch an ticket by an card id.

  1. Via Pipefy UI:
    1. Open the Card in your browser.
    2. The URL will include the Card ID: https://app.pipefy.com/open-cards/123456789.
    3. Card ID = 123456789 (the number after /open-cards/).
  2. Via GraphQL Query
    1. Check on our Get resource IDs page.

Step 2: Execute the Query

query Ticket($id: ID!) {
  ticket(id: 123456789) {
    id
    title
    emailMessagingAddress
    createdAt
    createdBy {
      id
      name
      email
      avatarUrl
    }
    currentPhase {
      id
      name
    }
    phasesHistory {
      duration
      createdAt
      phase {
        id
        name
        fields {
          uuid
          type
          label
          description
          help
        }
      }
    }
    repo {
      startFormTitle
      startFormFields {
        uuid
        type
        label
        description
        help
      }
    }
    fieldValues {
      field {
        uuid
      }
      array_value
      assignee_values {
        id
        name
        email
        avatarUrl
      }
      connectedRepoItems {
        ... on PublicCard {
          id
          title
          summary {
            title
            value
          }
        }
        ... on PublicTableRecord {
          id
          title
          summary {
            title
            value
          }
        }
      }
      date_value
      datetime_value
      float_value
      label_values {
        id
        name
        color
      }
      value
    }
  }
}

Response Fields

  • ticket:
    • id: Unique identifier.
    • title: Ticket title.
    • emailMessagingAddress: E-mail that use to send some info about the ticket.
    • createdAt: When it was created.
    • createdBy: Who created it.
      • id: Unique identifier.
      • name: Creator name.
      • email: Creator email.
      • avatarUrl: Creator avatar url.
    • currentPhase: General info about a phase.
      • id: Unique identifier.
      • name: Name of the phase.
    • phasesHistory: Base information about the ticket in phase.
      • duration: Time in seconds.
      • createdAt: When it was created.
      • phase: General info about a phase.
        • id: Unique identifier.
        • name: Name of the phase.
        • fields: Fields that belongs to a phase
          • uuid: Unique identifier.
          • type: Inform what is field type (short text, long text, numeric...).
          • label: Field title.
          • description: Field description
          • help: Show a hint to user about field.
      • repo: Information from pipe.
        • startFormTitle: Start form title.
        • startFormFields: Fields that belongs to a start form.
          • uuid: Unique identifier
          • type: Inform what is field type (short text, long text, numeric...).
          • label: Field title.
          • description: Field description
          • help: Show a hint to user about field.
      • fieldValues: Information about field value
        • field: Field information.
          • uuid: Unique identifier.
        • array_value: Values from field.
        • assignee_values: Information about assigness in ticket.
          • id: Unique identifier.
          • name: Assignee name.
          • email: Assignee email.
          • avatarUrl: Assignee avatar url.
        • connectedRepoItems: Info about connected Repo.
        • date_value: Date value.
        • datetime_value: Datetime value.
        • float_value: Float value.
        • label_values: Values from label.
          • id: Unique identifier.
          • name: Label name.
          • color: Label color.
        • value: Value for field.

Example Response

{
  "data": {
    "ticket": {
      "id": "123456789",
      "title": "Example",
      "emailMessagingAddress": "[email protected]",
      "createdAt": "2025-05-09T14:00:00Z",
      "createdBy": {
        "id": "1",
        "name": "User",
        "email": "[email protected]",
        "avatarUrl": "https://gravatar.com/avatar/18df131953ca09a802848bf3f8dbf83b.png?s=144&d=https://pipestyle.staticpipefy.com/v2-temp/illustrations/avatar.png"
      },
      "currentPhase": {
        "id": "1234",
        "name": "2 Waiting assignment"
      },
      "phasesHistory": [
        {
          "duration": 14530164,
          "createdAt": "2025-05-09T14:00:00Z",
          "phase": {
            "id": "294",
            "name": "2 Waiting assignment",
            "fields": [
              {
                "uuid": "cb4c3392-660c-4a68-b741-cad99bbf2f92",
                "type": "long_text",
                "label": "Why is on hold?",
                "description": null,
                "help": null
              }
            ]
          }
        }
      ],
      "repo": {
        "startFormTitle": null,
        "startFormFields": [
          {
            "uuid": "2a3efb08-da27-4cb2-8d5a-46c382e13720",
            "type": "short_text",
            "label": "Name",
            "description": "A name example",
            "help": null
          },
          {
            "uuid": "c6d18a57-a956-45a0-bdd2-082eeb1edf72",
            "type": "email",
            "label": "A nice Email",
            "description": null,
            "help": null
          }
        ]
      },
      "fieldValues": [
        {
          "field": {
            "uuid": "81756478-8b58-4624-9ce6-80554be8ff40"
          },
          "array_value": [
            "229093",
            "239093",
          ],
          "assignee_values": [
            {
              "id": "229093",
              "name": "Example",
              "email": "[email protected]",
              "avatarUrl": "https://gravatar.com/avatar/773b5d8acf1d311d3f355ddf6a8e4f37.png?s=144&d=https://pipestyle.staticpipefy.com/v2-temp/illustrations/avatar.png"
            },
            {
              "id": "239093",
              "name": "Second Example",
              "email": "[email protected]",
              "avatarUrl": "https://gravatar.com/avatar/fcf3517f1b060a6a27927b56f969db53.png?s=144&d=https://pipestyle.staticpipefy.com/v2-temp/illustrations/avatar.png"
            }
          ],
          "connectedRepoItems": null,
          "date_value": null,
          "datetime_value": null,
          "float_value": null,
          "label_values": null,
          "value": "[\"Example\", \"Second Example\"]"
        }
      ]
    }
  }
}

Additional Notes

This query is read-only and does not modify tickets.

This query provides a quick and effective way to retrieve all tickets with all information and the tagged pipes.