API Documentation

Memberships ¶

Working with memberships:

Membership objects are used for managing access to different resources in Productive. Currently it is used to manage access to projects, docs, dashboards, task views and deals.

Resources accessible via memberships ¶

Depending on the resource you are giving access for, different attribute is required. Here is a list of resources that can be used with memberships and their required attributes:

Resource	Required attributes
Project	project_id
Doc	page_id
Dashboard	dashboard_id
Task view	filter_id
Deal	deal_id

Membership types ¶

There are three types of membership:

• type_id: 1, person -> gives access to a specific person

• type_id: 2, dynamic_group -> gives access to a system predefined group of people

• type_id: 3, team -> gives access to a team

When working with memberships, depending on the type of membership, different attributes should be sent. For person membership, you need to provide person_id, for dynamic group membership, you need to provide dynamic_group_id, and for team membership, you need to provide team_id.

Dynamic groups ¶

Dynamic groups are predefined groups of people that are created based on the person role and person assignment. There are four types of dynamic groups:

• dynamic_group_id: 2 - employees -> all employees in the organization

• dynamic_group_id: 6 - project_members -> all members of a resource’s project

• dynamic_group_id: 8 - project_manager -> project manager of a resource’s project

• dynamic_group_id: 9 - deal_owner -> owner of a deal

When creating a membership for a dynamic group, you need to provide dynamic_group_id. Depending on the target resource you are giving access to, different dynamic groups are available, dynamic_group_id available for:

• Project membership: 2

• Doc membership

  • if Doc is on a project: 2, 6, 8
  • if Doc is not on a project: 2

• Dashboard membership: 2

• Deal membership: 2, 6, 8, 9

• Task view membership: 2

Access levels ¶

There are multiple access levels membership can have:

• access_type_id: 1 - full -> can edit and delete resource

• access_type_id: 2 - edit -> can edit resource

• access_type_id: 3 - view -> can only view resource

• access_type_id: 4 - comment -> can comment on resource

• access_type_id: 5 - member -> marks a subject as a member of a resource

More about member access: Member access is used for resources where there is no need for different levels (projects, deals). Those resources use only one access type and that is member access. Having member access means you are a member of a resource.

Depending on the target resource you are giving access to, different access levels are available:

• Project memberships use level: 5

• Doc memberships use levels: 1, 2, 3, 4

• Dashboard memberships use levels: 1, 3

• Deal memberships use level: 5

• Task view memberships use level: 1, 3

Examples of creating membership ¶

Example 1: creating a membership for a person on a project

POST https://api.productive.io/api/v2/memberships

{
  "data": {
    "attributes": {
      "type_id": 1,
      "person_id": 123,
      "access_type_id": 5,
      "project_id": 321
    },
    "type": "memberships"
  }
}

Explanation of the example:

• type_id: 1 - membership is for a person

• person_id: 123 - person with id: 123 is getting access

• access_type_id: 5 - person is getting member access

• project_id: 321 - person is getting access to project with id: 321

Example 2: creating full access membership for an employees dynamic group on a dashboard

POST https://api.productive.io/api/v2/memberships

{
  "data": {
    "attributes": {
      "type_id": 2,
      "dynamic_group_id": 2,
      "access_type_id": 1,
      "dashboard_id": 321
    },
    "type": "memberships"
  }
}

Explanation of the example:

• type_id: 2 - membership is for a dynamic group

• dynamic_group_id: 2 - employees dynamic group is getting access

• access_type_id: 1 - employees are getting full access

• dashboard_id: 321 - employees are getting access to dashboard with id: 321

Example 3: creating view access membership for a team on a doc

POST https://api.productive.io/api/v2/memberships

{
  "data": {
    "attributes": {
      "type_id": 3,
      "team_id": 123,
      "access_type_id": 3,
      "page_id": 321
    },
    "type": "memberships"
  }
}

Explanation of the example:

• type_id: 3 - membership is for a team

• team_id: 123 - team with id: 123 is getting access

• access_type_id: 3 - team is getting view access

• page_id: 321 - team is getting access to doc with id: 321

Supported filter params ¶

• access_type_id

• dashboard_id

• deal_id

• dynamic_group_id

• filter_id

• id

• page_id

• person_id

• project_id

• target_id

• target_type

• type_id