• Teams Public API
    • Teams Members Public API
    Platform
    Teams / / Schemas

    Teams Members Public API

    Postman Collection
    OpenAPI
    POST

    Fetch a set of membership(s).

    Returns a set of account IDs who are members of the team, alongside a pagination cursor to retrieve the next page (if available).

    Request

    Path parameters

    orgId

    string

    Required
    teamId

    string

    Required

    Query parameters

    siteId

    string

    Request bodyapplication/json

    Optional Relay-style pagination controls. Can be omitted if empty.

    after

    string

    first

    integer

    Responses

    Team members were fetched successfully.

    */*

    PublicApiFetchResponsePublicApiMembershipAccountId
    POST/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}/members
    1 2 3 4 5 6 7 8 curl --request POST \ --url 'https://sitename.atlassian.net/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}/members' \ --header 'Accept: */*' \ --header 'Content-Type: application/json' \ --data '{ "after": "<string>", "first": 40 }'
    POST

    Add a set of membership(s).

    The account IDs specified will be added to the team.

    Request

    Path parameters

    orgId

    string

    Required
    teamId

    string

    Required

    Request bodyapplication/json

    A set of account IDs to add as members.

    members

    array<PublicApiMembership>

    Required

    Responses

    Team members were added successfully, at least partially. See the 'members' field of the response for any successful additions, and the 'errors' field of the response for any failed additions.

    */*

    PublicApiMembershipAddResponse
    POST/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}/members/add
    1 2 3 4 5 6 7 8 9 10 11 curl --request POST \ --url 'https://sitename.atlassian.net/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}/members/add' \ --header 'Accept: */*' \ --header 'Content-Type: application/json' \ --data '{ "members": [ { "accountId": "<string>" } ] }'
    POST

    Remove a set of membership(s).

    The account IDs specified will be removed from the team.

    Request

    Path parameters

    orgId

    string

    Required
    teamId

    string

    Required

    Request bodyapplication/json

    A set of account IDs to remove as members.

    members

    array<PublicApiMembership>

    Required

    Responses

    Team members were removed successfully, at least partially. See the 'errors' field of the response for any failed removals.

    */*

    PublicApiMembershipRemoveResponse
    POST/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}/members/remove
    1 2 3 4 5 6 7 8 9 10 11 curl --request POST \ --url 'https://sitename.atlassian.net/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}/members/remove' \ --header 'Accept: */*' \ --header 'Content-Type: application/json' \ --data '{ "members": [ { "accountId": "<string>" } ] }'

    Rate this page: