Users

Getting User details

Changed on

Typically, you supply the integer ID to get information about the user associated with that id.

It is also possible to supply the text current instead of an integer ID; please see the following endpoint for documentation about this.

get/v1/users/{actorId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/users/{actorId}
  • Auth
    none declared

Path parameters

actorIdstring required

Typically the integer ID of the User. For getting user details, you can also supply the text current, which will tell you about the currently authenticated user.

Response

OK

createdAtstring required

ISO date format

displayNamestring required

All Actors, regardless of type, have a display name

idnumber required
type'user' | 'field_key' | 'public_link' | 'singleUse' required

the Type of this Actor; typically this will be user.

updatedAtstring

ISO date format

deletedAtstring

ISO date format

emailstring required

Only Users have email addresses associated with them

Changes