v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB

Users

Getting User details

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}

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

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