Skip to main content
POST
Search Parent Agent Types

Authorizations

Authorization
string
header
required

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

Body

application/json
limit
integer
default:100

Maximum number of records to return.

Required range: 1 <= x <= 250
offset
integer
default:0

Number of records to skip before returning results.

Required range: x >= 0
search_value
string | null

Optional search text used to filter results.

filters
(FilterParam · object | FilterOrGroup · object)[]

Additional filters applied to the list query.

Example:
sort
SortParam · object | null

Optional sort definition.

tenant
string | null

Tenant scope for agent types. Defaults to the authenticated tenant and includes system rows.

Response

Successful Response

success
boolean
required

Whether the request was successful.

data
ParentAgentTypeSearchData · object
required

Parent agent type search results.

error_type
string | null

Type of error if the request failed.

error_message
string | null

Error message or informational message.