Retrieve a user
/users/{user_id}Retrieves a user by public ID, including the user's tags and current revision.
The response includes an ETag representing the current revision. Send this value in the If-Match header when updating the user to avoid overwriting a newer version.
The document and phone fields are returned only when the credentials have the users.read_personal permission; otherwise, they are omitted.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/users/string"{ "data": { "access": "granted", "created_at": "2019-08-24T14:15:22Z", "deleted": true, "document": "string", "email": "[email protected]", "external_id": "string", "id": "string", "name": "string", "object": "user", "phone": "string", "revision": "string", "status": "active", "tags": [ "string" ], "updated_at": "2019-08-24T14:15:22Z" }}Create a user POST
Creates a user. Tags and custom field values supplied in the request are applied to the new user. The `Location` header of the response contains the URL of the new user. If another user in the account already has the same email address or `external_id`, the API returns `already_exists`. If the account has reached the user limit of its plan, the API returns `plan_limit_reached`.
Update a user PATCH
Updates a user. Only the fields supplied in the request are changed. When `settings` is supplied, any setting omitted from it is set to `false`. To restore a user from the trash, send `deleted: false`. `status` is derived from the user's activity and is read-only. Including it in the request returns `unknown_field`. To avoid overwriting a newer version, send the `ETag` returned by the retrieve operation in the `If-Match` header.