# Fields API

The Fields API allows you to manage fields and field values information. The Fields API is currently in Beta and is available for use. Customers do not need to explicitly opt-in to Beta. However, the API is subject to changes as per the expectations set regarding Beta APIs in the API Launch Stages documentation: https://developer.brex.com/docs/api-launch-stages/.

Version: 1.0.0-beta

## Servers

Production
```
https://api.brex.com
```

Staging (Note: This is not a sandbox. It will not work with customer tokens.)
```
https://api-staging.brex.com
```

## Security

### OAuth2

OAuth2 security scheme

Type: oauth2

## Download OpenAPI description

[Fields API](https://developer.brex.com/_bundle/openapi/fields_api.yaml)

## Fields

View and manage fields data.

### List custom fields

 - [GET /v1/fields](https://developer.brex.com/openapi/fields_api/fields/listfields.md): List custom fields under the same account

### Create a custom field

 - [POST /v1/fields](https://developer.brex.com/openapi/fields_api/fields/createfield.md): Create a custom field

### Get custom field

 - [GET /v1/fields/{id}](https://developer.brex.com/openapi/fields_api/fields/getfieldbyid.md): Get a custom field by Brex ID

### Update a custom field

 - [PUT /v1/fields/{id}](https://developer.brex.com/openapi/fields_api/fields/updatefield.md): Update a field by ID

### Delete a custom field

 - [DELETE /v1/fields/{id}](https://developer.brex.com/openapi/fields_api/fields/deletefield.md): Delete a custom field by Brex ID

## Field Values

### List custom field values

 - [GET /v1/fields/{field_id}/values](https://developer.brex.com/openapi/fields_api/field-values/listfieldvalues.md): List values under the same custom field

### Update custom field values

 - [PUT /v1/fields/{field_id}/values](https://developer.brex.com/openapi/fields_api/field-values/updatefieldvalues.md): Update custom field values (up to 1000 values at once) for a specific field

### Create custom field values

 - [POST /v1/fields/{field_id}/values](https://developer.brex.com/openapi/fields_api/field-values/createfieldvalues.md): Create custom field values (up to 1000 values at once) for a specific field

### Delete custom field values

 - [DELETE /v1/fields/{field_id}/values](https://developer.brex.com/openapi/fields_api/field-values/deletefieldvalues.md): Delete custom field values (up to 1000 values at once) for a specific field

### Get a field value

 - [GET /v1/fields/{field_id}/values/{brex_id}](https://developer.brex.com/openapi/fields_api/field-values/getfieldvaluebyid.md): Get a field value by field ID and field value ID