Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

A managed API key, sent as Authorization: Bearer <key>. A workspace key is prefixed tgcc_; a reseller key is prefixed tgpk_. Keys carry scopes; the scope each operation demands is on the operation as x-required-scope.

Query Parameters

status
string

Filter to one status. An unknown value is a 400, not an empty page.

type
string

Filter to one resource type.

limit
integer

Page size. Clamped to the endpoint's maximum rather than refused, except on /conversations/{id}/messages, which answers 400 for a limit above 100.

offset
integer

Row offset. /api/v2/jobs is the one v2 list that pages by offset rather than by cursor; a page taken while jobs are being created can skip or repeat a row.

Response

A page of results.

Cursor paging. Follow the cursor field this endpoint returns — the v2 surface does not yet use one name for it (next_cursor, next, or none at all on /jobs, which pages by offset).

data
object[]
has_more
boolean
object
enum<string>
Available options:
list