APIHub
Back to Explore

ATS API

The ATS API allows you to list, retrieve, and create applicant records and to list and retrieve job postings.

Development
apiKeyHeader
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

467ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/ats/applicants

List applicants

  • raw (query) — Include raw response. Mostly used for debugging purposes
  • x-apideck-consumer-id (header, required) — ID of the consumer which you want to get or push data from
  • x-apideck-app-id (header, required) — The ID of your Unify application
  • x-apideck-service-id (header) — Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
  • cursor (query) — Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
  • limit (query, limit) — Number of results to return. Minimum 1, Maximum 200, Default 20
  • filter (query) — Apply filters
  • fields (query) — The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
POST

/ats/applicants

Create applicant

  • raw (query) — Include raw response. Mostly used for debugging purposes
  • x-apideck-consumer-id (header, required) — ID of the consumer which you want to get or push data from
  • x-apideck-app-id (header, required) — The ID of your Unify application
  • x-apideck-service-id (header) — Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
GET

/ats/applicants/{id}

Get applicant

  • id (path, required) — ID of the record you are acting upon.
  • x-apideck-consumer-id (header, required) — ID of the consumer which you want to get or push data from
  • x-apideck-app-id (header, required) — The ID of your Unify application
  • x-apideck-service-id (header) — Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
  • raw (query) — Include raw response. Mostly used for debugging purposes
  • fields (query) — The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
GET

/ats/jobs

List Jobs

  • raw (query) — Include raw response. Mostly used for debugging purposes
  • x-apideck-consumer-id (header, required) — ID of the consumer which you want to get or push data from
  • x-apideck-app-id (header, required) — The ID of your Unify application
  • x-apideck-service-id (header) — Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
  • cursor (query) — Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
  • limit (query, limit) — Number of results to return. Minimum 1, Maximum 200, Default 20
  • fields (query) — The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
GET

/ats/jobs/{id}

Get Job

  • id (path, required) — ID of the record you are acting upon.
  • x-apideck-consumer-id (header, required) — ID of the consumer which you want to get or push data from
  • x-apideck-app-id (header, required) — The ID of your Unify application
  • x-apideck-service-id (header) — Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
  • raw (query) — Include raw response. Mostly used for debugging purposes
  • fields (query) — The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

5 endpoints auto-detected

Authentication

This API uses an API key, passed in the "Authorization" header. No OAuth required.

curl -X GET \
  "https://unify.apideck.com/ats/applicants" \
  -H "Authorization: YOUR_API_KEY"

unify.apideck.com · HTTPS only