Get Tag By Id

Returns a Tag object with the given id.

GET /api/ats/v1/tags/{id}

Get Tag By Id

cURL

curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/tags/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "<string>",
  "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": "JUNIOR",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

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

Response

200

application/json

Successful Response

The AtsTag object represents a tag that can be applied to candidates, jobs, or other entities 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 · required

The custom fields related to the model

Example:

{
  "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 · string | null · required

The name of the tag.

Example:

"JUNIOR"

raw_data · Raw Data · object

This is the Raw data

Example:

{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}