Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Users

Return the data for all Users

Outlines the parameters, optional and required, used when requesting the data for all Users

get/users.json

Query parameters

created_sincestring date-time

Filter User records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

enabledboolean

Filter User records to those that are enabled or disabled.

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter User records to those having the specified unique identifiers.

include_co_counselboolean

Filter User to include co-counsel users

limitinteger

A limit on the number of User records to be returned. Limit can range between 1 and 2000. Default: 2000.

namestring

Filter User records to those with the given name.

order'enabled(asc)' | 'enabled(desc)' | 'id(asc)' | 'id(desc)' | 'name(asc)' | 'name(desc)' | 'first_name(asc)' | 'first_name(desc)' | 'last_name(asc)' | 'last_name(desc)' | 'initials(asc)' | 'initials(desc)' | 'subscription_type(asc)' | 'subscription_type(desc)'

Orders the User records by the given field. Default: id(asc).

page_tokenstring

A token specifying which page to return.

pending_setupboolean

Filter User records based on whether or not they are still being setup.

role'admin' | 'accounts' | 'billing' | 'reports'

Filter User records to those with a specific role.

subscription_type'attorney' | 'nonattorney'

Filter User records to those with a specific subscription type.

updated_sincestring date-time

Filter User records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok