API Reference
Status PageAUDD DigitalAUDD Digital Knowledge BaseSubmit a Ticket

Get list of users

get
https://api.sandbox.audd.digital/users

Returns a paginated list of the users in your company. The list is scoped to your own company automatically, so it never contains users belonging to anyone else. Deleted users are not listed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Zero-based index of the page to return.

string

Sort direction. Any other value is rejected.

string

Free-text search, case-insensitive and matching anywhere in the value. Covers the user's email, first name, last name, id and phone number, and the name of the company they belong to. An empty value matches everything.

string

Number of items returned per page. A value below 1 is rejected with a 500.

string

Attribute to sort by, given as the underlying record's field name, for example email or dateCreated. An unrecognised field is rejected with a 500.

Headers
string
required

Bearer JWT obtained from POST /mfa/login. Send as "Bearer ". Expires after 5 minutes.

Responses

400

Invalid input. Returned when a query parameter cannot be parsed, for example a direction other than ASC or DESC, or a non-numeric limit or index. Also returned by the gateway when the Authorization header is absent.

401

Unauthorized. The bearer token is missing, expired or invalid. The response body is empty.

404

Not found

500

Internal server error. Also returned for a limit below 1 or an unrecognised sortBy field.

Updated 10 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago

Did this page help you?