Users

get

This method gets user profile details including username, email and various status or preferences indicators such as if the user is active, staff, superuser, or verified.

Authorizations
Query parameters
attributesanyOptional

Query parameter attributes used to filter results based on specific conditions.

attributes_kwargsanyOptional

Query parameter attributes_kwargs used to filter results based on specific conditions.

call_allowedbooleanOptional

Query parameter call_allowed used to filter results based on specific conditions.

date_joinedstring · date-timeOptional

Query parameter date_joined used to filter results based on specific conditions.

date_of_birthstring · dateOptional

Query parameter date_of_birth used to filter results based on specific conditions.

emailstringOptional

Query parameter email used to filter results based on specific conditions.

email_allowedbooleanOptional

Query parameter email_allowed used to filter results based on specific conditions.

first_namestringOptional

Query parameter first_name used to filter results based on specific conditions.

genderstringOptional

Query parameter gender used to filter results based on specific conditions.

groupsinteger[]Optional

Query parameter groups used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

is_activebooleanOptional

Query parameter is_active used to filter results based on specific conditions.

is_anonymizedbooleanOptional

Query parameter is_anonymized used to filter results based on specific conditions.

is_staffbooleanOptional

Query parameter is_staff used to filter results based on specific conditions.

is_superuserbooleanOptional

Query parameter is_superuser used to filter results based on specific conditions.

language_codestringOptional

Query parameter language_code used to filter results based on specific conditions.

last_loginstring · date-timeOptional

Query parameter last_login used to filter results based on specific conditions.

last_namestringOptional

Query parameter last_name used to filter results based on specific conditions.

limitintegerOptional

Limits the number of results returned in the response.

localized_attributesanyOptional

Query parameter localized_attributes used to filter results based on specific conditions.

localized_attributes_kwargsanyOptional

Query parameter localized_attributes_kwargs used to filter results based on specific conditions.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

passwordstringOptional

Query parameter password used to filter results based on specific conditions.

phonestringOptional

Query parameter phone used to filter results based on specific conditions.

sms_allowedbooleanOptional

Query parameter sms_allowed used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

user_permissionsinteger[]Optional

Query parameter user_permissions used to filter results based on specific conditions.

user_typestringOptional

Query parameter user_type used to filter results based on specific conditions.

usernamestringOptional

Query parameter username used to filter results based on specific conditions.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/users/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "attributes": "text",
      "attributes_kwargs": "text",
      "avatar": "text",
      "call_allowed": "text",
      "date_joined": "text",
      "date_of_birth": "text",
      "email": "[email protected]",
      "email_allowed": "text",
      "first_name": "text",
      "gender": "text",
      "groups": "text",
      "id": "text",
      "is_active": "text",
      "is_anonymized": "text",
      "is_staff": "text",
      "is_superuser": "text",
      "language_code": "text",
      "last_login": "text",
      "last_name": "text",
      "localized_attributes": "text",
      "localized_attributes_kwargs": "text",
      "modified_date": "text",
      "phone": "text",
      "pk": 1,
      "sms_allowed": "text",
      "user_permissions": "text",
      "user_type": "text",
      "username": "text"
    }
  ]
}
get

This method gets user profile details including username, email and various status or preferences indicators such as if the user is active, staff, superuser, or verified. This endpoint retrieves a specific record by its unique identifier.

Authorizations
Path parameters
idintegerRequired

A unique integer value identifying this user.

Responses
200
Successful response for status code 200.
application/json
get
GET /api/v1/remote/1/data-warehouse/users/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "attributes": "text",
  "attributes_kwargs": "text",
  "avatar": "text",
  "call_allowed": "text",
  "date_joined": "text",
  "date_of_birth": "text",
  "email": "[email protected]",
  "email_allowed": "text",
  "first_name": "text",
  "gender": "text",
  "groups": "text",
  "id": "text",
  "is_active": "text",
  "is_anonymized": "text",
  "is_staff": "text",
  "is_superuser": "text",
  "language_code": "text",
  "last_login": "text",
  "last_name": "text",
  "localized_attributes": "text",
  "localized_attributes_kwargs": "text",
  "modified_date": "text",
  "phone": "text",
  "pk": 1,
  "sms_allowed": "text",
  "user_permissions": "text",
  "user_type": "text",
  "username": "text"
}

Was this helpful?