KAkantata
Organizations

Fetching a list of Organizations

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.

get/organizations

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Query parameters

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.

pageinteger
per_pageinteger
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.

Response

A list of Organizations have been retrieved.

countinteger
organizationsobject

Changes

No recorded changes to this operation across all 1 revision of this API.