BRbrex-com
Fields

Get custom field

Get a custom field by Brex ID

get/v1/fields/{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
    Scopesfields.read, fields.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The Brex identifier of the field to retrieve

Response

Get custom field response

brex_idstring required

The internal Brex ID of the field

namestring nullable required

The name of the field

remote_idstring nullable

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

updated_atstring date-time required

The last updated timestamp of the field

is_disabledboolean required

Indicates whether the field is disabled. A disabled field is not selectable: it is no longer offered as an option in the Brex dropdown and cannot be applied to new transactions. Records that already reference the field are unaffected.

group'ACCOUNTING' | 'USER' | 'ERP' | 'TRAVEL' nullable

The category of the field, indicating its purpose or context. For example, it could belong to accounting-related fields or user-related fields.

Example response

{
  "brex_id": "extended_field_foobar",
  "remote_id": "foo_bar"
}

Changes

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