List Agents in Account - Tied

GET

/

api

/

v1

/

accounts

/

{account_id}

/

agents

List Agents in Account

curl --request GET \
  --url https://app.tied.com/api/v1/accounts/{account_id}/agents \
  --header 'api_access_token: <api-key>'

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

fetch('https://app.tied.com/api/v1/accounts/{account_id}/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/agents")

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

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

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

package main

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

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/agents"

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

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

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

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

	fmt.Println(string(body))

}

[
  {
    "id": 1,
    "account_id": 1,
    "availability_status": "offline",
    "auto_offline": true,
    "confirmed": true,
    "email": "you@example.com",
    "provider": "email",
    "available_name": "Alex Rivera",
    "name": "Alex Rivera",
    "role": "administrator",
    "thumbnail": "/dashboard/images/default-contact-avatars/031.svg",
    "avatar_url": "",
    "illustration_avatar": true,
    "accent_color": null,
    "custom_role_id": null
  }
]

{
  "error": "Resource could not be found"
}

Authorizations

api_access_token

string

header

required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id

integer

required

The numeric ID of the account

Response

Success

id

integer

The agent's numeric ID.

account_id

integer

The account the agent belongs to.

availability_status

enum<string>

The availability status of the agent computed by Tied.

Available options:

available,

busy,

offline

auto_offline

boolean

Whether the availability status of agent is configured to go offline automatically when away.

confirmed

boolean

Whether the agent has confirmed their email address.

email

string

The email of the agent

available_name

string

The available name of the agent

name

string

The name of the agent

role

enum<string>

The role of the agent

Available options:

agent,

administrator

thumbnail

string

The thumbnail of the agent

custom_role_id

integer | null

The custom role id of the agent

provider

string

How the agent signs in — email for a password login.

avatar_url

string

URL of an uploaded avatar. Empty when the agent has not uploaded one.

illustration_avatar

boolean

Whether thumbnail is one of the generated illustration avatars rather than an upload.

accent_color

string | null

The agent's chosen dashboard accent colour.

List Agents in Account

curl --request GET \
  --url https://app.tied.com/api/v1/accounts/{account_id}/agents \
  --header 'api_access_token: <api-key>'

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

fetch('https://app.tied.com/api/v1/accounts/{account_id}/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/agents")

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

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

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

package main

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

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/agents"

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

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

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

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

	fmt.Println(string(body))

}

[
  {
    "id": 1,
    "account_id": 1,
    "availability_status": "offline",
    "auto_offline": true,
    "confirmed": true,
    "email": "you@example.com",
    "provider": "email",
    "available_name": "Alex Rivera",
    "name": "Alex Rivera",
    "role": "administrator",
    "thumbnail": "/dashboard/images/default-contact-avatars/031.svg",
    "avatar_url": "",
    "illustration_avatar": true,
    "accent_color": null,
    "custom_role_id": null
  }
]

{
  "error": "Resource could not be found"
}