Skip to content

Asana: Memberships schemas

24 Asana schemas with complete fields and constraints.

← Memberships operations · All schemas

Get a membership — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a membership — response body — data data — sdk__Membership Response

Referenced models: Get a membership — response body — data data — sdk__Membership Response

Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer parent — shared_parent_8a60f1590cfc

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *table* is a container for structured records (rows), with columns defined by custom field settings.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the table.

Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer parent — shared_parent_f6c1f3504a25

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *record* is a single row in a table. Fields on a record are backed by the table's custom field settings.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the record.

Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Project Membership Compact Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get memberships from a project — response body — data, next page data item — Project Membership Compact
$ (allOf 2)objectAll variants apply
$ (allOf 2).resource_typestringOptionalThe base type of this resource.
$ (allOf 2).resource_subtypestringOptionalType of the membership.

Referenced models: Get memberships from a project — response body — data, next page data item — Project Membership Compact

Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Record Membership Compact

FieldTypePresenceDescription and constraints
$objectRootA user or team's membership in a record.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalType of the membership.
parentModelOptionalExpand Search records in a workspace — response body — data data item
The record the user or team is a member of.
memberModelOptionalExpand Get memberships from a project — response body — data, next page data item member
Member can be a user or a team.
access_levelstringOptionalThe member's access level in the record.
Known values: admin, editor, commenter, viewer
Read only: true

Referenced models: Get memberships from a project — response body — data, next page data item member, Search records in a workspace — response body — data data item

Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Table Membership Compact

FieldTypePresenceDescription and constraints
$objectRootA user or team's membership in a table.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalType of the membership.
parentModelOptionalExpand Get tables in a workspace — response body — data, next page data item
The table the user or team is a member of.
memberModelOptionalExpand Get memberships from a project — response body — data, next page data item member
Member can be a user or a team.
access_levelstringOptionalThe member's access level in the table.
Known values: admin, editor, commenter, viewer
Read only: true

Referenced models: Get memberships from a project — response body — data, next page data item member, Get tables in a workspace — response body — data, next page data item

Get a membership — response body — data / data / access_level: admin, editor, user

FieldTypePresenceDescription and constraints
$objectRootThis object describes a user or team's membership to a custom field including their level of access (Admin, Editor, or User).
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalType of the membership.
parentModelOptionalExpand Get a membership — response body — data / data / access_level: admin, editor, user parent
The custom field the user or team is a member of.
memberModelOptionalExpand Get memberships from a project — response body — data, next page data item member
Member can be a user or a team.
access_levelstringOptionalWhether the member has admin, editor, or user access to the custom field.
Known values: admin, editor, user
Read only: true

Referenced models: Get memberships from a project — response body — data, next page data item member, Get a membership — response body — data / data / access_level: admin, editor, user parent

Get a membership — response body — data / data / access_level: admin, editor, user parent

FieldTypePresenceDescription and constraints
$objectRootCustom Fields store the metadata that is used in order to add user-specified information to tasks in Asana. Be sure to reference the [custom fields](/reference/custom-fields) developer documentation for more information about how custom fields relate to various resources in Asana.

