Skip to main content
GET
/
api
/
account-member
List Users
curl --request GET \
  --url https://api.hilos.io/api/account-member \
  --header 'Authorization: <api-key>'
[
  {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "id": 123,
    "account": 123,
    "profile_image": "<string>",
    "date_joined": "2023-11-07T05:31:56Z",
    "teams": [
      {
        "id": 123,
        "name": "<string>",
        "assignment_strategy": "<string>"
      }
    ],
    "user_permissions": [
      "<string>"
    ],
    "available_channels": [
      {
        "id": 123,
        "channel_id": "<string>",
        "channel_type": "WHATSAPP",
        "name": "<string>",
        "status": "NEW",
        "created_on": "2023-11-07T05:31:56Z",
        "channel_provider": "META_CLOUD_API",
        "is_sandbox": true
      }
    ],
    "role": "AGENT"
  }
]

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
email__icontains
string
​
email__iendswith
string
​
email__iexact
string
​
email__isnull
boolean
​
email__istartswith
string
​
first_name__icontains
string
​
first_name__iendswith
string
​
first_name__iexact
string
​
first_name__isnull
boolean
​
first_name__istartswith
string
​
last_name__icontains
string
​
last_name__iendswith
string
​
last_name__iexact
string
​
last_name__isnull
boolean
​
last_name__istartswith
string
​
ordering
string

Which field to use when ordering the results.

​
search
string

You can search users with the email, first_name or last_name fields.

Response

200 - application/json
​
first_name
string
required
​
last_name
string
required
​
email
string<email>
required
​
id
integer
required
​
account
integer
required
​
profile_image
string<uri>
required
​
date_joined
string<date-time>
required
​
teams
object[]
​
user_permissions
string[]
​
available_channels
object[]
​
role
enum<string>
Available options:
AGENT,
MANAGER,
ADMIN,
FINANCE