Users

Retrieve User

Retrieve a specific User.

get/users/{id}

Request

  • Base URL
    https://sandbox.cognitohq.com
  • Auth
    none declared. Required headers: Cognito-Version

Headers

Cognito-Version'2020-08-14' required

The version of the Cognito API that you want to consume.

Response

The User was successfully retrieved.

idstring required

ID of the associated user.

created_atstring date-time required

An ISO8601 formatted timestamp.

emailstring email required

A valid email address.

status'invited' | 'active' | 'deactivated' required

The current status of the user.

Example response

{
  "id": "usr_1SUuwqBdK75GKi",
  "created_at": "2020-07-24T03:26:02Z",
  "email": "user@example.com",
  "status": "active"
}

Changes

No recorded changes to this operation across all 1 revision of this API.