For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Ticket object
          • GET/tickets
          • POST/tickets
          • GET/tickets/{id}
          • PATCH/tickets/{id}
          • GET/tickets/{ticket_id}/viewers
          • GET/tickets/live-search
          • GET/tickets/meta/patch/{id}
          • GET/tickets/meta/post
          • GET/tickets/remote-field-classes
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsTickets

/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>" \
>     --data-urlencode expand=attachments,assignees,collections,assigned_teams,permissions,account,contact,creator,parent_ticket \
>     --data-urlencode remote_fields=priority,status,ticket_type \
>     --data-urlencode show_enum_origins=priority,status,ticket_type
200Retrieved
1{
2  "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
3  "remote_id": "19202938",
4  "created_at": "2021-09-15T00:00:00Z",
5  "modified_at": "2021-10-16T00:00:00Z",
6  "name": "Please add more integrations",
7  "assignees": [
8    "17a54124-287f-494d-965e-3c5b330c9a68"
9  ],
10  "assigned_teams": [
11    "4857c306-c1f9-489e-a6b6-90902f736dfe"
12  ],
13  "creator": "string",
14  "due_date": "2022-10-11T00:00:00Z",
15  "status": "OPEN",
16  "description": "Can you please add more integrations? It'll make syncing data much easier!",
17  "collections": [
18    "fb8c55b6-1cb8-4b4c-9fb6-17924231619d"
19  ],
20  "ticket_type": "incident",
21  "account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
22  "contact": "65c345ba-6870-4974-87ba-dd31509c367a",
23  "parent_ticket": "75b33d04-30d2-4f3e-be45-27838bc94342",
24  "attachments": [
25    "42747df1-95e7-46e2-93cc-66f1191edca5",
26    "92f972d0-2526-434b-9409-4c3b468e08f0"
27  ],
28  "access_level": "PRIVATE",
29  "permissions": [
30    {}
31  ],
32  "tags": [
33    "enterprise",
34    "other-tag"
35  ],
36  "roles": [
37    "21a54124-397f-494d-985e-3c5b330b8a68",
38    "17a54124-287f-494d-965e-3c5b330c9a68"
39  ],
40  "ticket_url": "https://thirdpartysoftware.com/project/3/issue/1",
41  "priority": "HIGH",
42  "remote_created_at": "2021-11-10T00:00:00Z",
43  "remote_updated_at": "2021-12-09T00:00:00Z",
44  "completed_at": "2021-12-09T00:00:00Z",
45  "remote_was_deleted": true,
46  "field_mappings": {
47    "organization_defined_targets": {
48      "custom_key": "custom_value"
49    },
50    "linked_account_defined_targets": {
51      "custom_key": "custom_value"
52    }
53  },
54  "remote_data": [
55    {
56      "path": "/platform-endpoint",
57      "data": null
58    }
59  ],
60  "remote_fields": [
61    {
62      "remote_field_class": {
63        "id": "string",
64        "display_name": "string",
65        "remote_key_name": "string",
66        "description": "string",
67        "is_custom": true,
68        "is_common_model_field": true,
69        "is_required": true,
70        "field_type": "string",
71        "field_format": "string",
72        "field_choices": [
73          "string"
74        ],
75        "item_schema": {
76          "item_type": "string",
77          "item_format": "string",
78          "item_choices": [
79            "string"
80          ]
81        }
82      },
83      "value": "string"
84    }
85  ]
86}

Returns a Ticket object with the given id.

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

Was this page helpful?
Previous

/tickets

Next

/tickets/{id}

Built with

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
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](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
namestring or null
The ticket's name.
assigneeslist of strings

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 strings

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 nullformat: "uuid"
The user who created this ticket.
due_datedatetime or null
The ticket's due date.
statusenum or null

The current status of the ticket.

  • OPEN - OPEN
  • CLOSED - CLOSED
  • IN_PROGRESS - IN_PROGRESS
  • ON_HOLD - ON_HOLD
Allowed values:
descriptionstring or null

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

collectionslist of strings

The Collections that this Ticket is included in.

ticket_typestring or null

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

accountstring or nullformat: "uuid"
The account associated with the ticket.
contactstring or nullformat: "uuid"
The contact associated with the ticket.
parent_ticketstring or nullformat: "uuid"
The ticket's parent ticket.
attachmentslist of strings
access_levelenum or null

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

  • COMPANY - COMPANY
  • PUBLIC - PUBLIC
  • PRIVATE - PRIVATE
  • COLLECTION - COLLECTION
Allowed values:
permissionslist of objectsRead-only
tagslist of strings
roleslist of strings
ticket_urlstring or nullformat: "uri"<=2000 characters
The 3rd party url of the Ticket.
priorityenum or null

The priority or urgency of the Ticket.

  • URGENT - URGENT
  • HIGH - HIGH
  • NORMAL - NORMAL
  • LOW - LOW
Allowed values:
remote_created_atdatetime or null
When the third party's ticket was created.
remote_updated_atdatetime or null
When the third party's ticket was updated.
completed_atdatetime or null
When the ticket was completed.
remote_was_deletedbooleanRead-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 nullRead-only
remote_datalist of objects or nullRead-only
remote_fieldslist of objectsRead-only

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