GET user/…

Retrieves the details of a user account.

Users are always permitted to retrieve the details of their own user account. Retrieving the details of another user account is only permitted if the calling user is an administrator (staff user) of the same organization that manages the requested user account.

Resource URL

https://www.drillster.com/api/2.1.1/user

https://www.drillster.com/api/2.1.1/user/{user_id}

https://www.drillster.com/api/2.1.1/user/{user_email}

https://www.drillster.com/api/2.1.1/user/{third_party}/{third_party_id}

Parameters

Field	Description
`user_id` or `user_email` or `third_party/third_party_id` optional	The user reference of the user to retrieve details for. If omitted, the details for the own user account are returned. The magic value `self` may be used to refer to the authenticated user. Example values: `7OuHq-RcQO_snGWR58TnBw`, `john_doe@example.com`

💡 Good to know

Instead of the user ID, an email address may also be used to identify the requested user. Be sure to URL encode the @-sign!

Response

A 2.1.1 User object with the details of the requested user account.

Example request

GET https://www.drillster.com/api/2.1.1/user

Response

{
  "id": "7OuHq-RcQO_snGWR58TnBw",
  "name": "Phineas Flynn",
  "memberSince": "2010-03-12T15:47:31Z",
  "emailAddress": "phineas@example.com",
  "biography": "",
  "avatar": {
    "type": "image/png",
    "url": "https://www.drillster.com/bin/avatar/05105d2b6585d1e1ee2b5491347375b95e2c623e"
  },
  "locale": "en",
  "timeZone": "America/Los_Angeles",
  "organization": {
    "id": "nPjYUn0upc8dIm7yzTIBgQ",
    "name": "Acme Corp"
  }
}

Error responses

The following error situations are possible:

ID	Description
`nonexistent_user`	Requested user account does not exist.
`no_access`	Caller does not have access to the requested user.

Last updated on 2024-10-02