--- updatedAt: 2026-05-28T08:16:45.000Z agentTools: projectIndex: https://docs.scalr.io/llms.txt --- # List Teams The endpoint returns a list of [IAM](https://docs.scalr.io/docs/identity-and-access-management) teams. The endpoint supports filtering by team name (`filter[name]`), IdP (`filter[identity-provider]`) and team ID (`filter[team]=in:team-123,team-331`). # OpenAPI definition ```json { "components": { "schemas": { "Team": { "description": "A [IAM](https://docs.scalr.io/docs/identity-and-access-management) team is used to organize users into logical units.\n\nA team can not be used to group service accounts, only standard users.", "properties": { "attributes": { "properties": { "description": { "description": "The verbose description of the team.", "maxLength": 255, "nullable": true, "type": "string" }, "name": { "description": "The name of the team.", "maxLength": 255, "type": "string" } }, "required": [ "name" ], "type": "object" }, "id": { "readOnly": true, "type": "string" }, "links": { "properties": { "self": { "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object" }, "relationships": { "properties": { "account": { "description": "The account this team belongs to.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "accounts", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "identity-provider": { "description": "Identity provider of the team. Can be internal (Scalr) or external (LDAP/SAML)", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "identity-providers", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "users": { "description": "The list of users in the team.", "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "users", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "nullable": true, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "enum": [ "teams" ], "type": "string" } }, "required": [ "type", "attributes" ], "type": "object" }, "TeamListingDocument": { "description": "JSON:API Document Listing\n\nsee: https://jsonapi.org/format/#document-structure", "properties": { "data": { "items": { "$ref": "#/components/schemas/Team" }, "type": "array" }, "included": { "items": { "type": "object" }, "readOnly": true, "type": "array" }, "links": { "additionalProperties": { "type": "string" }, "readOnly": true, "type": "object" }, "meta": { "readOnly": true, "type": "object" } }, "type": "object" } }, "securitySchemes": { "API-Key": { "scheme": "bearer", "type": "http" } } }, "info": { "description": "Scalr IACP API", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "title": "Scalr IACP API", "version": "unversioned" }, "openapi": "3.0.0", "paths": { "/teams": { "get": { "description": "The endpoint returns a list of [IAM](https://docs.scalr.io/docs/identity-and-access-management) teams.\nThe endpoint supports filtering by team name (`filter[name]`), IdP (`filter[identity-provider]`)\nand team ID (`filter[team]=in:team-123,team-331`).\n", "operationId": "get_teams", "parameters": [ { "description": "Page number", "in": "query", "name": "page[number]", "required": false, "schema": { "type": "string" } }, { "description": "Page size", "in": "query", "name": "page[size]", "required": false, "schema": { "type": "string" } }, { "description": "The team name filter.", "in": "query", "name": "filter[name]", "required": false, "schema": { "type": "string" } }, { "description": "The identity provider filter.", "in": "query", "name": "filter[identity-provider]", "required": false, "schema": { "type": "string" } }, { "description": "The team filter.", "in": "query", "name": "filter[team]", "required": false, "schema": { "type": "string" } }, { "description": "The user filter.", "in": "query", "name": "filter[user]", "required": false, "schema": { "type": "string" } }, { "description": "The comma-separated list of relationship paths.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "account", "identity-provider", "users" ], "type": "string" }, "type": "array" } }, { "description": "The comma-separated list of attributes.", "explode": false, "in": "query", "name": "sort", "required": false, "schema": { "items": { "enum": [ "identity-provider", "name" ], "type": "string" }, "type": "array" } }, { "description": "Query string", "in": "query", "name": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "examples": { "default": { "value": "{\n \"data\": [\n {\n \"attributes\": {\n \"description\": null,\n \"name\": \"Users\"\n },\n \"id\": \"team-t67mjto75maj8p0\",\n \"links\": {\n \"self\": \"https://my.scalr.io/api/iacp/v3/teams/team-t67mjto75maj8p0\"\n },\n \"relationships\": {\n \"account\": null,\n \"identity-provider\": {\n \"data\": {\n \"id\": \"idp-sojhv9e9tfhao3g\",\n \"type\": \"identity-providers\"\n }\n },\n \"users\": null\n },\n \"type\": \"teams\"\n },\n {\n \"attributes\": {\n \"description\": \"Global admins\",\n \"name\": \"Admins\"\n },\n \"id\": \"team-t67mjto46ev8i38\",\n \"links\": {\n \"self\": \"https://my.scalr.io/api/iacp/v3/teams/team-t67mjto46ev8i38\"\n },\n \"relationships\": {\n \"account\": null,\n \"identity-provider\": {\n \"data\": {\n \"id\": \"idp-sojhv9e9tfhao3g\",\n \"type\": \"identity-providers\"\n }\n },\n \"users\": {\n \"data\": [\n {\n \"id\": \"user-suh84u730af2bm0\",\n \"type\": \"users\"\n }\n ]\n }\n },\n \"type\": \"teams\"\n },\n {\n \"attributes\": {\n \"description\": null,\n \"name\": \"Users\"\n },\n \"id\": \"team-t67mjtnokncjpd8\",\n \"links\": {\n \"self\": \"https://my.scalr.io/api/iacp/v3/teams/team-t67mjtnokncjpd8\"\n },\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"acc-svrcncgh453bi8g\",\n \"type\": \"accounts\"\n }\n },\n \"identity-provider\": {\n \"data\": {\n \"id\": \"idp-sohkb0o1phrdmr8\",\n \"type\": \"identity-providers\"\n }\n },\n \"users\": {\n \"data\": [\n {\n \"id\": \"user-suh84u6vuvidtbg\",\n \"type\": \"users\"\n },\n {\n \"id\": \"user-suh84u72gfrbd30\",\n \"type\": \"users\"\n }\n ]\n }\n },\n \"type\": \"teams\"\n },\n {\"...\": \"...\"}\n ],\n \"included\": null,\n \"links\": {\n \"first\": \"https://my.scalr.io/api/iacp/v3/teams?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\n \"last\": \"https://my.scalr.io/api/iacp/v3/teams?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\n \"next\": null,\n \"prev\": null,\n \"self\": \"https://my.scalr.io/api/iacp/v3/teams?page%5Bnumber%5D=1&page%5Bsize%5D=20\"\n },\n \"meta\": {\n \"pagination\": {\n \"current-page\": 1,\n \"next-page\": null,\n \"prev-page\": null,\n \"total-count\": 5,\n \"total-pages\": 1\n }\n }\n}" } }, "schema": { "$ref": "#/components/schemas/TeamListingDocument" } } }, "description": "Success." }, "403": { "description": "User unauthorized to perform this action." }, "4XX": { "description": "Client error." }, "5XX": { "description": "Server error." } }, "summary": "List Teams", "tags": [ "teams" ], "x-mcp-tool": true, "x-resource": "Team", "x-service": "tf-api" } } }, "security": [ { "API-Key": [] } ], "servers": [ { "url": "https://{Domain}/api/iacp/v3", "variables": { "Domain": { "default": "example.scalr.io", "description": "Domain where Scalr is hosted" } } } ] } ``` # Sibling pages * [Create a Team](https://docs.scalr.io/scalr/reference/create_team.md) * [Delete a Team](https://docs.scalr.io/scalr/reference/delete_team.md) * [Get a Team](https://docs.scalr.io/scalr/reference/get_team.md) * [Update a Team](https://docs.scalr.io/scalr/reference/update_team.md)