BIbindbee
Job

Get Jobs

Changed on

Returns a list of Job objects.

get/api/ats/v1/jobs

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Query parameters

idsstring nullable

The ID of the jobs to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a
remote_idstring nullable

The third-party API ID of the matching object.

Example:3235005483341316245
codestring nullable

If provided, will return jobs with this code

Example:DEV-01
statusstring nullable

If provided, will return jobs with this status. Along with the standard values, any connector specific value returned in the response can be passed as well. Pass several values, comma-separated, to match any of them.

Example:OPEN
officesstring nullable

If provided, will return jobs in these offices

Example:0194bcb7-bf3e-7315-8628-0dc9bf1b6d92,0194bcb7-bf3e-7315-8628-0dc9bf1b6d92
include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

page_sizeinteger

Number of results to return per page. Maximum size is 200.

cursorstring nullable

The pagination cursor value.

modified_afterstring nullable

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z
expandstring nullable

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. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

The page size the request was served with (0 on an empty page). items can be shorter on the last page; cursor says whether another page exists.

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "name": "SOFTWARE ENGINEER",
      "description": "We are looking for a software engineer to join our team.",
      "code": "SE-2021-01",
      "status": "OPEN",
      "remote_created_at": "2021-01-01T00:00:00Z",
      "remote_updated_at": "2021-01-01T00:00:00Z"
    }
  ]
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the - enum value from the ///// response property for the response status

    • info

      removed the - enum value from the // response property for the response status

    • info

      removed the ARCHIVED enum value from the // response property for the response status

    • info

      removed the BLOG enum value from the ///// response property for the response status

    • info

      removed the CLOSED enum value from the // response property for the response status

    • info

      removed the COMPANY enum value from the ///// response property for the response status

    • info

      removed the DRAFT enum value from the // response property for the response status

    • info

      removed the JOB_POSTING enum value from the ///// response property for the response status

    • info

      removed the OPEN enum value from the // response property for the response status

    • info

      removed the OTHER enum value from the ///// response property for the response status

    • info

      removed the PENDING enum value from the // response property for the response status

    • info

      removed the PERSONAL enum value from the ///// response property for the response status

    • info

      removed the PORTFOLIO enum value from the ///// response property for the response status

    • info

      removed the SOCIAL_MEDIA enum value from the ///// response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API