Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 4.25 KB

ProjectMembershipsApi.md

File metadata and controls

107 lines (76 loc) · 4.25 KB
Raw

Asana.ProjectMembershipsApi

All URIs are relative to https://app.asana.com/api/1.0

Method HTTP request Description
getProjectMembership GET /project_memberships/{project_membership_gid} Get a project membership
getProjectMembershipsForProject GET /projects/{project_gid}/project_memberships Get memberships from a project

getProjectMembership

Get a project membership

Returns the complete project record for a single project membership.

(more information)

Example

const Asana = require('asana');

let client = Asana.ApiClient.instance;
let token = client.authentications['token'];
token.accessToken = '<YOUR_ACCESS_TOKEN>';

let projectMembershipsApiInstance = new Asana.ProjectMembershipsApi();
let project_membership_gid = "1331"; // String | 
let opts = { 
    'opt_fields': "access_level,member,member.name,parent,parent.name,project,project.name,user,user.name,write_access"
};
projectMembershipsApiInstance.getProjectMembership(project_membership_gid, opts).then((result) => {
    console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
}, (error) => {
    console.error(error.response.body);
});

Parameters

Name Type Description Notes
project_membership_gid String
opt_fields Object This endpoint returns a compact 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. [optional]

Return type

object

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8

getProjectMembershipsForProject

Get memberships from a project

Returns the compact project membership records for the project.

(more information)

Example

const Asana = require('asana');

let client = Asana.ApiClient.instance;
let token = client.authentications['token'];
token.accessToken = '<YOUR_ACCESS_TOKEN>';

let projectMembershipsApiInstance = new Asana.ProjectMembershipsApi();
let project_gid = "1331"; // String | Globally unique identifier for the project.
let opts = { 
    'user': "me", 
    'limit': 50, 
    'offset': "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", 
    'opt_fields': "access_level,member,member.name,offset,parent,parent.name,path,uri"
};
projectMembershipsApiInstance.getProjectMembershipsForProject(project_gid, opts).then((result) => {
    console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
}, (error) => {
    console.error(error.response.body);
});

Parameters

Name Type Description Notes
project_gid String Globally unique identifier for the project.
user String A string identifying a user. This can either be the string &quot;me&quot;, an email, or the gid of a user. [optional]
limit Number Results per page. The number of objects to return per page. The value must be between 1 and 100. [optional]
offset String 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. [optional]
opt_fields Object This endpoint returns a compact 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. [optional]

Return type

object

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8