Sign in
Memberships

Get multiple memberships

Returns compact goal_membership, project_membership, portfolio_membership, custom_type_membership, or custom_field_membership records. The possible types for parent in this request are goal, project, portfolio, custom_type, or custom_field. An additional member (user GID or team GID) can be passed in to filter to a specific membership.

Alternatively, when parent is absent, you can use the member and resource_subtype parameters together to fetch all memberships of a specific type for a given member. For example, passing member as a team GID and resource_subtype as project_membership will return all project memberships for that team.

get/memberships

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/memberships
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.asana.com/-/oauth_authorize, token URL https://app.asana.com/-/oauth_token)

Query parameters

parentstring

Globally unique identifier for goal, project, portfolio, custom_type, or custom_field. This parameter is optional when resource_subtype is provided along with member of type team.

memberstring

Globally unique identifier for team or user. When used with resource_subtype and without parent, member must be of type team. For user-type memberships parent parameter is required to disambiguate the workspace from which memberships should be retrieved.

resource_subtype'project_membership'

The type of membership to return. Required when parent is absent. Currently supported value is project_membership (when member is a team GID, returns all project memberships for that team).

limitinteger

Results per page. The number of objects to return per page. The value must be between 1 and 100.

offsetstring

Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.

opt_fieldsstring[]

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide.

Response

Successfully retrieved the requested membership.

Example response

{
  "data": [
    {
      "gid": "12345",
      "resource_type": "membership",
      "resource_subtype": "goal_membership",
      "member": {
        "gid": "12345",
        "resource_type": "user",
        "name": "Greg Sanchez"
      },
      "parent": {
        "gid": "12345",
        "resource_type": "goal",
        "name": "Grow web traffic by 30%",
        "owner": {
          "gid": "12345",
          "resource_type": "user",
          "name": "Greg Sanchez"
        }
      },
      "role": "editor",
      "access_level": "editor",
      "goal": {
        "gid": "12345",
        "resource_type": "goal",
        "name": "Grow web traffic by 30%",
        "owner": {
          "gid": "12345",
          "resource_type": "user",
          "name": "Greg Sanchez"
        }
      }
    }
  ],
  "next_page": {
    "offset": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
    "path": "/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
    "uri": "https://app.asana.com/api/1.0/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.