Appearance

Download Attachments ​

Endpoint ​

http
POST /unified/ats/attachments/download
Integrations supported
  • ApplicantStack
  • Ashby
  • BambooHR
  • Breezy
  • CATS
  • Fountain
  • Greenhouse
  • Homerun
  • JobScore
  • Jobvite
  • Lever
  • Loxo
  • Recruitee
  • Recruiterflow
  • SmartRecruiters
  • Teamtailor
  • Workable
  • Zoho Recruit

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
file_url
string

The attachment's file_url

Required in
  • ApplicantStack
  • Ashby
  • BambooHR
  • Breezy
  • CATS
  • Fountain
  • Greenhouse
  • Homerun
  • JobScore
  • Jobvite
  • Lever
  • Recruitee
  • Recruiterflow
  • SmartRecruiters
  • Teamtailor
  • Workable
  • Zoho Recruit
candidate_id
string

Unique identifier of the candidate

Required in
  • Loxo
attachment_id
string

The attachment's unique identifier

Required in
  • Loxo

Request Body ​

Refer Writing data using Unified APIs

remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The attachment's unique identifier

file_name
string

The attachment's file_name

file_url
string

The attachment's file_url

candidate
object

The attachment's candidate

id
string

Unique identifier of the candidate

application
object

The attachment's application

id
string

Unique identifier of the application

job
object

The attachment's job

id
string

Unique identifier of the job

attachment_type
string

The attachment's type

All possible enum values:
  • resume
  • cover_letter
  • other
created_at
string · date-time

The date and time of the attachment's creation

updated_at
string · date-time

The date and time of the attachment's last update

remote_data
object

Raw data returned from the remote API call.