Roles
The
Role object is used to represent the set of actions & access that a user with this role is allowed to perform.Properties
idUUIDRequired
remote_idStringOptional
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.
nameStringOptional
The name of the Role.
ticket_actionsArrayOptional
The set of actions that a User with this Role can perform. Possible enum values include:
VIEW, CREATE, EDIT, DELETE, CLOSE, and ASSIGN.ticket_accessEnumOptional
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deletedBooleanRequired
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_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/roles
Betahttps://api.merge.dev/api/ticketing/v1/roles
US
EU
APAC
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.
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_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_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Aha!
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringticket_accessEnumticket_actionsArray
Bitbucket
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringticket_accessEnumticket_actionsArray
Freshdesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringticket_accessEnumticket_actionsArray
Freshservice
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringticket_accessEnumticket_actionsArray
Front
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringticket_accessEnumticket_actionsArray
Height
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringticket_accessEnumticket_actionsArray
Hive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idString
Teamwork
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringticket_accessEnumticket_actionsArray
Zendesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringticket_accessEnumticket_actionsArrayGET
/roles/{id}
Betahttps://api.merge.dev/api/ticketing/v1/roles/{id}
US
EU
APAC
Returns a Role object with the given id.
Query & Path Parameters
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Aha!
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringticket_accessEnumticket_actionsArrayBitbucket
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringticket_accessEnumticket_actionsArrayFreshdesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringticket_accessEnumticket_actionsArrayFreshservice
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringticket_accessEnumticket_actionsArrayFront
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringticket_accessEnumticket_actionsArrayHeight
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringticket_accessEnumticket_actionsArrayHive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringTeamwork
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringticket_accessEnumticket_actionsArrayZendesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringticket_accessEnumticket_actionsArray