Field Values

Get a field value

Get a field value by field ID and field value ID

get/v1/fields/{field_id}/values/{brex_id}

Request

Base URL
https://api.brex.com
Auth
OAuth 2
Authorization codehttps://accounts-api.brex.com/oauth2/default/v1/authorize
Token URLhttps://accounts-api.brex.com/oauth2/default/v1/token
Scopesfield_values.read, field_values.write
TypeScript
https://skmtc.dev/brex-com/apis/fields-api/docs/v1/fields/:field_id/values/:brex_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

field_idstring required

The Field Brex identifier

brex_idstring required

The field value ID (brex_id) to retrieve.

Response

Get a field value response

brex_idstring required

The internal Brex ID of the field value

remote_idstring nullable

Remote/external ID of custom field value from external system (e.g. ERP or HRIS system)

value_idstring nullable

The value ID or code of the field value; Usually it is a unique identifier for the custom field value in the remote system

valuestring required

The display name of the field value

field_idstring required

The ID of the parent field this value belongs to

updated_atstring date-time required

The last updated timestamp of the field value

is_disabledboolean required

Indicates whether the field value is disabled. A disabled value is not selectable: it no longer appears as a selectable option in the dropdown and cannot be chosen on new transactions. Records that already use the value are unaffected.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.