/roles/{id}

Returns a Role object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

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

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

The datetime that this object was created by Merge.

modified_atdatetime or nullRead-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

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 or null

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

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The name of the Role.

ticket_actionslist of enums or nullOptional

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 nullOptional

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_datalist of objects or nullOptionalRead-only

1	import { MergeClient } from "@mergeapi/merge-node-client";
2
3	const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
4	await client.ticketing.roles.retrieve("id", {
5	includeRemoteData: true,
6	includeShellData: true
7	});

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	}
26	]
27	}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration