Skip to main content
GET
/
company
/
documents
Get Company Documents
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/company/documents \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": 123,
    "name": "Weekly Payroll",
    "file_name": "Weekly_Payroll_2023",
    "location": "https://schedulehead-files.nyc3.digitaloceanspaces.com/Weekly_Payroll_2023.pdf",
    "date_added": "Dec 12th",
    "type": "application/pdf",
    "deleted": 0,
    "date_deleted": null
  },
  {
    "id": 321,
    "name": "Company Logo",
    "file_name": "company_logo",
    "location": "https://schedulehead-files.nyc3.digitaloceanspaces.com/company_logo.png",
    "date_added": "Dec 15th",
    "type": "image/png",
    "deleted": 0,
    "date_deleted": null
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.roostedhr.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Response

OK

​
id
integer

Unique document identifier

​
name
string

Display name of the document

​
file_name
string

Original file name

​
location
string

URL to the stored document file

​
date_added
string

Date the document was uploaded

​
type
string

MIME type of the document (e.g. application/pdf, image/png)

​
deleted
integer

Soft-delete flag (0 = active, 1 = deleted)

​
date_deleted
string<date-time> | null

Timestamp when the document was soft-deleted, or null if active