Users

The User object is used to represent an employee within a company.

The User object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The user's name.

email_addressString
Optional
The user's email address.

is_activeBoolean
Optional
Whether or not the user is active.

teamsArray
Required

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

The User object
JSON
{
"id": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"name": "Gil Feig",
"email_address": "[email protected]",
"is_active": true,
"teams": [
"28b54125-287f-494d-965e-3c5b330c9a68",
"17a54124-287f-494d-965e-3c5b330c9a68"
],
"remote_was_deleted": true
}

GET

/users

Returns a list of User objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"name": "Gil Feig",
"email_address": "[email protected]",
"is_active": true,
"teams": [
"28b54125-287f-494d-965e-3c5b330c9a68",
"17a54124-287f-494d-965e-3c5b330c9a68"
],
"remote_was_deleted": true
}
]
}
Field support by platform

Asana

Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

remote_idString

teamsArray

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

remote_idString

teamsArray

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

GitHub Issues

GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

remote_idString

teamsArray

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

remote_idString

teamsArray

Intercom

Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

remote_idString

teamsArray

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Jira Software

Jira Software

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray
Trello

Trello

Coming Soon
Gitlab

Gitlab

Coming Soon
Zoho Desk

Zoho Desk

Coming Soon
Basecamp

Basecamp

Coming Soon
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/users/{id}

Returns a User object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"name": "Gil Feig",
"email_address": "[email protected]",
"is_active": true,
"teams": [
"28b54125-287f-494d-965e-3c5b330c9a68",
"17a54124-287f-494d-965e-3c5b330c9a68"
],
"remote_was_deleted": true
}
Field support by platform

Asana

Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

remote_idString

teamsArray

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

remote_idString

teamsArray

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

GitHub Issues

GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

remote_idString

teamsArray

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

remote_idString

teamsArray

Intercom

Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

nameString

remote_idString

teamsArray

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Jira Software

Jira Software

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


email_addressString

is_activeBoolean

nameString

remote_idString

teamsArray
Trello

Trello

Coming Soon
Gitlab

Gitlab

Coming Soon
Zoho Desk

Zoho Desk

Coming Soon
Basecamp

Basecamp

Coming Soon
Hint: Use the /linked-accounts endpoint to pull platform support information.