Get Client Custom Field Values

Custom field values of many clients in one call, so a list view does not need a request per client. Only fields the client actually has a value for are returned; a requested client with no values is still listed, with an empty `customFields` array. Values of archived fields are kept (flagged with `isArchived`) so retiring a field never hides collected data.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

filter*

Filters the values by a specified value

Header Parameters

accept-language?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v2/custom-fields/values?filter%5BclientIds%5D=1%2C2%2C3" \  -H "accept-language: ja"

{  "total": 3,  "data": [    {      "clientId": 42,      "customFields": [        {          "fieldId": "0191f3c2-2d9a-7b1e-9a3c-6f4b8c1d2e3f",          "name": "tax_number",          "label": "Tax number",          "type": "text",          "value": "string",          "isArchived": false        }      ]    }  ]}

{  "error": {    "message": "Bad Request",    "code": 0,    "details": [      {        "issue": "The selected value is invalid.",        "field": "parameter"      }    ]  }}

{  "error": {    "message": "Unauthorized"  }}

{  "error": {    "message": "Forbidden"  }}

{  "error": {    "message": "Too Many Requests"  }}

{  "error": {    "message": "Service Unavailable"  }}

Get Client Custom Field Values

Authorization

Query Parameters

Header Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`