Skip to main content
POST
Search automations

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
offset
integer | null
default:0

Records to skip for pagination. Defaults to 0.

Required range: x >= 0
limit
integer
default:100

Max records per page (1–100). Defaults to 100.

Required range: 1 <= x <= 100
keywords
string[]

Case-insensitive substring match on the automation name.

is_enabled
boolean

Filter by whether the automation is enabled.

is_archived
boolean
default:false

Filter by archive status. Defaults to false so archived automations are hidden.

trigger_type
enum<string>

Filter by trigger kind.

Available options:
schedule,
candidate_status_changed,
job_status_changed,
job_created,
deal_status_changed
sort_by
enum<string>
default:created_at

Column to sort by. Defaults to created_at.

Available options:
created_at,
updated_at,
name
sort_order
enum<string>
default:desc

Sort direction. Defaults to desc.

Available options:
asc,
desc

Response

Automations found

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object
required