Skip to main content
GET
/
clients
/
{id}
/
documents
Get Client Documents
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/documents \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": 123,
    "name": "<string>",
    "file_name": "<string>",
    "date_added": "<string>",
    "type": "<string>",
    "location": "<string>",
    "deleted": 123,
    "date_deleted": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Client ID

Response

OK

​
id
integer

Unique document identifier.

​
name
string

Document display name.

​
file_name
string

Original uploaded file name.

​
date_added
string

Datetime when the document was uploaded.

​
type
string

Document MIME type or file extension.

​
location
string

URL to the stored document file.

​
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.