/tickets/{id}

GET

/ticketing/v1/tickets/:id

GET

/api/ticketing/v1/tickets/:id

curl -G https://api.merge.dev/api/ticketing/v1/tickets/id \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -d include_remote_data=true

200Retrieved

{
  "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
  "remote_id": "19202938",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "name": "Please add more integrations",
  "assignees": [
    "17a54124-287f-494d-965e-3c5b330c9a68"
  ],
  "assigned_teams": [
    "4857c306-c1f9-489e-a6b6-90902f736dfe"
  ],
  "creator": "string",
  "due_date": "2022-10-11T00:00:00Z",
  "status": "OPEN",
  "description": "Can you please add more integrations? It'll make syncing data much easier!",
  "collections": [
    "fb8c55b6-1cb8-4b4c-9fb6-17924231619d"
  ],
  "ticket_type": "incident",
  "account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
  "contact": "65c345ba-6870-4974-87ba-dd31509c367a",
  "parent_ticket": "75b33d04-30d2-4f3e-be45-27838bc94342",
  "attachments": [
    "42747df1-95e7-46e2-93cc-66f1191edca5",
    "92f972d0-2526-434b-9409-4c3b468e08f0"
  ],
  "access_level": "PRIVATE",
  "permissions": [
    {}
  ],
  "tags": [
    "enterprise",
    "other-tag"
  ],
  "roles": [
    "21a54124-397f-494d-985e-3c5b330b8a68",
    "17a54124-287f-494d-965e-3c5b330c9a68"
  ],
  "ticket_url": "https://thirdpartysoftware.com/project/3/issue/1",
  "priority": "HIGH",
  "remote_created_at": "2021-11-10T00:00:00Z",
  "remote_updated_at": "2021-12-09T00:00:00Z",
  "completed_at": "2021-12-09T00:00:00Z",
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/platform-endpoint",
      "data": null
    }
  ],
  "remote_fields": [
    {
      "remote_field_class": {
        "id": "string",
        "display_name": "string",
        "remote_key_name": "string",
        "description": "string",
        "is_custom": true,
        "is_common_model_field": true,
        "is_required": true,
        "field_type": "string",
        "field_format": "string",
        "field_choices": [
          "string"
        ],
        "item_schema": {
          "item_type": "string",
          "item_format": "string",
          "item_choices": [
            "string"
          ]
        }
      },
      "value": "string"
    }
  ]
}

Returns a Ticket object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandlist of enumsOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

show_enum_originsenumOptional

A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. Learn more

Response

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

The individual Users who are assigned to this ticket. This does not include Users who just have view access to this ticket. To fetch all Users and Teams that can access the ticket, use the GET /tickets/{ticket_id}/viewers endpoint.

assigned_teamslist of stringsOptional

The Teams that are assigned to this ticket. This does not include Teams who just have view access to this ticket. To fetch all Users and Teams that can access this ticket, use the GET /tickets/{ticket_id}/viewers endpoint.

creatorstring or nullOptionalformat: "uuid"

The user who created this ticket.

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=status to receive the integration’s own value instead.

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=ticket_type to receive the integration’s own value instead.

accountstring or nullOptionalformat: "uuid"

The account associated with the ticket.

contactstring or nullOptionalformat: "uuid"

The contact associated with the ticket.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

attachmentslist of stringsOptional

access_levelenum or nullOptional

The description of who is able to access a given ticket, or where access is inherited from.

Allowed values:

permissionslist of objectsOptionalRead-only

tagslist of stringsOptional

roleslist of stringsOptional

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

priorityenum or nullOptional

The priority or urgency of the Ticket. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=priority to receive the integration’s own value instead.

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

completed_atdatetime or nullOptional

When the ticket was completed.

remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

/tickets/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration