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

Endpoints for department management.

Operations

Endpoints for title management.

Operations

Endpoints for card management.

Operations

Request

This endpoint returns the company associated with the OAuth2 access token.

Security
OAuth2(Required scopes:
companies.readonly
)
curl -i -X GET \
  https://api.brex.com/v2/company \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

getCompany 200 response

Bodyapplication/json
idstringrequired
legal_namestringrequired
mailing_addressobject(Address)required

Company business address (must be in the US; no PO box or virtual/forwarding addresses allowed).

mailing_address.​line1string or null

Address line 1, no PO Box.

mailing_address.​line2string or null

Address line 2 (e.g., apartment, suite, unit, or building).

mailing_address.​citystring or null

City, district, suburb, town, or village.

mailing_address.​statestring or null

For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.

mailing_address.​countrystring or null

Two-letter country code (ISO 3166-1 alpha-2).

mailing_address.​postal_codestring or null

ZIP or postal code.

mailing_address.​phone_numberstring or null

Phone number.

accountTypestring(AccountType)required
Enum"BREX_CLASSIC""BREX_EMPOWER"
Response
application/json
{ "id": "string", "legal_name": "string", "mailing_address": { "line1": "string", "line2": "string", "city": "string", "state": "string", "country": "string", "postal_code": "string", "phone_number": "string" }, "accountType": "BREX_CLASSIC" }