Team Memberships | Documentation

Group Team Memberships

Team memberships represent the relationship between an organization member and a team within your organization. In other words, they are the data object that defines explicitly who is a member of a team.

Get all team memberships in a team

This endpoint returns a paginated collection of all team memberships for this team.

All organization members can access this endpoint.

Query Parameters

Name	Details	Description
`skip`, `limit`	-	Specify requested page of result set. See Pagination for more details.
`order`	Supported values: `sys.createdAt`, `sys.updatedAt`	Specify sort order of result set. See Sorting Results for more details.
`include`	Supported values: `sys.createdBy`, `sys.updatedBy`, `sys.organizationMembership`, `sys.user`	Specify linked resources to include in response. See Including Related Resources for more details.

Response

1 {
2     "total": 1,
3     "limit": 25,
4     "skip": 0,
5     "sys": {
6         "type": "Array"
7     },
8     "items": [
9         {
10             "sys": {
11                 "type": "TeamMembership",
12                 "id": "5xKNPxTNPnKr8JHNHYbQeC",
13                 "organization": {
14                     "sys": {
15                         "type": "Link",
16                         "linkType": "Organization",
17                         "id": "4EJGvuLTBUMG2A6wS8gfAS"
18                     }
19                 },
20                 "team": {
21                     "sys": {
22                         "type": "Link",
23                         "linkType": "Organization",
24                         "id": "4E6i5or8iabA6wS8gfASfa"
25                     }
26                 },
27                 "createdAt": "4511-01-18T05:03:01.695Z",
28                 "updatedAt": "4203-08-22T19:00:01.887Z",
29                 "createdBy": {
30                     "sys": {
31                         "type": "Link",
32                         "linkType": "User",
33                         "id": "3Z6OpTgoCqMTwQ331UvyF4"
34                     }
35                 },
36                 "updatedBy": {
37                     "sys": {
38                         "type": "Link",
39                         "linkType": "User",
40                         "id": "6i5or8iabD6qwHCK7JgGLn"
41                     }
42                 },
43                 "organizationMembership": {
44                     "sys": {
45                         "type": "Link",
46                         "linkType": "OrganizationMembership",
47                         "id": "1UeTxCQ2SDqNgnE5zBvruF"
48                     }
49                 },
50                 "user": {
51                     "sys": {
52                         "type": "Link",
53                         "linkType": "User",
54                         "id": "1VVPdngQPz6Qo5Qbba4zzY"
55                     }
56                 }
57             }
58         }
59     ]
60 }

Get all team memberships in an organization

This endpoint returns a paginated collection of all team memberships across all teams in the organization.

All organization members can access this endpoint.

Query Parameters

Name	Details	Description
`skip`, `limit`	-	Specify requested page of result set. See Pagination for more details.
`order`	Supported values: `sys.createdAt`, `sys.updatedAt`	Specify sort order of result set. See Sorting Results for more details.
`include`	Supported values: `sys.team`	Specify linked resources to include in response. See Including Related Resources for more details.
Filters	See section below	Specify a value to filter against for the provided attribute. See Filtering Results for more information, and below for details about supported attributes for this endpoint.

Filter Parameters

See Filtering Results for details about how to use attributes and operators to construct query filters.

Attribute	Supported Operators	Supported Values
`sys.organizationMembership.sys.id`	`eq`, `ne`, `in`, `nin`	String (id)

Response

1 {
2     "total": 1,
3     "limit": 25,
4     "skip": 0,
5     "sys": {
6         "type": "Array"
7     },
8     "items": [
9         {
10             "sys": {
11                 "type": "TeamMembership",
12                 "id": "5xKNPxTNPnKr8JHNHYbQeC",
13                 "organization": {
14                     "sys": {
15                         "type": "Link",
16                         "linkType": "Organization",
17                         "id": "4EJGvuLTBUMG2A6wS8gfAS"
18                     }
19                 },
20                 "team": {
21                     "sys": {
22                         "type": "Link",
23                         "linkType": "Organization",
24                         "id": "4E6i5or8iabA6wS8gfASfa"
25                     }
26                 },
27                 "createdAt": "4511-01-18T05:03:01.695Z",
28                 "updatedAt": "4203-08-22T19:00:01.887Z",
29                 "createdBy": {
30                     "sys": {
31                         "type": "Link",
32                         "linkType": "User",
33                         "id": "3Z6OpTgoCqMTwQ331UvyF4"
34                     }
35                 },
36                 "updatedBy": {
37                     "sys": {
38                         "type": "Link",
39                         "linkType": "User",
40                         "id": "6i5or8iabD6qwHCK7JgGLn"
41                     }
42                 },
43                 "organizationMembership": {
44                     "sys": {
45                         "type": "Link",
46                         "linkType": "OrganizationMembership",
47                         "id": "1UeTxCQ2SDqNgnE5zBvruF"
48                     }
49                 },
50                 "user": {
51                     "sys": {
52                         "type": "Link",
53                         "linkType": "User",
54                         "id": "1VVPdngQPz6Qo5Qbba4zzY"
55                     }
56                 }
57             }
58         }
59     ]
60 }

