v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB

Users

List Users

Retrieves information about all users on the authenticated account.

get/v1/users

Response

OK. Returns a list of User resources containing information about users on the account.

accountIdnumber

The unique ID for the user's account.

enabledboolean

Whether the user can authenticate to Lucid. Corresponds to the SCIM active attribute.

emailstring

The user's email.

namestring

The user's full name.

userIdnumber

The unique ID for the user.

usernamestring

The user's username.

rolesUserRole[]

A list of administrative roles assigned to the user.

Example response

[
  {
    "accountId": 100,
    "enabled": true,
    "email": "john-doe@example.com",
    "name": "John Doe",
    "userId": 101,
    "username": "johndoe",
    "roles": [
      "billing-admin",
      "team-admin"
    ],
    "avatar": {
      "type": "url",
      "link": "https://www.gravatar.com/avatar/00000000000000000000000000000000?s=200&d=404"
    }
  }
]