Required permissions: users.read.*
curl --request GET \
--url https://{primary_domain}/api/public/v2.0/users \
--header 'X-Access-Key-Id: <api-key>' \
--header 'X-Access-Key-Secret: <api-key>'
{
"message": "<string>",
"data": [
{
"id": 123,
"department_id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"status": 0,
"timezone": "<string>",
"work_hours": {
"sunday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"monday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"tuesday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"wednesday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"thursday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"friday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"saturday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
]
},
"avatar_url": "<string>",
"role": "<string>",
"name": "<string>",
"department_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"current_page": 123,
"first_page_url": "<string>",
"from": 123,
"last_page": 123,
"last_page_url": "<string>",
"next_page_url": "<string>",
"path": "<string>",
"per_page": 123,
"prev_page_url": "<string>",
"to": 123,
"total": 123
}
Maximum number of items in a page.
Page number of query.
Whether or not deleted items are included.
Attribute to order query by.
Direction to order query by.
asc
, desc
Value of attribute to filter query by.
Comparison operator to filter query by.
Equal
, NotEqual
, Contains
, GreaterThan
, GreaterThanOrEqual
, LessThan
, LessThanOrEqual
, IsNull
, NotNull
Attribute to filter query by
The response is of type object
.
curl --request GET \
--url https://{primary_domain}/api/public/v2.0/users \
--header 'X-Access-Key-Id: <api-key>' \
--header 'X-Access-Key-Secret: <api-key>'
{
"message": "<string>",
"data": [
{
"id": 123,
"department_id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"status": 0,
"timezone": "<string>",
"work_hours": {
"sunday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"monday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"tuesday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"wednesday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"thursday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"friday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"saturday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
]
},
"avatar_url": "<string>",
"role": "<string>",
"name": "<string>",
"department_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"current_page": 123,
"first_page_url": "<string>",
"from": 123,
"last_page": 123,
"last_page_url": "<string>",
"next_page_url": "<string>",
"path": "<string>",
"per_page": 123,
"prev_page_url": "<string>",
"to": 123,
"total": 123
}
Required permissions: users.read.*
curl --request GET \
--url https://{primary_domain}/api/public/v2.0/users \
--header 'X-Access-Key-Id: <api-key>' \
--header 'X-Access-Key-Secret: <api-key>'
{
"message": "<string>",
"data": [
{
"id": 123,
"department_id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"status": 0,
"timezone": "<string>",
"work_hours": {
"sunday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"monday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"tuesday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"wednesday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"thursday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"friday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"saturday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
]
},
"avatar_url": "<string>",
"role": "<string>",
"name": "<string>",
"department_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"current_page": 123,
"first_page_url": "<string>",
"from": 123,
"last_page": 123,
"last_page_url": "<string>",
"next_page_url": "<string>",
"path": "<string>",
"per_page": 123,
"prev_page_url": "<string>",
"to": 123,
"total": 123
}
Maximum number of items in a page.
Page number of query.
Whether or not deleted items are included.
Attribute to order query by.
Direction to order query by.
asc
, desc
Value of attribute to filter query by.
Comparison operator to filter query by.
Equal
, NotEqual
, Contains
, GreaterThan
, GreaterThanOrEqual
, LessThan
, LessThanOrEqual
, IsNull
, NotNull
Attribute to filter query by
The response is of type object
.
curl --request GET \
--url https://{primary_domain}/api/public/v2.0/users \
--header 'X-Access-Key-Id: <api-key>' \
--header 'X-Access-Key-Secret: <api-key>'
{
"message": "<string>",
"data": [
{
"id": 123,
"department_id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"status": 0,
"timezone": "<string>",
"work_hours": {
"sunday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"monday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"tuesday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"wednesday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"thursday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"friday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
],
"saturday": [
{
"start": {
"hour": 12,
"minute": 30,
"second": 30
},
"end": {
"hour": 12,
"minute": 30,
"second": 30
}
}
]
},
"avatar_url": "<string>",
"role": "<string>",
"name": "<string>",
"department_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"current_page": 123,
"first_page_url": "<string>",
"from": 123,
"last_page": 123,
"last_page_url": "<string>",
"next_page_url": "<string>",
"path": "<string>",
"per_page": 123,
"prev_page_url": "<string>",
"to": 123,
"total": 123
}