Roles
The Role object is used to represent the set of actions & access that a user with this role is allowed to perform.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.

nameString
Optional
The name of the Role.

ticket_actionsArray
Optional
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
Optional
The level of Ticket access that a User with this Role can perform. Possible values include: ALL, ASSIGNED_ONLY, TEAM_ONLY. In cases where there is no clear mapping, the original value passed through will be returned.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/roles
Beta

https://api.merge.dev/api/ticketing/v1/roles

US
EU

Returns a list of Role objects.


Query & Path Parameters

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

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

modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Aha!
Aha!
Bitbucket
Bitbucket
Freshdesk
Freshdesk
Freshservice
Freshservice
Front
Front
Height
Height
Hive
Hive
Teamwork
Teamwork
Zendesk
Zendesk
GET
/roles/{id}
Beta

https://api.merge.dev/api/ticketing/v1/roles/{id}

US
EU

Returns a Role object with the given id.


Query & Path Parameters

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Aha!
Aha!
Bitbucket
Bitbucket
Freshdesk
Freshdesk
Freshservice
Freshservice
Front
Front
Height
Height
Hive
Hive
Teamwork
Teamwork
Zendesk
Zendesk