List all account members - Hilos Docs

List Users

curl --request GET \
  --url https://api.hilos.io/api/account-member \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hilos.io/api/account-member', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hilos.io/api/account-member",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hilos.io/api/account-member"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hilos.io/api/account-member")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "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"
  }
]

GET

/

api

/

account-member

List Users

curl --request GET \
  --url https://api.hilos.io/api/account-member \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hilos.io/api/account-member', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hilos.io/api/account-member",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hilos.io/api/account-member"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hilos.io/api/account-member")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "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

read-only

last_name

string

required

read-only

email

string<email>

required

read-only

id

integer

required

account

integer

required

read-only

profile_image

string<uri>

required

read-only

date_joined

string<date-time>

required

read-only

teams

object[]

Show child attributes

user_permissions

string[]

available_channels

object[]

Show child attributes

role

enum<string>

Available options:

AGENT,

MANAGER,

ADMIN,

FINANCE