Skip to main content
GET
Get Attachment By Id

Authorizations

Authorization
string
header
default:<BINDBEE_API_KEY>
required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token
string
header
default:<CONNECTOR_TOKEN>
required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

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

expand
string | null

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.

Example:

"manager[first_name,last_name]"

Response

Successful Response

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<date-time>
required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

custom_fields
Custom Fields · object | null
required

The custom fields related to the model

Example:
file_name
string | null

The name of the file attached.

Example:

"resume.pdf"

attachment_type
string | null

The type of attachment. If the value is not one of the defined enum values, the original value passed through will be returned.

Example:

"RESUME"

raw_data
Raw Data · object | null

This is the Raw data

Example:
file_url
string | null

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

Example:

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

candidate
any | null

The candidate to whom the attachment belongs.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"