Users

Returns one account with its roles and effective permissions.

Requires ManageUsers (no module). Sends a weak ETag. Example: GET /api/v1/users/8f0c3c1e-2b6d-4c55-9a51-0d3f3c1b7e21.

get/api/v1/users/{id}

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/users/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

User id (string GUID) from GET /api/v1/users.

Response

The account.

idstring

User id (string GUID). Example: "8f0c3c1e-2b6d-4c55-9a51-0d3f3c1b7e21".

emailstring nullable

Login e-mail address. Example: "sam@example.com".

firstNamestring nullable

First name. Example: "Sam".

lastNamestring nullable

Last name. Example: "Carter".

displayNamestring

Display name, e.g. "Sam Carter"; falls back to the e-mail address when no name is recorded.

isActiveboolean

False when the account is deactivated (it cannot sign in and holds no seat).

rolestring nullable

Highest standard role the account holds — OrganizationAdmin, Manager or User (SystemAdmin for platform staff); null when it holds only custom roles.

customRoleIdsinteger[]

Ids of the custom roles the account holds (see /api/v1/roles). Empty when none.

permissionsstring[]

Effective permissions from all of the account's roles, in catalog order. Example: ["ViewInventory", "ViewJobs"].

Changes

No recorded changes to this operation across all 1 revision of this API.