KAkantata
Organization Memberships

Fetching a list of Organization Memberships

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.

get/organization_memberships

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.

department_idinteger

Returns only organization memberships with the specified department ID.

geography_idinteger

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

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.

optional_fieldsstring[]

Allows you to request one or more optional fields as an array.

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

show_past_membershipsboolean

Includes inactive memberships (e.g. has a value for effective_end_date), which are excluded by default. Memberships become inactive when users or projects are removed from organizations.

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 Organization Memberships have been retrieved.

countinteger
organization_membershipsobject
organizationsobject

Changes

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