Get All Users

get

https://users.lucid.app/scim/v2/Users

Gets all users on an account.

Query Params

startIndex

number

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

count

number

Quantity of users to return from this request.

filter

string

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.

attributes

array of strings

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

attributes

excludedAttributes

array of strings

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.

excludedAttributes

Responses

400

Bad Request. Occurs if the filter parameter has invalid syntax or uses unsupported operators.

401

Unauthorized. Occurs if bearer token is invalid.

200OK. 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.