Asana · Schema

GoalMembershipBase

This object represents a user's connection to a goal.

CollaborationProductivityProject ManagementProjectsTask ManagementTasksWorkflow

Properties

Name Type Description
gid string Globally unique identifier of the resource, as a string.
resource_type string The base type of this resource.
resource_subtype string The type of membership.
member object
parent object
role string *Deprecated: Describes if the member is a commenter or editor in goal.*
access_level string Describes if member is commenter or editor in goal. This is preferred over role
goal object
View JSON Schema on GitHub

JSON Schema

asana-goalmembershipbase-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GoalMembershipBase",
  "title": "GoalMembershipBase",
  "description": "This object represents a user's connection to a goal.",
  "type": "object",
  "properties": {
    "gid": {
      "description": "Globally unique identifier of the resource, as a string.",
      "type": "string",
      "readOnly": true,
      "example": "12345",
      "x-insert-after": false
    },
    "resource_type": {
      "description": "The base type of this resource.",
      "type": "string",
      "example": "membership"
    },
    "resource_subtype": {
      "type": "string",
      "readOnly": true,
      "description": "The type of membership.",
      "example": "goal_membership"
    },
    "member": {
      "$ref": "#/components/schemas/MemberCompact"
    },
    "parent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GoalCompact"
        },
        {
          "type": "object",
          "readOnly": true
        }
      ]
    },
    "role": {
      "type": "string",
      "description": "*Deprecated: Describes if the member is a commenter or editor in goal.*",
      "enum": [
        "commenter",
        "editor"
      ],
      "deprecated": true,
      "example": "editor"
    },
    "access_level": {
      "type": "string",
      "description": "Describes if member is commenter or editor in goal. This is preferred over role",
      "enum": [
        "commenter",
        "editor"
      ],
      "example": "editor"
    },
    "goal": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GoalCompact"
        },
        {
          "type": "object",
          "readOnly": true,
          "deprecated": true,
          "description": "*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."
        }
      ]
    }
  }
}