RErecruitwithatlas
Files

List files

Changed on

Use this endpoint to retrieve a paginated list of files that belong to your Atlas account.

Each file includes its ID, type (e.g. resume), original filename, MIME type, size in bytes, the source it was created from, and the date it was uploaded. Use the returned file ID with other endpoints — for example, when creating an applicant on a project.

Filtering: Use type and source to filter by file type and origin. Use personId to return only files linked to a single person, and companyId to return only files linked to a single company. All filters are combined with AND, and a valid ID with no matching files returns an empty list.

Files whose upload never completed are never returned — everything listed here can be downloaded.

Pagination: Results are returned in pages. The response includes a pagination object with the current page, page size, total number of files, and total number of pages. Use the page and pageSize query parameters to navigate through results.

This endpoint does not return a download URL — use GET /api/v1/files/{id}/download to obtain a short-lived presigned URL for a specific file.

get/api/v1/files

Request

Query parameters

type'resume' | 'passport' | 'rightToWork' | 'insurance' | 'brandedResume' | 'incorporation' | 'other'

Filter by file type

Example:resume
source'branded_report' | 'contract_document' | 'project_document' | 'company_document' | 'email_attachment' | 'manual_upload' | 'manual_upload_outbound' | 'manual_upload_campaign' | 'manual_upload_meeting' | 'manual_upload_resume' | 'manual_upload_editor' | 'manual_upload_company_file' | 'manual_upload_project_file' | 'manual_upload_person_file' | 'manual_upload_contract_document' | 'manual_upload_project_document' | 'manual_upload_company_document' | 'bulk_upload' | 'application' | 'applicant_form' | 'manual_upload_applicant' | 'api' | 'idibu' | 'broadbean' | 'logic_melon'

Filter by file source

Example:api
personIdstring uuid

Filter to files linked to a single person

Example:550e8400-e29b-41d4-a716-446655440000
companyIdstring uuid

Filter to files linked to a single company

Example:550e8400-e29b-41d4-a716-446655440000
pageinteger

Page number (1-indexed)

Example:1
pageSizeinteger

Items per page (max 100)

Example:25
perPageinteger

Alias for pageSize

Response

Paginated list of files

status'ok' required

Example response

{
  "data": [
    {
      "type": "resume",
      "filename": "resume.pdf",
      "mime_type": "application/pdf",
      "size": 245832,
      "source": "api"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 100,
    "total": 10,
    "totalPages": 1
  }
}

Changes