Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
File

file.info

Retrieve the URL for a file referenced by a public API file handle (candidate files, resumes, offer letters, and signature-request files).

Please note that running this with Ashby-generated demo data in an Ashby demo account can result in errors. We would recommend manually creating a test candidate in Ashby when trying out this endpoint.

Requires the candidatesRead permission.

post/file.info

Request body

fileHandlestring required

A file handle retrieved from the public API

Example request

{
  "fileHandle": "eyJoYW5kbGUiOnsidHlwZSI6IkNhbmRpZGF0ZUZpbGUiLCJmaWxlSWQiOiIxNTk1ZTRmYy04MTQwLTQ1NGUtYTI1ZC04NTNiOTQ3ZWNmYzgiLCJvd25lcklkIjoiYmY5NGZlNmMtMjU3MS00NzQ1LWE1OWEtNTA5MjE3ODI3MDVlIn0sInNpZ25hdHVyZSI6IkFqclpjT0VlTXUwdWxLZlRCS05iMWRkbDdHcjVIWFVmZzNrS0NPL1dWWjg9IiwidmVyc2lvbiI6IjEilQ"
}

Response

Responses from the file.info endpoint

OR

Example response

{
  "success": true,
  "results": {
    "url": "https://s3.amazonaws.com/..."
  }
}