Skip to content

List Offers

Endpoint

http
GET /unified/ats/offers
Integrations supported
  • Ashby
  • Greenhouse

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string
By default the `result` attribute is an array of objects. This parameter allows you to specify a field in each `result` objects to use as key, which transforms the `result` array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
Example: id
truto_ignore_limit
boolean
Ignores the `limit` query parameter.
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar
application_id
string
Integration specific notes
  • GreenhouseThe application's unique identifier. If specified, no other query parameters can be used.
  • AshbyThe application's unique identifier.
Supported in
  • Ashby
  • Greenhouse
created_at
string · date-time
The date and time of the offer's creation
Supported in
  • Greenhouse
updated_at
string · date-time
The date and time of the offer's last update
Supported in
  • Greenhouse
start_date
string · date-time
The offer's start date
Supported in
  • Greenhouse
closed_at
string · date-time
The offer's closed date
Supported in
  • Greenhouse
sent_at
string · date-time
The offer's sent date
Supported in
  • Greenhouse

Response Body

result
object[]
List of Offers
id
string
REQUIRED · The offer's unique identifier
Supported in
  • Ashby
  • Greenhouse
application
object
The offer's application
Supported in
  • Ashby
  • Greenhouse
id
string
Unique identifier of the application
candidate
object
The offer's candidate
Supported in
  • Greenhouse
id
string
Unique identifier of the candidate
job
object
The offer's job
Supported in
  • Greenhouse
id
string
Unique identifier of the job
creator
object
The offer's creator
id
string
Unique identifier of the user
closed_at
string · date-time
The offer's closed date
Supported in
  • Ashby
  • Greenhouse
sent_at
string · date-time
The offer's sent date
Supported in
  • Ashby
  • Greenhouse
start_date
string · date-time
The offer's start date
Supported in
  • Ashby
  • Greenhouse
status
string
The offer's status
All possible enum values:
  • draft
  • approval_sent
  • approved
  • sent
  • sent_manually
  • opened
  • denied
  • signed
  • deprecated
Supported in
  • Ashby
  • Greenhouse
created_at
string · date-time
The date and time of the offer's creation
Supported in
  • Ashby
  • Greenhouse
updated_at
string · date-time
The date and time of the offer's last update
Supported in
  • Greenhouse
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.