Users
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.
Query parameter attributes
used to filter results based on specific conditions.
Query parameter attributes_kwargs
used to filter results based on specific conditions.
Query parameter call_allowed
used to filter results based on specific conditions.
Query parameter date_joined
used to filter results based on specific conditions.
Query parameter date_of_birth
used to filter results based on specific conditions.
Query parameter email
used to filter results based on specific conditions.
Query parameter email_allowed
used to filter results based on specific conditions.
Query parameter first_name
used to filter results based on specific conditions.
Query parameter gender
used to filter results based on specific conditions.
Query parameter groups
used to filter results based on specific conditions.
Query parameter id
used to filter results based on specific conditions.
Filters records where id
is greater than the given value.
Filters records where id
is greater than or equal to the given value.
Filters records where id
is less than the given value.
Filters records where id
is less than or equal to the given value.
Query parameter is_active
used to filter results based on specific conditions.
Query parameter is_anonymized
used to filter results based on specific conditions.
Query parameter is_staff
used to filter results based on specific conditions.
Query parameter is_superuser
used to filter results based on specific conditions.
Query parameter language_code
used to filter results based on specific conditions.
Query parameter last_login
used to filter results based on specific conditions.
Query parameter last_name
used to filter results based on specific conditions.
Limits the number of results returned in the response.
Query parameter localized_attributes
used to filter results based on specific conditions.
Query parameter localized_attributes_kwargs
used to filter results based on specific conditions.
Query parameter modified_date
used to filter results based on specific conditions.
Filters records where modified_date
is greater than the given value.
Filters records where modified_date
is greater than or equal to the given value.
Filters records where modified_date
is less than the given value.
Filters records where modified_date
is less than or equal to the given value.
Query parameter page
used to filter results based on specific conditions.
Query parameter password
used to filter results based on specific conditions.
Query parameter phone
used to filter results based on specific conditions.
Query parameter sms_allowed
used to filter results based on specific conditions.
Query parameter sort
used to filter results based on specific conditions.
Query parameter user_permissions
used to filter results based on specific conditions.
Query parameter user_type
used to filter results based on specific conditions.
Query parameter username
used to filter results based on specific conditions.
GET /api/v1/remote/1/data-warehouse/users/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
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"
}
]
}
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.
A unique integer value identifying this user.
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?