Get Work Agent

GET

/work/agents/{agent_id}

• Production
• QA

One Work agent. 403 when it is another person’s private agent.

Authorizations

• BearerAuth

Parameters

Path Parameters

agent_id

required

Agent id

string format: uuid

Agent id

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

One Work agent profile as the caller may see it.

object

agent_id

Any of:

string

string

null

null

avatar

Any of:

string

string

null

null

can_edit

Any of:

boolean

boolean

null

null

description

Any of:

string

string

null

null

name

Any of:

string

string

null

null

owner_id

Any of:

string

string

null

null

role

Any of:

string

string

null

null

updated_at

Any of:

string

string

null

null

version

Any of:

integer

integer

null

null

visibility

Any of:

string

string

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string