Skip to content

Team API (1.0)

The team API lets you manage users, departments, locations, and cards.

Download OpenAPI description
Languages
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

Endpoints for user management.

Operations

Endpoints for location management.

Operations

Request

This endpoint lists all locations.

Security
OAuth2(Required scopes:
locations
locations.readonly
)
Query
cursorstring or null
limitinteger or null(int32)
namestring or null
curl -i -X GET \
  https://api.brex.com/v2/locations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

listLocations 200 response

Bodyapplication/json
next_cursorstring or null
itemsArray of objects(LocationResponse)required
items[].​idstringrequired
items[].​namestringrequired

Name of the location

items[].​descriptionstring or null

Description of the location

Response
application/json
{ "next_cursor": "string", "items": [ {} ] }

Request

This endpoint creates a new location.

Security
OAuth2(Required scopes:
locations
)
Headers
Idempotency-Keystring or null
Bodyapplication/jsonrequired
namestringnon-emptyrequired

Name of the location

descriptionstring or null

Description of the location

curl -i -X POST \
  https://api.brex.com/v2/locations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string"
  }'

Responses

createLocation 200 response

Bodyapplication/json
idstringrequired
namestringrequired

Name of the location

descriptionstring or null

Description of the location

Response
application/json
{ "id": "string", "name": "string", "description": "string" }

Request

This endpoint gets a location by ID.

Security
OAuth2(Required scopes:
locations
locations.readonly
)
Path
idstringrequired
curl -i -X GET \
  'https://api.brex.com/v2/locations/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

getLocationById 200 response

Bodyapplication/json
idstringrequired
namestringrequired

Name of the location

descriptionstring or null

Description of the location

Response
application/json
{ "id": "string", "name": "string", "description": "string" }

Endpoints for department management.

Operations

Endpoints for title management.

Operations

Endpoints for card management.

Operations