Roles
The
Role
object is used to represent the set of actions & access that a user with this role is allowed to perform.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
name
StringOptional
The name of the Role.
ticket_actions
ArrayOptional
The set of actions that a User with this Role can perform. Possible enum values include:
VIEW
, CREATE
, EDIT
, DELETE
, CLOSE
, and ASSIGN
.ticket_access
EnumOptional
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_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
GET
/roles
Betahttps://api.merge.dev/api/ticketing/v1/roles
US
EU
APAC
Returns a list of Role
objects.
Query & Path Parameters
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
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!](https://merge-api-production.s3.amazonaws.com/media/Aha_square.png)
Aha!
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringticket_access
Enumticket_actions
Array![Bitbucket](https://merge-api-production.s3.amazonaws.com/media/Platformbitbucket_square.png)
Bitbucket
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringticket_access
Enumticket_actions
Array![Freshdesk](https://merge-api-production.s3.amazonaws.com/media/Freshdesk_Square_Logo.jpeg)
Freshdesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringticket_access
Enumticket_actions
Array![Freshservice](https://merge-api-production.s3.amazonaws.com/media/Platformfreshservice_square.png)
Freshservice
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringticket_access
Enumticket_actions
Array![Front](https://merge-api-production.s3.amazonaws.com/media/Front_square.png)
Front
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringticket_access
Enumticket_actions
Array![Height](https://merge-api-production.s3.amazonaws.com/media/Height_square.png)
Height
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringticket_access
Enumticket_actions
Array![Hive](https://merge-api-production.s3.amazonaws.com/media/Hive_Square_Logo.png)
Hive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String![Teamwork](https://merge-api-production.s3.amazonaws.com/media/Teamwork_Square_Logo.png)
Teamwork
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringticket_access
Enumticket_actions
Array![Zendesk](https://merge-api-production.s3.amazonaws.com/media/PlatformZendesk_9qMuXiF.png)
Zendesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringticket_access
Enumticket_actions
ArrayGET
/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
id
UUIDRequired
include_remote_data
BooleanOptional
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!](https://merge-api-production.s3.amazonaws.com/media/Aha_square.png)
Aha!
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringticket_access
Enumticket_actions
Array![Bitbucket](https://merge-api-production.s3.amazonaws.com/media/Platformbitbucket_square.png)
Bitbucket
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringticket_access
Enumticket_actions
Array![Freshdesk](https://merge-api-production.s3.amazonaws.com/media/Freshdesk_Square_Logo.jpeg)
Freshdesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringticket_access
Enumticket_actions
Array![Freshservice](https://merge-api-production.s3.amazonaws.com/media/Platformfreshservice_square.png)
Freshservice
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringticket_access
Enumticket_actions
Array![Front](https://merge-api-production.s3.amazonaws.com/media/Front_square.png)
Front
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringticket_access
Enumticket_actions
Array![Height](https://merge-api-production.s3.amazonaws.com/media/Height_square.png)
Height
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringticket_access
Enumticket_actions
Array![Hive](https://merge-api-production.s3.amazonaws.com/media/Hive_Square_Logo.png)
Hive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String![Teamwork](https://merge-api-production.s3.amazonaws.com/media/Teamwork_Square_Logo.png)
Teamwork
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringticket_access
Enumticket_actions
Array![Zendesk](https://merge-api-production.s3.amazonaws.com/media/PlatformZendesk_9qMuXiF.png)
Zendesk
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringticket_access
Enumticket_actions
Array