HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

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
  • last_login - Ascending by user last login
  • -last_login - Descending by user last login
  • ts_created - Ascending by user profile creation time
  • -ts_created - Descending by user profile creation time
string

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

string

Filter by exact User last login time. The filter value should be in "YYYY-MM-DD HH:MM[:ss[.uuuuuu]]" format and its timezone will be defaulted to UTC. Multiple last login timestamps can be specified using the format "?last_login=2022-12-05 07:40:08.023453&last_login=2022-12-06 07:40:08.023453". When multiple last login timestamps are provided in the filter, all the user profiles whose last login timestamps exactly match would be returned. The last login times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose last login date is less than the filter value. The filter value should be in "YYYY-MM-DD" format. For example: "?last_login__date__lt=2022-11-23". Range searches on the last login date can be achieved by combining multiple last login date filters. For example: "?last_login__date__gt=2022-11-22&last_login__date__lt=2022-11-23". The last login times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose last login date is greater than the filter value. The filter value should be in "YYYY-MM-DD" format. For example: "?last_login__date__gt=2022-11-23". Range searches on the last login date can be achieved by combining multiple last login date filters. For example: "?last_login__date__gt=2022-11-22&last_login__date__lt=2022-11-23". The last login times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose last login date is less than or equal to the filter value. The filter value should be in "YYYY-MM-DD" format. For example: "?last_login__date__lte=2022-11-23". Range searches on the last login date can be achieved by combining multiple last login date filters. For example: "?last_login__date__gte=2022-11-22&last_login__date__lte=2022-11-23". The last login times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose last login date is greater than or equal to the filter value. The filter value should be in "YYYY-MM-DD" format. For example: "?last_login__date__gte=2022-11-23". Range searches on the last login date can be achieved by combining multiple last login date filters. For example: "?last_login__date__gte=2022-11-22&last_login__date__lte=2022-11-23". The last login times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose last login time is less than the filter value. The filter value should be in "YYYY-MM-DD HH:MM[:ss[.uuuuuu]]" format and its timezone will be defaulted to UTC. For example: "?last_login__lt=2022-11-23 07:40:08.023453". Range searches on the last login time can be achieved by combining multiple last login datetime filters. For example: "?last_login__gt=2022-11-22 07:40:08.023453&last_login__lt=2022-11-23 07:40:08.023453". The last login times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose last login time is greater than the filter value. The filter value should be in "YYYY-MM-DD HH:MM[:ss[.uuuuuu]]" format and its timezone will be defaulted to UTC. For example: "?last_login__gt=2022-11-23 07:40:08.023453". Range searches on the last login time can be achieved by combining multiple last login datetime filters. For example: "?last_login__gt=2022-11-22 07:40:08.023453&last_login__lt=2022-11-23 07:40:08.023453". The last login times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose last login time is less than or equal to the filter value. The filter value should be in "YYYY-MM-DD HH:MM[:ss[.uuuuuu]]" format and its timezone will be defaulted to UTC. For example: "?last_login__lte=2022-11-23 07:40:08.023453". Range searches on the last login time can be achieved by combining multiple last login datetime filters. For example: "?last_login__gte=2022-11-22 07:40:08.023453&last_login__lte=2022-11-23 07:40:08.023453". The last login times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose last login time is greater than or equal to the filter value. The filter value should be in "YYYY-MM-DD HH:MM[:ss[.uuuuuu]]" format and its timezone will be defaulted to UTC. For example: "?last_login__gte=2022-11-23 07:40:08.023453". Range searches on the last login time can be achieved by combining multiple last login datetime filters. For example: "?last_login__gte=2022-11-22 07:40:08.023453&last_login__lte=2022-11-23 07:40:08.023453". The last login times of the user profiles returned in the API response are in UTC timezone.

string

