Account Locations

Represents a location associated with an account.

Operations

Fetching a list of Account Locations

Request

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.

Query

archivedstring

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

Default:"exclude"

onlystring

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.

orderstring

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

Valid values: name:asc and name:desc.

Default:"name"

pageinteger, (int32)

Default:1

per_pageinteger, (int32), <= 200

Default:20

workspace_idinteger, (int32)

Returns account locations for the account on the specified workspace.

GET

/account_locations

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/account_locations?archived=exclude&only=string&order=name&page=1&per_page=20&workspace_id=0'

Responses

A list of Account Locations have been retrieved.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

account_locationsobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "account_locations": {
    "property1": {
      "archived": true,
      "in_use": true,
      "name": "string"
    },
    "property2": {
      "archived": true,
      "in_use": true,
      "name": "string"
    }
  }
}