v1

latestOpenAPI 3.0.12026-08-06102329.4 KB

Field Values

List custom field values

List values under the same custom field

get/v1/fields/{field_id}/values

Path parameters

field_idstring required

The Field Brex identifier

Query parameters

brex_id[]string[] nullable

Field value Brex identifier(s) to filter by

value_id[]string[] nullable

Field value identifier(s) to filter by

remote_id[]string[] nullable

Field value remote identifier(s) to filter by

cursorstring nullable

The cursor to use for pagination. This is the next_cursor value returned from the previous response.

limitinteger nullable

Controls the maximum number of field values returned in the response. It can't be greater than 1000.

valuestring nullable

Field value's value to filter by

Response

List custom field values response

next_cursorstring nullable

Example response

{
  "items": [
    {
      "brex_id": "efo_foobar",
      "remote_id": "foo_bar",
      "value_id": "foo_bar",
      "field_id": "extended_field_foobar"
    }
  ]
}