GET
/
api
/
ats
/
v1
/
attachments
/
{id}
curl --request GET \
  --url https://api.bindbee.dev/api/ats/v1/attachments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "file_name": "resume.pdf",
  "file_url": "https://example.com/path/to/resume.pdf",
  "attachment_type": "RESUME",
  "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"
  },
  "candidate": "<any>"
}

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
required

Query Parameters

include_raw_data
boolean
default:false

Include raw data in the response

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

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.

Response

200
application/json
Successful Response
id
string
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
object | null
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"
}
file_name
string | null

The name of the file attached.

Example:

"resume.pdf"

file_url
string | null

The URL where the file is stored and can be retrieved.

Required string length: 1 - 2083
Example:

"https://example.com/path/to/resume.pdf"

attachment_type
string | null

The type of attachment, such as 'resume', 'cover letter', etc.

Example:

"RESUME"

raw_data
object | null

This is the Raw data

Example:
{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}
candidate
any | null

The candidate to whom the attachment belongs.