GET
List agents (company)
Company space User accounts only For: Administrator · Permission: agents.list Conditions
  • The caller must be a member (user, client or organization account) of the company space; agent accounts cannot list agent accounts.
Part of Manage agent accounts.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 1000
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
id,
name,
created_at,
updated_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, username, first_name, last_name, type, working_hours, is_active, created_at, updated_at, profile_id, is_direct_seller.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: company, company.organization, client, organization.

Response

Resource.

data
AgentResource · object[]
required

Items of this page.

meta
object
required

Pagination details.