Skip to content

Organization Memberships

An Organization Membership represents the connection of a user and project to an organization.

Operations

Fetching a list of Organization Memberships

Request

This endpoint returns structured Organization Membership 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 organization_memberships 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.

department_idinteger, (int32)

Returns only organization memberships with the specified department ID.

geography_idinteger, (int32)

Returns only organization memberships with the specified geography ID.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • department (Organization) - The department of the associated member.
  • geography (Organization) - The geography of the associated member.
member_idinteger, (int32)

Returns only organization memberships with the specified member ID.

member_typestring

Returns only organization memberships with the specified member type (user or workspace).

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.

pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
primaryboolean

Return only the organization membership that is set as the primary for the object (true) or only the organization memberships that are not the primary (false). This filter requires the primary organization feature.

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
/organization_memberships
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/organization_memberships?created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&department_id=0&geography_id=0&include=string&member_id=0&member_type=string&only=string&page=1&per_page=20&primary=true&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z'

Responses

A list of Organization Memberships have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
organization_membershipsobject
organizationsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "organization_memberships": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "department_id": "string",
      "geography_id": "string",
      "member_id": "string",
      "member_type": "string",
      "primary": true,
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "department_id": "string",
      "geography_id": "string",
      "member_id": "string",
      "member_type": "string",
      "primary": true,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "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"
    }
  }
}