Users in Asana can [lock custom fields](https://asana.com/guide/help/premium/custom-fields#gl-lock-fields), which will make them read-only when accessed by other users. Attempting to edit a locked custom field will return HTTP error code `403 Forbidden`.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom field.
typestringOptional*Deprecated: new integrations should prefer the resource_subtype field.* The type of the custom field. Must be one of the given values.

Known values: text, enum, multi_enum, number, date, people, reference
Read only: true
enum_optionsarrayOptional*Conditional*. Only relevant for custom fields of type `enum` or `multi_enum`. This array specifies the possible values which an `enum` custom field can adopt. To modify the enum options, refer to [working with enum options](/reference/createenumoptionforcustomfield).
enum_options[]ModelEach itemExpand Create an enum option — response body — data data — Enum Option
enabledbooleanOptional*Conditional*. This field applies only to [custom field values](/docs/custom-fields-guide#/accessing-custom-field-values-on-tasks-or-projects) and is not available for [custom field definitions](/docs/custom-fields-guide#/accessing-custom-field-definitions).
Determines if the custom field is enabled or not. For more details, see the [Custom Fields documentation](/docs/custom-fields-guide#/enabled-and-disabled-values).
Read only: true
representation_typestringOptionalThis field tells the type of the custom field.
Known values: text, enum, multi_enum, number, date, people, formula, custom_id, reference
Read only: true
id_prefixJSONOptional
id_prefix (anyOf 1)stringAlternativeThis field is the unique custom ID string for the custom field.
id_prefix (anyOf 2)nullAlternative
input_restrictionsarrayOptional
input_restrictions[]stringEach item*Conditional*. Only relevant for custom fields of type `reference`. This array of strings reflects the allowed types of objects that can be written to a `reference` custom field value.
Known values: task, project, portfolio, goal
is_formula_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a formula custom field.
is_lookup_fieldbooleanOptional*Conditional*. This flag describes whether a custom field is a lookup custom field.
date_valueJSONOptional
date_value (anyOf 1)ModelAlternativeExpand Get a custom field — response body — data data date value date, date time
date_value (anyOf 2)nullAlternative
enum_valueJSONOptional
enum_value (anyOf 1)JSONAlternative
enum_value (anyOf 1) (allOf 1)ModelAll variants applyExpand Create an enum option — response body — data data — Enum Option
enum_value (anyOf 1) (allOf 2)objectAll variants apply*Conditional*. Only relevant for custom fields of type `enum`. This object is the chosen value of an `enum` custom field.
enum_value (anyOf 2)nullAlternative
multi_enum_valuesarrayOptional*Conditional*. Only relevant for custom fields of type `multi_enum`. This object is the chosen values of a `multi_enum` custom field.
multi_enum_values[]ModelEach itemExpand Create an enum option — response body — data data — Enum Option
number_valueJSONOptional
number_value (anyOf 1)JSONAlternative
number_value (anyOf 1) (anyOf 1)numberAlternative*Conditional*. This number is the value of a `number` custom field.
number_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_value (anyOf 2)nullAlternative
text_valueJSONOptional
text_value (anyOf 1)stringAlternative*Conditional*. This string is the value of a `text` custom field.
text_value (anyOf 2)nullAlternative
display_valueJSONOptional
display_value (anyOf 1)stringAlternativeA string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types.
Read only: true
display_value (anyOf 2)nullAlternative

Referenced models: Create an enum option — response body — data data — Enum Option, Get a custom field — response body — data data date value date, date time

Get a membership — response body — data / data / access_level: admin, editor, user, viewer

FieldTypePresenceDescription and constraints
$objectRootThis object describes a user or team's membership to a custom type including their level of access (Admin, Editor, User, or Viewer).
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
resource_subtypestringOptionalType of the membership.
parentModelOptionalExpand Get a custom type — response body — data data asana created type identifier, gid, name, resource type
The custom type the user or team is a member of.
memberModelOptionalExpand Get memberships from a project — response body — data, next page data item member
Member can be a user or a team.
access_levelstringOptionalWhether the member has admin, editor, user, or viewer access to the custom type.
Known values: admin, editor, user, viewer
Read only: true

Referenced models: Get memberships from a project — response body — data, next page data item member, Get a custom type — response body — data data asana created type identifier, gid, name, resource type

Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
Custom Types extend the types of Asana Objects.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the custom type.
asana_created_type_identifierJSONOptional
asana_created_type_identifier (anyOf 1)stringAlternative*Read-only*. A stable identifier present when this custom type was created by Asana as part of an Asana product (for example, a Command ticket type or a Service queue type). `null` for custom types created by users, and for Asana-created types that do not have a public identifier yet. New values may be added over time as Asana products introduce new types; integrations should tolerate unrecognized values.
Known values: COMMAND_TICKET, COMMAND_RELEASE, COMMAND_TEAMSPACE, SERVICE_TICKET, SERVICE_CONVERSATION, SERVICE_QUEUE
Read only: true
asana_created_type_identifier (anyOf 2)nullAlternative

Get a membership — response body — data / data / access_level: admin, editor, viewer

FieldTypePresenceDescription and constraints
$objectRootThis object determines if a user is a member of a portfolio.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
parentModelOptionalExpand Get a portfolio membership — response body — data data portfolio — Portfolio Compact
The portfolio the user is a member of.
memberModelOptionalExpand Get memberships from a project — response body — data, next page data item member
Member can be a user or a team.
access_levelstringOptionalWhether the member has admin, editor, or viewer access to the portfolio. Portfolios do not support commenter access yet.
Known values: admin, editor, viewer
Read only: true

Referenced models: Get memberships from a project — response body — data, next page data item member, Get a portfolio membership — response body — data data portfolio — Portfolio Compact

Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor access level: viewer, commenter, editor, admin, role: commenter, editor
$ (allOf 2)ModelAll variants applyExpand Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor user, workspace

Referenced models: Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor access level: viewer, commenter, editor, admin, role: commenter, editor, Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor user, workspace

Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor access level: viewer, commenter, editor, admin, role: commenter, editor

FieldTypePresenceDescription and constraints
$objectRootThis object represents a user's connection to a goal.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
resource_subtypestringOptionalThe type of membership.
Read only: true
memberModelOptionalExpand Get memberships from a project — response body — data, next page data item member
parentJSONOptional
parent (allOf 1)ModelAll variants applyExpand Get parent goals from a goal — response body — data data item
parent (allOf 2)objectAll variants applyRead only: true
rolestringOptional*Deprecated: Describes if the member is a commenter or editor in goal.*
Known values: commenter, editor
access_levelstringOptional"Describes the membership access level for the goal. This is preferred over role."
Known values: viewer, commenter, editor, admin
goalJSONOptional
goal (allOf 1)ModelAll variants applyExpand Get parent goals from a goal — response body — data data item
goal (allOf 2)objectAll variants apply*Deprecated: new integrations should prefer the `parent` field.* A *Goal* is an object in the goal-tracking system that helps your organization drive measurable results.
Read only: true

Referenced models: Get parent goals from a goal — response body — data data item, Get memberships from a project — response body — data, next page data item member

Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor goal

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
*Deprecated: new integrations should prefer the `parent` field.* A *Goal* is an object in the goal-tracking system that helps your organization drive measurable results.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the goal.
ownerJSONOptional
owner (anyOf 1)ModelAlternativeExpand Get an OOO entry — response body — data data user
owner (anyOf 2)nullAlternative

Referenced models: Get an OOO entry — response body — data data user

Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor parent

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the goal.
ownerJSONOptional
owner (anyOf 1)ModelAlternativeExpand Get an OOO entry — response body — data data user
owner (anyOf 2)nullAlternative

Referenced models: Get an OOO entry — response body — data data user

Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor user

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
*Deprecated: new integrations should prefer the `member` field.* A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.

Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor user, workspace

FieldTypePresenceDescription and constraints
$objectRoot
userJSONOptional
user (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
user (allOf 2)objectAll variants apply*Deprecated: new integrations should prefer the `member` field.* A *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
Read only: true
workspaceJSONOptional
workspace (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data
workspace (allOf 2)objectAll variants apply*Deprecated:* A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
Read only: true

Referenced models: Get users in a team — response body — data data item, Update a workspace — request body — body data

Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor workspace

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
*Deprecated:* A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
Read only: true
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the workspace.

Get a membership — response body — data data — Membership Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor
$ (anyOf 2)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Project Membership Compact Response
$ (anyOf 3)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, viewer
$ (anyOf 4)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, user
$ (anyOf 5)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, user, viewer
$ (anyOf 6)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Table Membership Compact
$ (anyOf 7)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Record Membership Compact

Referenced models: Get a membership — response body — data / data / access_level: admin, editor, user, Get a membership — response body — data / data / access_level: admin, editor, user, viewer, Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor, Get a membership — response body — data / data / access_level: admin, editor, viewer, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Project Membership Compact Response, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Record Membership Compact, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Table Membership Compact

Get a membership — response body — data data — sdk__Membership Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
This object represents a user's connection to a goal.
$ (anyOf 1).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
$ (anyOf 1).resource_typestringOptionalThe base type of this resource.
$ (anyOf 1).resource_subtypestringOptionalThe type of membership.
Read only: true
$ (anyOf 1).memberModelOptionalExpand Get a project membership — response body — data data member
$ (anyOf 1).parentModelOptionalExpand Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor parent
$ (anyOf 1).rolestringOptional*Deprecated: Describes if the member is a commenter or editor in goal.*
Known values: commenter, editor
$ (anyOf 1).access_levelstringOptional"Describes the membership access level for the goal. This is preferred over role."
Known values: viewer, commenter, editor, admin
$ (anyOf 1).goalModelOptionalExpand Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor goal
$ (anyOf 1).userModelOptionalExpand Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor user
$ (anyOf 1).workspaceModelOptionalExpand Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor workspace
$ (anyOf 2)objectAlternativeA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
This object describes a team or a user's membership to a project including their level of access (Admin, Editor, Commenter, or Viewer).
$ (anyOf 2).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
$ (anyOf 2).resource_typestringOptionalThe base type of this resource.
$ (anyOf 2).parentModelOptionalExpand Get a rate — response body — data data parent
$ (anyOf 2).memberModelOptionalExpand Get a project membership — response body — data data member
$ (anyOf 2).access_levelstringOptionalWhether the member has admin, editor, commenter, or viewer access to the project.
Known values: admin, editor, commenter, viewer
Read only: true
$ (anyOf 2).resource_subtypestringOptionalType of the membership.
$ (anyOf 3)objectAlternativeA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
This object determines if a user is a member of a portfolio.
$ (anyOf 3).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
$ (anyOf 3).resource_typestringOptionalThe base type of this resource.
Read only: true
$ (anyOf 3).parentModelOptionalExpand Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493
$ (anyOf 3).memberModelOptionalExpand Get a project membership — response body — data data member
$ (anyOf 3).access_levelstringOptionalWhether the member has admin, editor, or viewer access to the portfolio. Portfolios do not support commenter access yet.
Known values: admin, editor, viewer
Read only: true
$ (anyOf 4)objectAlternativeA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
This object describes a user or team's membership to a custom field including their level of access (Admin, Editor, or User).
$ (anyOf 4).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
$ (anyOf 4).resource_typestringOptionalThe base type of this resource.
Read only: true
$ (anyOf 4).resource_subtypestringOptionalType of the membership.
$ (anyOf 4).parentModelOptionalExpand Get a goal — response body — data data custom fields item
$ (anyOf 4).memberModelOptionalExpand Get a project membership — response body — data data member
$ (anyOf 4).access_levelstringOptionalWhether the member has admin, editor, or user access to the custom field.
Known values: admin, editor, user
Read only: true
$ (anyOf 5)objectAlternativeA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
This object describes a user or team's membership to a custom type including their level of access (Admin, Editor, User, or Viewer).
$ (anyOf 5).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
$ (anyOf 5).resource_typestringOptionalThe base type of this resource.
Read only: true
$ (anyOf 5).resource_subtypestringOptionalType of the membership.
$ (anyOf 5).parentModelOptionalExpand Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent
$ (anyOf 5).memberModelOptionalExpand Get a project membership — response body — data data member
$ (anyOf 5).access_levelstringOptionalWhether the member has admin, editor, user, or viewer access to the custom type.
Known values: admin, editor, user, viewer
Read only: true
$ (anyOf 6)objectAlternativeA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A user or team's membership in a table.
$ (anyOf 6).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
$ (anyOf 6).resource_typestringOptionalThe base type of this resource.
Read only: true
$ (anyOf 6).resource_subtypestringOptionalType of the membership.
$ (anyOf 6).parentModelOptionalExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer parent — shared_parent_8a60f1590cfc
$ (anyOf 6).memberModelOptionalExpand Get a project membership — response body — data data member
$ (anyOf 6).access_levelstringOptionalThe member's access level in the table.
Known values: admin, editor, commenter, viewer
Read only: true
$ (anyOf 7)objectAlternativeA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A user or team's membership in a record.
$ (anyOf 7).gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
$ (anyOf 7).resource_typestringOptionalThe base type of this resource.
Read only: true
$ (anyOf 7).resource_subtypestringOptionalType of the membership.
$ (anyOf 7).parentModelOptionalExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer parent — shared_parent_f6c1f3504a25
$ (anyOf 7).memberModelOptionalExpand Get a project membership — response body — data data member
$ (anyOf 7).access_levelstringOptionalThe member's access level in the record.
Known values: admin, editor, commenter, viewer
Read only: true

Referenced models: Get a goal — response body — data data custom fields item, Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor goal, Get a project membership — response body — data data member, Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor parent, Get a rate — response body — data data parent, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer parent — shared_parent_8a60f1590cfc, Get a membership — response body — data / data / access_level: admin, editor, user, viewer parent, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer parent — shared_parent_f6c1f3504a25, Get a portfolio membership — response body — data data portfolio — shared_portfolio_6b231006e493, Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor user, Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor workspace

Get multiple memberships — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a membership — response body — data data — sdk__Membership Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a membership — response body — data data — sdk__Membership Response

Get multiple memberships — response body — data, next page data item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Get multiple memberships — response body — data, next_page / data / item / access_level: viewer, commenter, editor, admin, role: commenter, editor
$ (anyOf 2)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Project Membership Compact Response
$ (anyOf 3)ModelAlternativeExpand Get multiple memberships — response body — data, next_page / data / item / access_level: admin, editor, viewer
$ (anyOf 4)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, user
$ (anyOf 5)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, user, viewer
$ (anyOf 6)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Table Membership Compact
$ (anyOf 7)ModelAlternativeExpand Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Record Membership Compact

Referenced models: Get a membership — response body — data / data / access_level: admin, editor, user, Get a membership — response body — data / data / access_level: admin, editor, user, viewer, Get multiple memberships — response body — data, next_page / data / item / access_level: viewer, commenter, editor, admin, role: commenter, editor, Get multiple memberships — response body — data, next_page / data / item / access_level: admin, editor, viewer, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Project Membership Compact Response, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Record Membership Compact, Get a membership — response body — data / data / access_level: admin, editor, commenter, viewer — Table Membership Compact

Get multiple memberships — response body — data, next_page / data / item / access_level: admin, editor, viewer

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a membership — response body — data / data / access_level: admin, editor, viewer
$ (allOf 2)objectAll variants apply
$ (allOf 2).resource_typestringOptionalThe base type of this resource.
$ (allOf 2).resource_subtypestringOptionalType of the membership.

Referenced models: Get a membership — response body — data / data / access_level: admin, editor, viewer

Get multiple memberships — response body — data, next_page / data / item / access_level: viewer, commenter, editor, admin, role: commenter, editor

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor access level: viewer, commenter, editor, admin, role: commenter, editor
$ (allOf 2)objectAll variants apply
$ (allOf 2).is_commenterbooleanOptional*Deprecated: new integrations should prefer the `access_level` field.* Describes if the member is comment only in goal. This field is deprecated and will always be null.
Read only: true
$ (allOf 2).is_editorbooleanOptional*Deprecated: new integrations should prefer the `access_level` field.* Describes if the member is editor in goal. This field is deprecated and will always be null.
Read only: true

Referenced models: Get a membership — response body — data / data / access_level: viewer, commenter, editor, admin, role: commenter, editor access level: viewer, commenter, editor, admin, role: commenter, editor

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.