roles list

GET {{baseUrl}}/roles

Returns a list of Role objects.

Request Params

KeyDatatypeRequiredDescription
created_afterstringIf provided, will only return objects created after this datetime.
created_beforestringIf provided, will only return objects created before this datetime.
cursorstringThe pagination cursor value.
include_deleted_datastringWhether to include data that was marked as deleted by third party webhooks.
include_remote_datastringWhether to include the original data Merge fetched from the third-party to produce these models.
modified_afterstringIf provided, only objects synced by Merge after this date time will be returned.
modified_beforestringIf provided, only objects synced by Merge before this date time will be returned.
page_sizestringNumber of results to return per page.
remote_idstringThe API provider's ID for the given object.

HEADERS

KeyDatatypeRequiredDescription
X-Account-Tokenstring(Required) Token identifying the end user.
Acceptstring

RESPONSES

status: OK

{"next":"\u003cstring\u003e","previous":"\u003cstring\u003e","results":[{"id":"\u003cuuid\u003e","remote_id":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","ticket_actions":["DELETE","EDIT"],"ticket_access":"TEAM_ONLY","remote_was_deleted":"\u003cboolean\u003e","field_mappings":{"proident_8ba":{}},"remote_data":[{"path":"\u003cstring\u003e","data":{"readOnly":true}},{"path":"\u003cstring\u003e","data":{"readOnly":true}}]},{"id":"\u003cuuid\u003e","remote_id":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","ticket_actions":["CREATE","DELETE"],"ticket_access":"ALL","remote_was_deleted":"\u003cboolean\u003e","field_mappings":{"officia__31":{},"reprehenderit_1":{},"reprehenderit9e6":{},"aliquip_2":{}},"remote_data":[{"path":"\u003cstring\u003e","data":{"readOnly":true}},{"path":"\u003cstring\u003e","data":{"readOnly":true}}]}]}