Filter by exact User profile creation time. The filter value should be in "YYYY-MM-DD HH:MM[:ss[.uuuuuu]]" format and its timezone will be defaulted to UTC. Multiple profile creation timestamps can be specified using the format "?ts_created=2022-12-05 07:40:08.023453&ts_created=2022-12-06 07:40:08.023453". When multiple profile creation timestamps are provided in the filter, all the user profiles whose profile creation timestamps exactly match would be returned. The profile creation times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose profile creation date is less than the filter value. The filter value should be in "YYYY-MM-DD" format. For example: "?ts_created__date__lt=2022-11-23". Range searches on the profile creation date can be achieved by combining multiple profile creation date filters. For example: "?ts_created__date__gt=2022-11-22&ts_created__date__lt=2022-11-23". The profile creation times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose profile creation date is greater than the filter value. The filter value should be in "YYYY-MM-DD" format. For example: "?ts_created__date__gt=2022-11-23". Range searches on the profile creation date can be achieved by combining multiple profile creation date filters. For example: "?ts_created__date__gt=2022-11-22&ts_created__date__lt=2022-11-23". The profile creation times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose profile creation date is less than or equal to the filter value. The filter value should be in "YYYY-MM-DD" format. For example: "?ts_created__date__lte=2022-11-23". Range searches on the profile creation date can be achieved by combining multiple profile creation date filters. For example: "?ts_created__date__gte=2022-11-22&ts_created__date__lte=2022-11-23". The profile creation times of the user profiles returned in the API response are in UTC timezone.

string

Filters all the users whose profile creation date is greater than or equal to the filter value. The filter value should be in "YYYY-MM-DD" format. For example: "?ts_created__date__gte=2022-11-23". Range searches on the profile creation date can be achieved by combining multiple profile creation date filters. For example: "?ts_created__date__gte=2022-11-22&ts_created__date__lte=2022-11-23". The profile creation times of the user profiles returned in the API response are in UTC timezone.

string

Filter all the users whose profile creation time is less than the filter value. The filter value should be in "YYYY-MM-DD HH:MM[:ss[.uuuuuu]]" format and its timezone will be defaulted to UTC. For example: "?ts_created__lt=2022-11-23 07:40:08.023453". Range searches on the profile creation time can be achieved by combining multiple profile creation datetime filters. For example: "?ts_created__gt=2022-11-22 07:40:08.023453&ts_created__lt=2022-11-23 07:40:08.023453". The profile creation times of the user profiles returned in the API response are in UTC timezone.

string

Filter all the users whose profile creation time is greater than the filter value. The filter value should be in "YYYY-MM-DD HH:MM[:ss[.uuuuuu]]" format and its timezone will be defaulted to UTC. For example: "?ts_created__gt=2022-11-23 07:40:08.023453". Range searches on the profile creation time can be achieved by combining multiple profile creation datetime filters. For example: "?ts_created__gt=2022-11-22 07:40:08.023453&ts_created__lt=2022-11-23 07:40:08.023453". The profile creation times of the user profiles returned in the API response are in UTC timezone.

string

Filter all the users whose profile creation time is less than or equal to the filter value. The filter value should be in "YYYY-MM-DD HH:MM[:ss[.uuuuuu]]" format and its timezone will be defaulted to UTC. For example: "?ts_created__lte=2022-11-23 07:40:08.023453". Range searches on the profile creation time can be achieved by combining multiple profile creation datetime filters. For example: "?ts_created__gte=2022-11-22 07:40:08.023453&ts_created__lte=2022-11-23 07:40:08.023453". The profile creation times of the user profiles returned in the API response are in UTC timezone.

string

Filter all the users whose profile creation time is greater than or equal to the filter value. The filter value should be in "YYYY-MM-DD HH:MM[:ss[.uuuuuu]]" format and its timezone will be defaulted to UTC. For example: "?ts_created__gte=2022-11-23 07:40:08.023453". Range searches on the profile creation time can be achieved by combining multiple profile creation datetime filters. For example: "?ts_created__gte=2022-11-22 07:40:08.023453&ts_created__lte=2022-11-23 07:40:08.023453". The profile creation times of the user profiles returned in the API response are in UTC timezone.

Responses

Language
Credentials
URL
Choose an example:
application/json