/roles

Returns a list of Role objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

created_afterdatetimeOptional

If provided, will only return objects created after this datetime.

created_beforedatetimeOptional

If provided, will only return objects created before this datetime.

cursorstringOptional

The pagination cursor value.

include_deleted_databooleanOptional

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.

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).

modified_afterdatetimeOptional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforedatetimeOptional

If provided, only objects synced by Merge before this date time will be returned.

page_sizeintegerOptional

Number of results to return per page. The maximum limit is 100.

remote_idstringOptional

The API provider's ID for the given object.

Response

nextstring or null

previousstring or null

resultslist of objects or null

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	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	response = client.ticketing.roles.list(
8	cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
9	)
10	for item in response:
11	yield item
12	# alternatively, you can paginate page-by-page
13	for page in response.iter_pages():
14	yield page

1	{
2	"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3	"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4	"results": [
5	{
6	"id": "23454124-387f-494d-265e-345b330c9123",
7	"remote_id": "123",
8	"created_at": "2021-09-15T00:00:00Z",
9	"modified_at": "2021-10-16T00:00:00Z",
10	"name": "Member",
11	"ticket_actions": [
12	"VIEW",
13	"EDIT",
14	"CREATE"
15	],
16	"ticket_access": "ASSIGNED_ONLY",
17	"remote_was_deleted": true,
18	"field_mappings": {
19	"organization_defined_targets": {
20	"custom_key": "custom_value"
21	},
22	"linked_account_defined_targets": {
23	"custom_key": "custom_value"
24	}
25	},
26	"remote_data": [
27	{
28	"path": "/platform-endpoint"
29	}
30	]
31	}
32	]
33	}

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration