v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

custom-fields

Get list of custom field values

Get a list of custom field value objects. By default, you get 20 results on one page of results. Set max in your request to get up to 100 results on one page.

get/v3/spend/custom-fields/{customFieldId}/values

Path parameters

customFieldIdstring required

BILL-generated ID or UUID of the custom field

Example:{{se_custom_field_uuid}}

Query parameters

maxinteger nullable

Maximum number of results

Example:10

nextPagestring nullable

Next page of results.

When a list has multiple pages, the nextPage and prevPage values in the response enable you to navigate between the pages of results. Set this field as the nextPage value for navigation.

prevPagestring nullable

Previous page of results. Set this field as the prevPage value for navigation.

filtersstring nullable

Field name, operator, and value. You can set multiple filters.

The format is filters={field_01}:{op}:{value},{field_02}:{op}:{value}.

Example: filters=name:sw:Ad

The filterable fields are:

name - String. Operators: eq, sw.
retired - true or false. Operators: eq. The default value is false.

Example:retired:eq:false

Headers

apiTokenstring nullable

Access token for Spend & Expense API authentication

Example:{{api_token}}

Response

Get list of custom field values response

nextPagestring

Next page token

prevPagestring

Previous page token