Brex: Get custom field
Brex fields.fieldsGetFieldById: arguments, response, policy and SDK examples.
← Fields operations · Get started
Operation brex.fields_getfieldbyid
Provider route: GET /v1/fields/{id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/brex with npm, or alter-sdk-brex with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { BrexIntegration } from "@alter-ai/brex";
async function execute(input: Parameters<BrexIntegration["fields"]["fieldsGetFieldById"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new BrexIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.fields.fieldsGetFieldById(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_brex import BrexIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = BrexIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.fields.fields_get_field_by_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.id | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get custom field — response body |
Referenced models: Get custom field — response body
Schemas
Section titled “Schemas”Get custom field — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field definition |
brex_id | string | Required within parent | The internal Brex ID of the field |
group | JSON | Optional | |
group (anyOf 1) | JSON | Alternative | |
group (anyOf 1) (allOf 1) | Model | All variants apply | Expand Get custom field — response body — group string string |
group (anyOf 1) (allOf 2) | JSON | All variants apply | The category of the field, indicating its purpose or context. For example, it could belong to accounting-related fields or user-related fields. |
group (anyOf 2) | null | Alternative | |
is_disabled | boolean | Required within parent | 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. |
name | JSON | Required within parent | |
name (anyOf 1) | string | Alternative | The name of the field |
name (anyOf 2) | null | Alternative | |
remote_id | JSON | Optional | |
remote_id (anyOf 1) | string | Alternative | Remote/external ID of custom field from external system (e.g. ERP or HRIS system) |
remote_id (anyOf 2) | null | Alternative | |
updated_at | string | Required within parent | The last updated timestamp of the field Format: date-time |
Referenced models: Get custom field — response body — group string string
Get custom field — response body — group string string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The category of the field, indicating its purpose or context. Supported groups are: * `ACCOUNTING` — Fields used to categorize transactions for accounting purposes (for example, expense categories or cost centers) that are managed directly within Brex. * `USER` — Fields associated with users, used to capture user-specific attributes. * `ERP` — Fields that are synced with an external ERP/accounting system through an Accounting Integration. Creating an Accounting Integration is a prerequisite for creating fields in the `ERP` group, and each `ERP` field must reference that integration through `integration_id`. * `TRAVEL` — Fields used in the context of travel bookings and expenses. Known values: ACCOUNTING, USER, ERP, TRAVEL |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: brex.fields_getfieldbyid. Catalog operation: fields:getFieldById. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["fields.read", "fields.write"]