Team membership is what defines a relationship between users and teams.
Methods
This endpoint has the following methods:
-
GET https://flow.pluralsight.com/v3/customer/core/team_membership
: Gets a list of team memberships and their associated information. -
POST https://flow.pluralsight.com/v3/customer/core/team_membership
: Creates a new team membership. -
GET https://flow.pluralsight.com/v3/customer/core/team_membership/{id}
: Gets information for a team membership by membership ID. -
PUT https://flow.pluralsight.com/v3/customer/core/team_membership/{id}
: Updates a team membership by membership ID. -
DELETE https://flow.pluralsight.com/v3/customer/core/teams/{id}
: Deletes a team membership by membership ID.
Note: The IDs referenced in these methods are always the team membership ID, not the apex user ID or team ID.
Parameters
Name | Type | Description |
---|---|---|
id | double | Unique identifier for the team membership. |
membership_type | string | Membership type. |
apex_user | string | Filter-traversable object. |
apex_user_id | string | Unique identifier for the main user record for multiple user aliases. |
team | string | Filter-traversable object. |
team_id | double | Unique identifier for a team. |
team_ancestor_id | double | Match team member who are a member of the team or its descendant teams. |
depth | string | Saved for future use |
Example response
{
"id": 2377250,
"membership_type": "contributor",
"apex_user": {
"id": 8024208,
"name": "Stephanie Ventura",
"email": "sventura@example.com",
"avatar_url": "https://secure.gravatar.com/avatar/example.jpg"
},
"apex_user_id": 8024208,
"team": {
"id": 258306,
"name": "Engineering team",
"description": "Engineers",
"org": 1234,
"avatar": null,
"vendor": null,
"created_at": "2024-11-11T11:35:18.326116",
"parent": null,
"path": "258306",
"visibility": "SHOW",
"inherited_depth": null,
"nested_teams": 0,
"all_users": 53,
"unnested_users": 53,
"depth": "atomic"
},
"depth": "inherit"
}