API docs by Redocly

Client Location API (1.0.0)

Download OpenAPI specification:Download

API for managing client locations

Client Location

Client location management operations

Get all client locations

Retrieve a list of all client locations with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

client
string

Filter by client ID

disabled
boolean

Filter by disabled status

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new client location

Create a new client location entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
client
required
string

Client ID

name
required
string

Location name

address
required
string

Street address

city
string

City name

state
string

State or province

postal_code
string

Postal or ZIP code

country
string

Country name

object
is_primary
boolean
Default: false

Whether this is the primary location

location_type
string
Default: "office"
Enum: "office" "warehouse" "retail" "branch" "other"

Type of location

object
object
notes
string

Additional notes about the location

company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether the location is disabled

Responses

Request samples

Content type
application/json
{
  • "client": "507f1f77bcf86cd799439012",
  • "name": "Main Office",
  • "address": "123 Main St",
  • "city": "New York",
  • "state": "NY",
  • "postal_code": "10001",
  • "country": "United States",
  • "coordinates": {
    },
  • "is_primary": false,
  • "location_type": "office",
  • "contact_info": {
    },
  • "business_hours": {
    },
  • "notes": "string",
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get client location by ID

Retrieve a specific client location by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Client location ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update client location

Update an existing client location

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Client location ID

Request Body schema: application/json
name
string

Location name

address
string

Street address

city
string

City name

state
string

State or province

postal_code
string

Postal or ZIP code

country
string

Country name

object
is_primary
boolean

Whether this is the primary location

location_type
string
Enum: "office" "warehouse" "retail" "branch" "other"

Type of location

object
object
notes
string

Additional notes about the location

company_namespace
Array of strings

Company namespace

disabled
boolean

Whether the location is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "string",
  • "coordinates": {
    },
  • "is_primary": true,
  • "location_type": "office",
  • "contact_info": {
    },
  • "business_hours": {
    },
  • "notes": "string",
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete client location

Delete a client location by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Client location ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Bulk delete client locations

Delete multiple client locations by their IDs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of client location IDs to delete

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}