Teams | Documentation | Contentful Docs

A team is a group of users in your organization. Teams can be given access to a space (via team space memberships) in the same way an individual user can.

Get all teams for an organization

This endpoint returns a paginated collection of all teams in this 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.

Response

1 {
2     "total": 1,
3     "limit": 25,
4     "skip": 0,
5     "sys": {
6         "type": "Array"
7     },
8     "items": [{
9         "name": "Home Department",
10         "description": "Furniture and accessories",
11         "sys": {
12             "id": "2v0NGpymMx5dc1sWjtiarg",
13             "type": "Team",
14             "organization": {
15                 "sys": {
16                     "type": "Link",
17                     "linkType": "Organization",
18                     "id": "4EJGvuLTBUMG2A6wS8gfAS"
19                 }
20             },
21             "createdAt": "2373-05-20T00:50:57.521Z",
22             "updatedAt": "3882-12-12T21:02:17.948Z",
23             "createdBy": {
24                 "sys": {
25                     "type": "Link",
26                     "linkType": "User",
27                     "id": "6i4t6xastbPBhgW7xDtpPH"
28                 }
29             },
30             "updatedBy": {
31                 "sys": {
32                     "type": "Link",
33                     "linkType": "User",
34                     "id": "4RP9VsYx86a44lASXtinmi"
35                 }
36             },
37             "memberCount": 0
38         }
39     }]
40 }

Get all teams for a space

This endpoint returns a paginated collection of all teams in this space.

All space members can access this endpoint.

Query Parameters

Name	Details	Description
`skip`, `limit`	-	Specify requested page of result set. See Pagination for more details.

Response

1 {
2     "total": 1,
3     "limit": 25,
4     "skip": 0,
5     "sys": {
6         "type": "Array"
7     },
8     "items": [{
9         "name": "Home Department",
10         "description": "Furniture and accessories",
11         "sys": {
12             "id": "2v0NGpymMx5dc1sWjtiarg",
13             "type": "Team",
14             "organization": {
15                 "sys": {
16                     "type": "Link",
17                     "linkType": "Organization",
18                     "id": "4EJGvuLTBUMG2A6wS8gfAS"
19                 }
20             },
21             "createdAt": "2373-05-20T00:50:57.521Z",
22             "updatedAt": "3882-12-12T21:02:17.948Z",
23             "createdBy": {
24                 "sys": {
25                     "type": "Link",
26                     "linkType": "User",
27                     "id": "6i4t6xastbPBhgW7xDtpPH"
28                 }
29             },
30             "updatedBy": {
31                 "sys": {
32                     "type": "Link",
33                     "linkType": "User",
34                     "id": "4RP9VsYx86a44lASXtinmi"
35                 }
36             },
37             "memberCount": 0
38         }
39     }]
40 }

Get a team

This endpoint returns details about an existing team.

All organization members can access this endpoint.

Response

1 {
2     "name": "Home Department",
3     "description": "Furniture and accessories",
4     "sys": {
5         "id": "2v0NGpymMx5dc1sWjtiarg",
6         "type": "Team",
7         "organization": {
8             "sys": {
9                 "type": "Link",
10                 "linkType": "Organization",
11                 "id": "4EJGvuLTBUMG2A6wS8gfAS"
12             }
13         },
14         "createdAt": "2373-05-20T00:50:57.521Z",
15         "updatedAt": "3882-12-12T21:02:17.948Z",
16         "createdBy": {
17             "sys": {
18                 "type": "Link",
19                 "linkType": "User",
20                 "id": "6i4t6xastbPBhgW7xDtpPH"
21             }
22         },
23         "updatedBy": {
24             "sys": {
25                 "type": "Link",
26                 "linkType": "User",
27                 "id": "4RP9VsYx86a44lASXtinmi"
28             }
29         },
30         "memberCount": 0
31     }
32 }

Create a team

This endpoint creates a new team in this organization.

Only organization admins and owners can access this endpoint.

Request Body

Parameter	Type	Usage
`name`	string	required
`description`	string or null	required

Response

1 {
2     "name": "Project Editors",
3     "description": "",
4     "sys": {
5         "id": "7BslKh9TdKGOK41VmLDjFZ",
6         "type": "Team",
7         "organization": {
8             "sys": {
9                 "type": "Link",
10                 "linkType": "Organization",
11                 "id": "4EJGvuLTBUMG2A6wS8gfAS"
12             }
13         },
14         "createdAt": "4723-11-14T02:01:24.016Z",
15         "updatedAt": "5087-06-17T18:24:44.837Z",
16         "updatedBy": {
17             "sys": {
18                 "type": "Link",
19                 "linkType": "User",
20                 "id": "7BslKh9TdKGOK41VmLDjFZ"
21             }
22         },
23         "createdBy": {
24             "sys": {
25                 "type": "Link",
26                 "linkType": "User",
27                 "id": "7BslKh9TdKGOK41VmLDjFZ"
28             }
29         },
30         "memberCount": 0
31     }
32 }

Update a team

This endpoint updates the data associated with a team.

Only organization admins and owners can access this endpoint.

Request Body

Parameter	Type	Usage
`name`	string	required
`description`	string or null	required

Response

1 {
2     "name": "Project Editors",
3     "description": "",
4     "sys": {
5         "id": "7BslKh9TdKGOK41VmLDjFZ",
6         "type": "Team",
7         "organization": {
8             "sys": {
9                 "type": "Link",
10                 "linkType": "Organization",
11                 "id": "4EJGvuLTBUMG2A6wS8gfAS"
12             }
13         },
14         "createdAt": "4723-11-14T02:01:24.016Z",
15         "updatedAt": "5087-06-17T18:24:44.837Z",
16         "updatedBy": {
17             "sys": {
18                 "type": "Link",
19                 "linkType": "User",
20                 "id": "7BslKh9TdKGOK41VmLDjFZ"
21             }
22         },
23         "createdBy": {
24             "sys": {
25                 "type": "Link",
26                 "linkType": "User",
27                 "id": "7BslKh9TdKGOK41VmLDjFZ"
28             }
29         },
30         "memberCount": 0
31     }
32 }

Delete a team

This endpoint deletes a team.

Only organization admins and owners can access this endpoint.

Response

Status: 204 No Content