Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Account Locations

Represents a location associated with an account.

Fetching a list of Account Locations

This endpoint returns structured Account Location objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the account_locations top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
archived
string
Default: "exclude"

Only includes archived account locations, based on the specified option. Options are 'only', 'exclude', or 'include'.

only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

order
string
Default: "name"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: name:asc and name:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
workspace_id
integer <int32>
Default: ""

Returns account locations for the account on the specified workspace.

Responses
200

A list of Account Locations have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/account_locations
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "account_locations": {
    }
}
Creating a new Account Location
This endpoint returns structured Account Location objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the account_locations top-level JSON key.
Please see our Response Format section for more information.


Request 
Request Body schema: application/json
required
object
 
name
string
The location the Account Location represents.


 
archived
boolean
Whether the account location is archived or active. Defaults to false.


 
Responses 
200
Account Location has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/account_locations
Request samples 
application/json
{
  • "account_location": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "account_locations": {
    }
}
Updating an existing Account Location
This endpoint returns structured Account Location objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the account_locations top-level JSON key.
Please see our Response Format section for more information.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Request Body schema: application/json
required
object
 
name
string
The location the Account Location represents.


 
archived
boolean
Whether the account location is archived or active.


 
Responses 
200
Account Location has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/account_locations/{id}
Request samples 
application/json
{
  • "account_location": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "account_locations": {
    }
}
Deleting an existing Account Location
The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Account Location has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/account_locations/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Access Group Memberships