Home Original page

Locations

Team API (1.0)

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

Staging (Note: This is not a sandbox. It will not work with customer tokens.)

https://api-staging.brex.com

Users

Endpoints for user management.

Endpoints for location management.

List locations

Request

This endpoint lists all locations.

OAuth2(Required scopes:

locations

locations.readonly

)

Query

limitinteger or null(int32)

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

items[].​descriptionstring or null

Description of the location

{

  
"next_cursor": "string",

  
"items": 
[

    
{
 … 
}

  
]


}

Was this helpful?

Create location

Request

This endpoint creates a new location.

OAuth2(Required scopes:

locations

)

Headers

Idempotency-Keystring or null

Bodyapplication/jsonrequired

namestringnon-emptyrequired

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

descriptionstring or null

Description of the location

{

  
"id": "string",

  
"name": "string",

  
"description": "string"
}

Was this helpful?

Get location

Request

This endpoint gets a location by ID.

OAuth2(Required scopes:

locations

locations.readonly

)

curl -i -X GET \
  'https://api.brex.com/v2/locations/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

getLocationById 200 response

Bodyapplication/json

descriptionstring or null

Description of the location

{

  
"id": "string",

  
"name": "string",

  
"description": "string"
}

Was this helpful?

Departments

Endpoints for department management.

Titles

Endpoints for title management.

Cards

Endpoints for card management.

Companies