roles list
GET {{baseUrl}}/roles
Returns a list of Role
objects.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
include_deleted_data | string | Whether to include data that was marked as deleted by third party webhooks. | |
include_remote_data | string | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, only objects synced by Merge after this date time will be returned. | |
modified_before | string | If provided, only objects synced by Merge before this date time will be returned. | |
page_size | string | Number of results to return per page. | |
remote_id | string | The API provider's ID for the given object. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
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}}]}]}