Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Organization Memberships

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

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.

Request
query Parameters
created_after
string <date-time>

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

created_before
string <date-time>

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

department_id
integer <int32>

Returns only organization memberships with the specified department ID.

geography_id
integer <int32>

Returns only organization memberships with the specified geography ID.

include
string

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_id
integer <int32>

Returns only organization memberships with the specified member ID.

member_type
string

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

only
string

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.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
primary
boolean

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_after
string <date-time>

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

updated_before
string <date-time>

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

Responses
200

A list of Organization Memberships have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/organization_memberships
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "organization_memberships": {
    },
  • "organizations": {
    }
}
Creating a new Organization Membership
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.


Request 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
geography_id
required
integer <int32> 
The ID of the membership's geography.


 
department_id
required
integer <int32> 
The ID of the membership's department.


 
member_id
required
integer <int32> 
The ID of the project or user.


 
member_type
required
string
The type of object that describes the member (workspace or user).


 
Responses 
200
Organization Membership has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/organization_memberships
Request samples 
application/json
{
  • "organization_membership": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "organization_memberships": {
    },
  • "organizations": {
    }
}
Fetching a single Organization Membership
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Responses 
200
The Organization Membership has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/organization_memberships/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "organization_memberships": {
    },
  • "organizations": {
    }
}
Updating an existing Organization Membership
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
geography_id
integer <int32> 
The ID of the membership's geography.


 
department_id
integer <int32> 
The ID of the membership's department.


 
Responses 
200
Organization Membership has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/organization_memberships/{id}
Request samples 
application/json
{
  • "organization_membership": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "organization_memberships": {
    },
  • "organizations": {
    }
}
Deleting an existing Organization Membership
The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Organization Membership has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/organization_memberships/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Organizations