Get a team membership

This endpoint returns details about an existing team membership.

All organization members can access this endpoint.

Response

1 {
2     "sys": {
3         "type": "TeamMembership",
4         "id": "5xKNPxTNPnKr8JHNHYbQeC",
5         "organization": {
6             "sys": {
7                 "type": "Link",
8                 "linkType": "Organization",
9                 "id": "4EJGvuLTBUMG2A6wS8gfAS"
10             }
11         },
12         "team": {
13             "sys": {
14                 "type": "Link",
15                 "linkType": "Organization",
16                 "id": "OpTgoCqMTwTBUMG2A6w7Jg"
17             }
18         },
19         "createdAt": "4511-01-18T05:03:01.695Z",
20         "updatedAt": "4203-08-22T19:00:01.887Z",
21         "createdBy": {
22             "sys": {
23                 "type": "Link",
24                 "linkType": "User",
25                 "id": "3Z6OpTgoCqMTwQ331UvyF4"
26             }
27         },
28         "updatedBy": {
29             "sys": {
30                 "type": "Link",
31                 "linkType": "User",
32                 "id": "6i5or8iabD6qwHCK7JgGLn"
33             }
34         },
35         "organizationMembership": {
36             "sys": {
37                 "type": "Link",
38                 "linkType": "OrganizationMembership",
39                 "id": "1UeTxCQ2SDqNgnE5zBvruF"
40             }
41         },
42         "user": {
43             "sys": {
44                 "type": "Link",
45                 "linkType": "User",
46                 "id": "1VVPdngQPz6Qo5Qbba4zzY"
47             }
48         }
49     }
50 }

Create a team membership

This endpoint creates a new team membership in this team.

Only organization admins and owners can access this endpoint.

Request Body

Parameter	Type	Usage
`organizationMembershipId`	string	required

Response

1 {
2     "sys": {
3         "type": "TeamMembership",
4         "id": "5sjDwHAf1FRG65kPCwgzxc",
5         "organization": {
6             "sys": {
7                 "type": "Link",
8                 "linkType": "Organization",
9                 "id": "4EJGvuLTBUMG2A6wS8gfAS"
10             }
11         },
12         "team": {
13             "sys": {
14                 "type": "Link",
15                 "linkType": "Organization",
16                 "id": "OpTgoCqMTwTBUMG2A6w7Jg"
17             }
18         },
19         "createdAt": "4471-03-29T09:18:21.619Z",
20         "updatedAt": "4034-04-24T14:33:27.720Z",
21         "createdBy": {
22             "sys": {
23                 "type": "Link",
24                 "linkType": "User",
25                 "id": "5sjDwHAf1FRG65kPCwgzxc"
26             }
27         },
28         "updatedBy": {
29             "sys": {
30                 "type": "Link",
31                 "linkType": "User",
32                 "id": "5sjDwHAf1FRG65kPCwgzxc"
33             }
34         },
35         "organizationMembership": {
36             "sys": {
37                 "type": "Link",
38                 "linkType": "OrganizationMembership",
39                 "id": "2J75WDB0QSfoBCn2IYTXzm"
40             }
41         },
42         "user": {
43             "sys": {
44                 "type": "Link",
45                 "linkType": "User",
46                 "id": "3sTeMpHKBy4Yycw6xmki6W"
47             }
48         }
49     }
50 }

Delete a team membership

This endpoint deletes a team membership.

Only organization admins and owners can access this endpoint.

Response

Status: 204 No Content