HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference
These docs are for v2023.3.5. Click to read the latest docs for v2024.3.5.

GET multiple Users

This API is used to list all Users.

Query Params
string

Filter by an exact match on display_name

string

Filter by a case-sensitive substring on display_name

string

Filter by a case-insensitive substring on display_name

string

Filter by an exact match on email

string

Filter by a case-sensitive substring on email

string

Filter by a case-insensitive substring on email

integer
≥ 1

Filter by User ID. Multiple IDs can be specified using the format ?id=1&id=2.

integer
≥ 1
Defaults to 100

The number of items to return.

integer
≥ 1

Filter by User Profile ID. Multiple IDs can be specified using the format ?profile_id=1&profile_id=2.

integer
Defaults to 0

The number of items to skip.

string

Sort by a specified property:

  • display_name - A to Z, by display_name
  • -display_name - Z to A, by display_name
  • email - A to Z, by email
  • -email - Z to A, by email
  • id - Ascending by id
  • -id - Descending by id
  • profile_id - Ascending by id
  • -profile_id - Descending by id
string

A comma-separated sub-set of properties to select for each item.

Responses

Language
Credentials
URL
Choose an example:
application/json