Skip to content

Organizations

The Organizations feature in Kantata OX is composed of two independent trees: Department and Geography. Each has its own hierarchy structure. Users and Workspaces are associated to exact positions in these two trees via Organization Memberships. The corresponding API fields are geography_id and department_id.

A user's position in these two trees determines what objects they can see in Kantata OX—they can see objects associated with every department and geography going up the hierarchy from their selected department and geography.

Operations

Fetching a list of Organizations

Request

This endpoint returns structured Organization 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 organizations top-level JSON key. Please see our Response Format section for more information.

Query
created_afterstring, (date-time)

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring, (date-time)

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

for_current_userboolean

Filter for organizations the current user belongs to. The parameter value is ignored (i.e. regardless of the value you supply, including this filter will always filter by organizations the current user belongs to).

matchingstring

Where organization name is like specified parameter.

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: alphabetical:asc, alphabetical:desc, created_at:asc, and created_at:desc.

Default:"alphabetical:asc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
typestring

Where the organization is of a specified type.

updated_afterstring, (date-time)

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring, (date-time)

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

GET
/organizations
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/organizations?created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&for_current_user=true&matching=string&only=string&order=alphabetical%3Aasc&page=1&per_page=20&type=string&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z'

Responses

A list of Organizations have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
organizationsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "organizations": {
    "property1": {
      "ancestor_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "parent_id": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "ancestor_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "parent_id": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}