offers

Search offers

This endpoint can only be used with the credentials created for the user with the Extended or Admin system roles.

get/offers

Request

  • Base URL
    https://api.smartrecruiters.com
  • URL
    https://api.smartrecruiters.com/offers
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: candidates_offers_read

Query parameters

limitinteger

number of elements to return. max value is 100

offsetinteger

number of elements to skip while processing result

createdAfterstring date-time

ISO8601-formatted time boundaries for the offer creation time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ

createdBeforestring date-time

ISO8601-formatted time boundaries for the offer creation time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ

agestring

word-based offer age; when age is specified createdAfter and createdBefore are ignored, Examples: 10 days, 7 hours, 1 week, etc.

statusstring[]

offer states that need to be included in the results; by default all states are included

Response

Offers matching search criteria.

limitinteger
offsetinteger
totalFoundinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.