Carbon

Location

The location resource.

Basehttps://rest.carbon.ms/location
GET/location

List locations

Retrieve a paginated list of locations. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/location
curl --request GET \
  --url 'https://rest.carbon.ms/location?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "addressLine1": "string",
    "city": "string",
    "stateProvince": "string",
    "postalCode": "string",
    "timezone": "string",
    "companyId": "xyz789"
  }
]
GET/location

Retrieve a location

Fetch a single location by filtering on `id`.

Query parameters

idstring

Match on the location's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/location
curl --request GET \
  --url 'https://rest.carbon.ms/location?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "addressLine1": "string",
  "city": "string",
  "stateProvince": "string",
  "postalCode": "string",
  "timezone": "string",
  "companyId": "xyz789"
}
POST/location

Create a location

Create a new location.

Body parameters

namestringrequired
addressLine1stringrequired
addressLine2string
citystringrequired
stateProvincestringrequired
postalCodestringrequired
countryCodestring
timezonestringrequired
latitudenumber
longitudenumber
companyIdstringrequired

References company.id

customFieldsobject
tagsarray
POSThttps://rest.carbon.ms/location
curl --request POST \
  --url https://rest.carbon.ms/location \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","addressLine1":"string","city":"string","stateProvince":"string","postalCode":"string","timezone":"string","companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "addressLine1": "string",
  "city": "string",
  "stateProvince": "string",
  "postalCode": "string",
  "timezone": "string",
  "companyId": "xyz789"
}
PATCH/location

Update a location

Update an existing location, matched on `id`.

Body parameters

namestringrequired
addressLine1stringrequired
addressLine2string
citystringrequired
stateProvincestringrequired
postalCodestringrequired
countryCodestring
timezonestringrequired
latitudenumber
longitudenumber
companyIdstringrequired

References company.id

customFieldsobject
tagsarray
PATCHhttps://rest.carbon.ms/location
curl --request PATCH \
  --url 'https://rest.carbon.ms/location?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "addressLine1": "string",
  "city": "string",
  "stateProvince": "string",
  "postalCode": "string",
  "timezone": "string",
  "companyId": "xyz789"
}
DELETE/location

Delete a location

Delete a location, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the location to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/location
curl --request DELETE \
  --url 'https://rest.carbon.ms/location?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content