Appearance

List Attachments ​

Endpoint ​

http
GET /unified/ats/attachments
Integrations supported
  • Ashby
  • Breezy
  • Fountain
  • Greenhouse
  • JobScore
  • Lever
  • 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_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
candidate_id
string
Integration specific notes
  • FountainThe ID of the application to filter the attachments by.
  • JobScoreThe ID of the candidate to filter the attachments by.
  • GreenhouseThe ID of the candidate to filter the attachments by.
  • BreezyThe ID of the candidate to filter the attachments by.
  • LeverThe ID of the candidate to filter the attachments by.
  • Zoho RecruitThe ID of the candidate to filter the attachments by.
  • AshbyThe ID of the candidate to filter the attachments by.
Required in
  • Ashby
  • Breezy
  • Fountain
  • JobScore
  • Lever
Supported in
  • Greenhouse
  • Zoho Recruit
expires_in
string

The number of seconds until the attachment expires.

Supported in
  • Fountain
application_id
string

The ID of the application to filter the attachments by.

Supported in
  • Greenhouse
  • Zoho Recruit
organization_id
string

The ID of the organization to filter the attachments by.

Supported in
  • Breezy
job_id
string

The ID of the job to filter the activities by.

Required in
  • Breezy

Response Body ​

result
object[]

List of Attachments

id
string
REQUIRED · 

The attachment's unique identifier

Supported in
  • Ashby
  • Breezy
  • Fountain
  • Greenhouse
  • JobScore
  • Lever
  • Zoho Recruit
file_name
string

The attachment's file_name

Supported in
  • Ashby
  • Breezy
  • Fountain
  • Greenhouse
  • JobScore
  • Lever
  • Zoho Recruit
file_url
string

The attachment's file_url

Supported in
  • Ashby
  • Breezy
  • Fountain
  • Greenhouse
  • JobScore
  • Lever
  • Zoho Recruit
candidate
object

The attachment's candidate

Supported in
  • Ashby
  • Breezy
  • Fountain
  • Greenhouse
  • Lever
  • Zoho Recruit
id
string

Unique identifier of the candidate

application
object

The attachment's application

Supported in
  • Greenhouse
  • JobScore
  • Zoho Recruit
id
string

Unique identifier of the application

job
object

The attachment's job

Supported in
  • Greenhouse
  • JobScore
id
string

Unique identifier of the job

attachment_type
string

The attachment's type

All possible enum values:
  • resume
  • cover_letter
  • other
Supported in
  • Ashby
  • Greenhouse
  • JobScore
  • Lever
  • Zoho Recruit
created_at
string · date-time

The date and time of the attachment's creation

Supported in
  • Breezy
  • JobScore
  • Lever
  • Zoho Recruit
updated_at
string · date-time

The date and time of the attachment's last update

Supported in
  • JobScore
  • Zoho Recruit
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.