Skip to main content

List of project members

GET 
/v2/orgs/:org_id/teams/:team_id/projects/:project_id/members

Retrieves the list of members for a specific project.

Required scope

projects:read

Rate limiting

Level 1

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

Request​

Path Parameters

    org_id stringrequired

    The ID of the organization to which the project belongs.

    Example: 3074457345618265000
    team_id stringrequired

    The ID of the team to which the project belongs.

    Example: 3074457345619012000
    project_id stringrequired

    The ID of the project for which you want to retrieve the list of members.

    Example: 3074457345618265000

Query Parameters

    limit int32

    Possible values: >= 1 and <= 100

    Default value: 100

    The maximum number of results to return per call. If the number of project members in the response is greater than the limit specified, the response returns the cursor parameter with a value.

    Example: 100
    cursor string

    An indicator of the position of a page in the full set of results. To obtain the first page leave it empty. To obtain subsequent pages set it to the value returned in the cursor field of the previous request.

    Example: 3074457345618265000

Responses​

Page of project member

Schema

    limit int32required

    Possible values: >= 1 and <= 100

    Default value: 100

    The maximum number of results to return per call. If the number of project member in the response is greater than the limit specified, the response returns the cursor parameter with a value.

    size int32required

    Possible values: <= 100

    Default value: 100

    Number of results returned in the response considering the cursor and the limit values sent in the request. For example, if there are 20 results, the request does not have a cursor value, and the limit set to 10, the size of the results will be 10. In this example, the response will also return a cursor value that can be used to retrieve the next set of 10 remaining results in the collection.

    data

    object[]

    required

    Contains the result data.

  • Array [

    • id stringrequired

    ID of the project member.

    email stringrequired

    Email ID of the project member.

    role ProjectRole (string)required

    Possible values: [owner, editor, viewer, commentator, coowner]

    Role of the project member.

    type stringrequired

    Default value: project_member

    Type of the object

  • ]

    • cursor string

    Indicator of the position of the next page of the result. To retrieve the next page, make another query setting its cursor field to the value returned by the current query. If the value is empty, there are no more pages to fetch.

    type string

    Default value: cursor-list

    Type of the object returned.

Loading...