Skip to main content
GET
/
v1
/
w3s
/
users
/
{id}
Get a user by ID
curl --request GET \
  --url https://api.circle.com/v1/w3s/users/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "user": {
      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "createDate": "2023-01-01T12:04:05Z",
      "pinStatus": "ENABLED",
      "status": "ENABLED",
      "securityQuestionStatus": "ENABLED",
      "pinDetails": {
        "failedAttempts": 123,
        "lockedDate": "2023-01-01T12:04:05Z",
        "lockedExpiryDate": "2023-01-01T12:04:05Z",
        "lastLockOverrideDate": "2023-01-01T12:04:05Z"
      },
      "securityQuestionDetails": {
        "failedAttempts": 123,
        "lockedDate": "2023-01-01T12:04:05Z",
        "lockedExpiryDate": "2023-01-01T12:04:05Z",
        "lastLockOverrideDate": "2023-01-01T12:04:05Z"
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

​
X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support. A unique identifier, which can be helpful for identifying a request when communicating with Circle support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Path Parameters

​
id
string
required

Filter by user's system generated identifiers.

Required string length: 5 - 50

Response

Successfully retrieved the user.

​
data
object
required