Skip to content
API Reference
/Files/
Get a file by ID

Onboarded Public API (0.0.1)

Public API for Customers, Partners, and Integrations

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.onboarded.com/_mock/openapi
Onboarded Production Server
https://app.onboarded.com

Clients

API for managing clients

Operations

Components

API for creating embeddable component URLs

Operations

Connected Organizations

API for managing connected organizations and their configuration

Operations

Employees

API for managing employees

Operations

Employers

API for managing employers

Operations

Files

API for accessing uploaded files

Operations

Get a file by ID

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
file_idstring(FileId)required

File Identifier

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/files/{file_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

FileResponse

Bodyapplication/json
urlstringrequired

Signed URL to the file, expires in 5 minutes

Response
application/json
{
  "url": "string"
}

Forms

API for accessing forms

Operations

Tasks

API for managing tasks

Operations

Jobs

API for managing jobs

Operations

Placements

API for managing placements

Operations

Themes

API for managing themes

Operations

Custom Properties

API for managing custom properties

Operations

Subtasks

Subtask management and file upload API

Operations

Task Change Requests

API for requesting changes to completed tasks

Operations

Users

API for managing users

Operations

Webhooks

API for managing webhooks

Operations