Skip to content
Tallyraydocs

AI clients granted in the workspace: your own; every one for its owner and staff under support access. Ended ones with include_ended

GET
/v1/buyer/ai-clients
curl --request GET \
  --url https://example.com/v1/buyer/ai-clients \
  --header 'Authorization: Bearer <token>'

Who: a workspace’s buyer or viewer, or staff under its support access. Not for API keys.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

user_id
string
include_ended
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
client
required
object
host
required
string
id
required
string
name
required
string
redirect_host
required
string
created_at
required
string format: date-time
effective_scopes
required
Array<string>
end_reason
required
string | null
Allowed values: revoked client_revoked membership_removed workspace_ended refresh_reused expired
ended_at
required
string | null format: date-time
ended_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
expires_at
required
string format: date-time
id
required
string
last_used_at
required
string | null format: date-time
scopes
required
Array<string>
user_id
required
string
user_name
string
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example 

{
  "data": [
    {
      "end_reason": "revoked",
      "ended_by": {
        "kind": "user"
      }
    }
  ]
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}