Skip to main content
GET
Get Offer By Id

Authorizations

Authorization
string
header
required

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

Headers

x-connector-token
string
required

Path Parameters

id
string<uuid>
required

Query Parameters

include_raw_data
boolean
default:false

Include raw data in the response

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

expand
string

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:

"manager[first_name,last_name]"

Response

Successful Response

The AtsOffer object represents a job offer associated with an application within the ATS.

id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

modified_at
string
required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

custom_fields
Custom Fields · object | null
required

The custom fields related to the model

Example:
application
any | null
required

The identifier of the application to which the offer is related.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

creator
any | null
required

The identifier of the user who created the offer.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

remote_created_at
string | null
required

The ISO date string when the offer was created in the third-party system.

Example:

"2021-01-01T00:00:00Z"

closed_at
string | null
required

The ISO date string when the offer was closed.

Example:

"2021-01-01T00:00:00Z"

sent_at
string | null
required

The ISO date string when the offer was sent to the candidate.

Example:

"2021-01-01T00:00:00Z"

start_date
string | null
required

The proposed start date for the candidate, as an ISO date string.

Example:

"2021-01-01T00:00:00Z"

status
enum<string>
required

The current status of the offer. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
DRAFT,
APPROVAL-SENT,
APPROVED,
SENT,
SENT-MANUALLY,
OPENED,
DENIED,
SIGNED,
DEPRECATED
Example:

"APPROVED"

raw_data
Raw Data · object | null

This is the Raw data

Example: