Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Teams

Get team memberships

Get a paginated list of members for a team

get/api/v2/team/{team_id}/memberships

Path parameters

team_idstring required

None

Query parameters

page[size]integer
Example:10

Size for a given page. The maximum allowed value is 100.

page[number]integer

Specific page number to return.

sort'manager_name' | '-manager_name' | 'name' | '-name' | 'handle' | '-handle' | 'email' | '-email'

Specifies the order of returned team memberships

Specifies the order of returned team memberships

filter[keyword]string

Search query, can be user email or name

Response

Represents a user's association to a team

Example response

{
  "data": [
    {
      "id": "TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835",
      "relationships": {
        "team": {
          "data": {
            "id": "d7e15d9d-d346-43da-81d8-3d9e71d9a5e9",
            "type": "team"
          }
        },
        "user": {
          "data": {
            "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001",
            "type": "users"
          }
        }
      },
      "type": "team_memberships"
    }
  ],
  "included": [
    {
      "relationships": {
        "org": {
          "data": {
            "id": "00000000-0000-beef-0000-000000000000",
            "type": "orgs"
          }
        },
        "other_orgs": {
          "data": []
        },
        "other_users": {
          "data": []
        },
        "roles": {
          "data": [
            {
              "id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
              "type": "roles"
            }
          ]
        }
      },
      "type": "users"
    }
  ]
}