Users

The User object is used to represent a user in the CRM system.

The User object

Properties

idString

Required

remote_idString

Optional

The third-party API ID of the matching object.

nameString

Optional

The user's name.

emailString

Optional

The user's email address.

is_activeBoolean

Optional

Whether or not the user is active.

remote_was_deletedBoolean

Required

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

The User object

JSON


{
  "id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "remote_id": "19202938",
  "name": "Gil Feig",
  "email": "[email protected]",
  "is_active": true,
  "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.

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": "0358cbc6-2040-430a-848e-aafacbadf3aa",
      "remote_id": "19202938",
      "name": "Gil Feig",
      "email": "[email protected]",
      "is_active": true,
      "remote_was_deleted": true
    }
  ]
}

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_idString

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_idString

Coming Soon

Gitlab

Coming Soon

Zoho Desk

Coming Soon

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

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": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "remote_id": "19202938",
  "name": "Gil Feig",
  "email": "[email protected]",
  "is_active": true,
  "remote_was_deleted": true
}

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

is_activeBoolean

nameString

remote_idString

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

emailString

nameString

remote_idString

The User object

Properties

/users

Header Parameters

Query & Path Parameters

Capsule

Close

Copper

Hubspot

Pipedrive

Salesflare

Salesforce

Trello

Gitlab

Zoho Desk

Basecamp

/users/{id}

Header Parameters

Query & Path Parameters

Capsule

Close

Copper

Hubspot

Pipedrive

Salesflare

Salesforce

Trello

Gitlab

Zoho Desk

Basecamp

Previous

Next Up

Get Started

API Reference