Skip to main content
GET
/
clients
/
{id}
/
custom-fields
Get Client Custom Fields with Values
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/custom-fields \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "value": "<string>",
    "field_type": "<string>",
    "options": [
      {
        "title": "<string>",
        "value": "<string>"
      }
    ]
  }
]

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

Path Parameters

​
id
string
required

Client ID

Response

OK

​
id
string

Custom field definition ID.

​
name
string

Custom field name.

​
value
string | null

The value set for this client.

​
field_type
string

Field type (e.g., text, dropdown, checkbox).

​
options
object[]

Available options for dropdown/select fields.