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

{
    "total": 1,
    "limit": 25,
    "skip": 0,
    "sys": {
        "type": "Array"
    },
    "items": [{
        "name": "Home Department",
        "description": "Furniture and accessories",
        "sys": {
            "id": "2v0NGpymMx5dc1sWjtiarg",
            "type": "Team",
            "organization": {
                "sys": {
                    "type": "Link",
                    "linkType": "Organization",
                    "id": "4EJGvuLTBUMG2A6wS8gfAS"
                }
            },
            "createdAt": "2373-05-20T00:50:57.521Z",
            "updatedAt": "3882-12-12T21:02:17.948Z",
            "createdBy": {
                "sys": {
                    "type": "Link",
                    "linkType": "User",
                    "id": "6i4t6xastbPBhgW7xDtpPH"
                }
            },
            "updatedBy": {
                "sys": {
                    "type": "Link",
                    "linkType": "User",
                    "id": "4RP9VsYx86a44lASXtinmi"
                }
            },
            "memberCount": 0
        }
    }]
}

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

{
    "total": 1,
    "limit": 25,
    "skip": 0,
    "sys": {
        "type": "Array"
    },
    "items": [{
        "name": "Home Department",
        "description": "Furniture and accessories",
        "sys": {
            "id": "2v0NGpymMx5dc1sWjtiarg",
            "type": "Team",
            "organization": {
                "sys": {
                    "type": "Link",
                    "linkType": "Organization",
                    "id": "4EJGvuLTBUMG2A6wS8gfAS"
                }
            },
            "createdAt": "2373-05-20T00:50:57.521Z",
            "updatedAt": "3882-12-12T21:02:17.948Z",
            "createdBy": {
                "sys": {
                    "type": "Link",
                    "linkType": "User",
                    "id": "6i4t6xastbPBhgW7xDtpPH"
                }
            },
            "updatedBy": {
                "sys": {
                    "type": "Link",
                    "linkType": "User",
                    "id": "4RP9VsYx86a44lASXtinmi"
                }
            },
            "memberCount": 0
        }
    }]
}

Get a team

This endpoint returns details about an existing team.

All organization members can access this endpoint.

Response

{
    "name": "Home Department",
    "description": "Furniture and accessories",
    "sys": {
        "id": "2v0NGpymMx5dc1sWjtiarg",
        "type": "Team",
        "organization": {
            "sys": {
                "type": "Link",
                "linkType": "Organization",
                "id": "4EJGvuLTBUMG2A6wS8gfAS"
            }
        },
        "createdAt": "2373-05-20T00:50:57.521Z",
        "updatedAt": "3882-12-12T21:02:17.948Z",
        "createdBy": {
            "sys": {
                "type": "Link",
                "linkType": "User",
                "id": "6i4t6xastbPBhgW7xDtpPH"
            }
        },
        "updatedBy": {
            "sys": {
                "type": "Link",
                "linkType": "User",
                "id": "4RP9VsYx86a44lASXtinmi"
            }
        },
        "memberCount": 0
    }
}

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

{
    "name": "Project Editors",
    "description": "",
    "sys": {
        "id": "7BslKh9TdKGOK41VmLDjFZ",
        "type": "Team",
        "organization": {
            "sys": {
                "type": "Link",
                "linkType": "Organization",
                "id": "4EJGvuLTBUMG2A6wS8gfAS"
            }
        },
        "createdAt": "4723-11-14T02:01:24.016Z",
        "updatedAt": "5087-06-17T18:24:44.837Z",
        "updatedBy": {
            "sys": {
                "type": "Link",
                "linkType": "User",
                "id": "7BslKh9TdKGOK41VmLDjFZ"
            }
        },
        "createdBy": {
            "sys": {
                "type": "Link",
                "linkType": "User",
                "id": "7BslKh9TdKGOK41VmLDjFZ"
            }
        },
        "memberCount": 0
    }
}

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

{
    "name": "Project Editors",
    "description": "",
    "sys": {
        "id": "7BslKh9TdKGOK41VmLDjFZ",
        "type": "Team",
        "organization": {
            "sys": {
                "type": "Link",
                "linkType": "Organization",
                "id": "4EJGvuLTBUMG2A6wS8gfAS"
            }
        },
        "createdAt": "4723-11-14T02:01:24.016Z",
        "updatedAt": "5087-06-17T18:24:44.837Z",
        "updatedBy": {
            "sys": {
                "type": "Link",
                "linkType": "User",
                "id": "7BslKh9TdKGOK41VmLDjFZ"
            }
        },
        "createdBy": {
            "sys": {
                "type": "Link",
                "linkType": "User",
                "id": "7BslKh9TdKGOK41VmLDjFZ"
            }
        },
        "memberCount": 0
    }
}

Delete a team

This endpoint deletes a team.

Only organization admins and owners can access this endpoint.

Response

Status: 204 No Content