--- updatedAt: 2026-05-28T08:16:45.000Z agentTools: projectIndex: https://docs.scalr.io/llms.txt --- # List Accounts # OpenAPI definition ```json { "components": { "schemas": { "Account": { "description": "API Resource for the account.", "properties": { "attributes": { "properties": { "allowed-ips": { "description": "The list of allowed IP networks for IP fencing", "items": { "format": "ipv4network", "type": "string" }, "type": "array" }, "billing-plan-addons": { "description": "Enterprise addon features active for this account's billing plan.", "items": { "enum": [ "bf-audit-log", "bf-storage-profiles", "bf-scim", "bf-byok", "bf-control-tower", "bf-ai-usage", "bf-audit-log-sp" ], "type": "string" }, "nullable": true, "readOnly": true, "type": "array" }, "created-at": { "format": "date-time", "readOnly": true, "type": "string" }, "last-login-attempt-at": { "deprecated": true, "format": "date-time", "nullable": true, "readOnly": true, "type": "string" }, "login-attempts": { "deprecated": true, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "description": "The name of the account", "maxLength": 255, "type": "string" }, "quotas": { "description": "The list of account's quotas", "properties": { "agents": { "default": 2, "description": "The maximal number of agents", "minimum": -1, "type": "integer" }, "environments": { "default": 10, "description": "The maximal number of environments", "minimum": -1, "type": "integer" }, "max-concurrent-runs": { "default": 5, "description": "The maximal number of concurrent runs, -1 for unlimited", "minimum": -1, "type": "integer" }, "policy-group-checks-available": { "default": true, "description": "Indicates if the policy group checks are available for an account", "type": "boolean" }, "policy-groups": { "default": 100, "description": "The maximal number of policy groups", "minimum": -1, "type": "integer" }, "registry-modules": { "default": 100, "description": "The maximal number of registry modules", "minimum": -1, "type": "integer" }, "run-triggers": { "default": 50, "description": "The maximal number of run triggers", "minimum": -1, "type": "integer" }, "users": { "default": 100, "description": "The maximal number of users", "minimum": -1, "type": "integer" }, "vcs-providers": { "default": 5, "description": "The maximal number of VCS providers", "minimum": -1, "type": "integer" }, "workspaces": { "default": 100, "description": "The maximal number of workspaces, -1 for unlimited", "minimum": -1, "type": "integer" } }, "type": "object" }, "support-access-enabled": { "default": true, "description": "If enabled, Scalr support staff will be able to access the account for troubleshooting purposes.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "id": { "readOnly": true, "type": "string" }, "links": { "properties": { "self": { "readOnly": true, "type": "string" } }, "readOnly": true, "type": "object" }, "relationships": { "properties": { "billing-plan": { "description": "The billing plan of this account", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "billing-plans", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "readOnly": true, "required": [ "data" ], "type": "object" }, "identity-provider": { "description": "The identity provider of this account", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "identity-providers", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "owner": { "description": "The user that owns this account", "properties": { "data": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "users", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "runner-image-version": { "description": "Default runner image version for Scalr-managed agent pools.", "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "container-image-versions", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } }, "required": [ "owner" ], "type": "object" }, "type": { "enum": [ "accounts" ], "type": "string" } }, "required": [ "type", "attributes", "relationships" ], "type": "object" }, "AccountListingDocument": { "description": "JSON:API Document Listing\n\nsee: https://jsonapi.org/format/#document-structure", "properties": { "data": { "items": { "$ref": "#/components/schemas/Account" }, "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": { "/accounts": { "get": { "operationId": "get_accounts", "parameters": [ { "description": "The account name filter.", "in": "query", "name": "filter[name]", "required": false, "schema": { "type": "string" } }, { "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 comma-separated list of relationship paths.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "billing-plan", "identity-provider", "owner", "runner-image-version" ], "type": "string" }, "type": "array" } }, { "description": "The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.", "explode": true, "in": "query", "name": "fields", "required": false, "schema": { "properties": { "accounts": { "description": "The comma-separated list of fields to return in response for Account resource.", "type": "string" }, "billing-plans": { "description": "The comma-separated list of fields to return in response for BillingPlan resource.", "type": "string" }, "container-image-versions": { "description": "The comma-separated list of fields to return in response for ContainerImageVersion resource.", "type": "string" }, "identity-providers": { "description": "The comma-separated list of fields to return in response for IdentityProvider resource.", "type": "string" }, "users": { "description": "The comma-separated list of fields to return in response for User resource.", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AccountListingDocument" } } }, "description": "Success." }, "4XX": { "description": "Client error." }, "5XX": { "description": "Server error." } }, "summary": "List Accounts", "tags": [ "accounts" ], "x-resource": "Account", "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 * [Get an Account](https://docs.scalr.io/scalr/reference/get_account.md) * [Update Account](https://docs.scalr.io/scalr/reference/update_account.md) * [Shows Account Metrics](https://docs.scalr.io/scalr/reference/get_metrics.md) * [Delete SSO bypass users of the account](https://docs.scalr.io/scalr/reference/delete_sso_bypass_users.md) * [List SSO bypass users of the account](https://docs.scalr.io/scalr/reference/list_sso_bypass_users.md) * [Replace SSO bypass users of the account](https://docs.scalr.io/scalr/reference/replace_sso_bypass_users.md) * [Add SSO bypass users to the account](https://docs.scalr.io/scalr/reference/add_sso_bypass_users.md)