User

Get user

Changed on

Return the requested user by its ID.

get/v1/users/{id}

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/users/{id}
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: user.read)

Response

OK

idstring required

Unique identifier of the user.

usernamestring required

The unique username of the user.

first_namestring required

First name of the user.

last_namestring required

Last name of the user.

emailstring email required

Email address of the user.

picturestring uri nullable required

Profile picture of the user.

titlestring nullable required

Work title of the user.

biostring nullable required

Self description of the user.

addressstring nullable required

Working address of the user.

phonestring nullable required

Phone number of the user.

linksstring[] nullable required

Links to show on profile page.

languagesLanguage[] required

Languages of the user.

status'active' | 'pending' | 'inactive' | 'deleted' required

Status of the user.

document_countinteger nullable

Number of documents the user created when projected.

created_atstring date-time required

Date when the user was created.

updated_atstring date-time nullable required

Date when the user was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "username": "test-user",
  "first_name": "Test",
  "last_name": "User",
  "email": "user@example.com",
  "picture": "https://example.com/users/my-user.png",
  "title": "Senior Software Engineer",
  "bio": "I'm working smart on software.",
  "address": "Remote",
  "phone": "+15555551234",
  "links": [
    "https://example.com/my-user"
  ],
  "status": "active",
  "document_count": 3
}

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 6965ecf3ab92Revision changes
    • info

      added the optional property to the response with the status