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 Role object
          • GET/roles
          • GET/roles/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsRoles

/roles/{id}

GET
/ticketing/v1/roles/:id
GET
/api/ticketing/v1/roles/:id
$curl https://api.merge.dev/api/ticketing/v1/roles/id \
>     -H "X-Account-Token: X-Account-Token" \
>     -H "Authorization: Bearer <token>"
200Retrieved
1{
2  "id": "23454124-387f-494d-265e-345b330c9123",
3  "remote_id": "123",
4  "created_at": "2021-09-15T00:00:00Z",
5  "modified_at": "2021-10-16T00:00:00Z",
6  "name": "Member",
7  "ticket_actions": [
8    "VIEW",
9    "EDIT",
10    "CREATE"
11  ],
12  "ticket_access": "ASSIGNED_ONLY",
13  "remote_was_deleted": true,
14  "field_mappings": {
15    "organization_defined_targets": {
16      "custom_key": "custom_value"
17    },
18    "linked_account_defined_targets": {
19      "custom_key": "custom_value"
20    }
21  },
22  "remote_data": [
23    {
24      "path": "/platform-endpoint",
25      "data": null
26    }
27  ]
28}

Returns a Role 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

/roles

Next

The Tag object

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

include_remote_databooleanOptional

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

include_shell_databooleanOptional

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

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 name of the Role.
ticket_actionslist of enums or null

The set of actions that a User with this Role can perform. Possible enum values include: VIEW, CREATE, EDIT, DELETE, CLOSE, and ASSIGN.

ticket_accessenum or null

The level of Ticket access that a User with this Role can perform.

  • ALL - ALL
  • ASSIGNED_ONLY - ASSIGNED_ONLY
  • TEAM_ONLY - TEAM_ONLY
Allowed values:
remote_was_deletedboolean

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