LUlucid
Users

Get All Users

Gets all users on an account.

get/Users

Request

  • Base URL
    https://users.lucid.app/scim/v2
  • URL
    https://users.lucid.app/scim/v2/Users
  • Auth
    HTTP bearer

Query parameters

startIndexnumber

Index of the first user in the list to return (1 indexed).

countnumber

Quantity of users to return from this request.

filterstring

See SCIM spec and optimization details below:

  • The only operator currently supported is eq
  • Filtered requests will result in a maximum of 10,000 users
  • While filtering should technically work on every attribute of a user, it is a very slow process for non-optimized attributes. We strongly recommend filtering only on the following optimized attributes whenever possible:
    • email / emails.value / workemail
    • username / displayname
    • externalid
    • urn:ietf:params:scim:schemas:extension:lucid:1.0:User.productLicenses.<name>
attributesstring[]

Comma-separated list of attribute names to include in the response. The attribute id is always returned. Cannot be used with excludedAttributes.

excludedAttributesstring[]

Comma-separated list of attribute names to exclude from the response. The attribute id is always returned and cannot be excluded. Cannot be used with attributes.

Response

OK. Returns a JSON object containing a list of users. Deactivated users will not be included in the totalResults or the JSON payload of users returned.

schemasstring[]
totalResultsinteger

The total number of users matching the query.

startIndexinteger

The index of the first user in the "Resources" list (for paginated results).

itemsPerPageinteger

The maximum number of users returned in the "Resources" list (for paginated results).

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 100,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "userName": "john-doe@example.com",
      "name": {
        "formatted": "John Doe",
        "givenName": "John",
        "familyName": "Doe"
      },
      "displayName": "john-doe@example.com",
      "emails": [
        {
          "value": "john-doe@example.com",
          "type": "work",
          "primary": true
        }
      ],
      "externalId": "external-123",
      "title": "Software Engineer",
      "phoneNumbers": [
        {
          "value": "+1-555-123-4567",
          "type": "work"
        }
      ],
      "roles": [
        {
          "value": "DocumentAdmin"
        }
      ],
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "costCenter": "CC-100",
        "organization": "Engineering",
        "division": "Product Development",
        "department": "Backend Engineering",
        "manager": {
          "value": "lucid-5678"
        }
      },
      "id": "lucid-1234",
      "groups": [
        {
          "value": "lucid-group-1234",
          "display": "Group A"
        }
      ]
    }
  ]
}

Changes

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