--- updatedAt: 2026-05-28T08:16:45.000Z agentTools: projectIndex: https://docs.scalr.io/llms.txt --- # List Account to User relationships This endpoint returns a list of `AccountUser` resources. To get the list of accounts the user has access to, the `filter[user]` has to be specified. To get the list of users that have access to an account the `filter[account]` has to be specified. # OpenAPI definition ```json { "components": { "schemas": { "AccountUser": { "description": "Represents an account-user relation.", "properties": { "attributes": { "properties": { "last-login-at": { "description": "The UTC timestamp when the user logged in to the account.", "format": "date-time", "nullable": true, "type": "string" }, "status": { "description": "The relation status. Can be: `Active`, `Inactive`, `Pending`.", "enum": [ "Active", "Inactive", "Pending" ], "type": "string" } }, "type": "object" }, "id": { "readOnly": true, "type": "string" }, "links": { "additionalProperties": { "type": "string" }, "type": "object" }, "relationships": { "properties": { "account": { "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "accounts", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "teams": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "teams", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "nullable": true, "type": "array" } }, "required": [ "data" ], "type": "object" }, "user": { "properties": { "data": { "nullable": true, "properties": { "id": { "type": "string" }, "type": { "enum": [ "users", "" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "enum": [ "account-users" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "AccountUserListingDocument": { "description": "JSON:API Document Listing\n\nsee: https://jsonapi.org/format/#document-structure", "properties": { "data": { "items": { "$ref": "#/components/schemas/AccountUser" }, "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": { "/account-users": { "get": { "description": "This endpoint returns a list of `AccountUser` resources.\n\nTo get the list of accounts the user has access to, the `filter[user]` has to be specified.\nTo get the list of users that have access to an account the `filter[account]` has to be specified.\n", "operationId": "get_account_users", "parameters": [ { "description": "The account filter.", "in": "query", "name": "filter[account]", "required": false, "schema": { "type": "string" } }, { "description": "The user filter.", "in": "query", "name": "filter[user]", "required": false, "schema": { "type": "string" } }, { "description": "The Team filter.", "in": "query", "name": "filter[team]", "required": false, "schema": { "type": "string" } }, { "description": "The AccountUser status filter.", "in": "query", "name": "filter[status]", "required": false, "schema": { "type": "string" } }, { "description": "List only users who have admin role on the account.", "in": "query", "name": "filter[is-admin]", "required": false, "schema": { "type": "string" } }, { "description": "Query string", "in": "query", "name": "query", "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 attributes.", "explode": false, "in": "query", "name": "sort", "required": false, "schema": { "items": { "enum": [ "created-at", "email", "full-name", "last-login-at", "status" ], "type": "string" }, "type": "array" } }, { "description": "The comma-separated list of relationship paths.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "account", "teams", "user" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "examples": { "default": { "value": "{\n \"data\": [\n {\n \"attributes\": {\n \"status\": \"Pending\"\n },\n \"id\": \"2442bdc2-8243-6968-82bf-a74878980074\",\n \"links\": {},\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"acc-tmhltms60l40m9o\",\n \"type\": \"accounts\"\n }\n },\n \"teams\": {\n \"data\": [\n {\n \"id\": \"team-tmhlublsnv43mt8\",\n \"type\": \"teams\"\n }\n ]\n },\n \"user\": {\n \"data\": {\n \"id\": \"user-suh84u6vuvidtbg\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"account-users\"\n },\n {\n \"attributes\": {\n \"status\": \"Active\"\n },\n \"id\": \"23651ae8-00e6-6c2c-f215-c3c026c9c721\",\n \"links\": {},\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"acc-svrcncgh453bi8g\",\n \"type\": \"accounts\"\n }\n },\n \"teams\": {\n \"data\": [\n {\n \"id\": \"team-t67mjtnokncjpd8\",\n \"type\": \"teams\"\n }\n ]\n },\n \"user\": {\n \"data\": {\n \"id\": \"user-suh84u6vuvidtbg\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"account-users\"\n }\n ],\n \"included\": null,\n \"links\": {\n \"first\": \"https://my.scalr.io/api/iacp/v3/account-users?filter%5Buser%5D=user-suh84u6vuvidtbg&page%5Bnumber%5D=1&page%5Bsize%5D=3\",\n \"last\": \"https://my.scalr.io/api/iacp/v3/account-users?filter%5Buser%5D=user-suh84u6vuvidtbg&page%5Bnumber%5D=1&page%5Bsize%5D=3\",\n \"next\": null,\n \"prev\": null,\n \"self\": \"https://my.scalr.io/api/iacp/v3/account-users?filter%5Buser%5D=user-suh84u6vuvidtbg&page%5Bnumber%5D=1&page%5Bsize%5D=3\"\n },\n \"meta\": {\n \"pagination\": {\n \"current-page\": 1,\n \"next-page\": null,\n \"prev-page\": null,\n \"total-count\": 2,\n \"total-pages\": 1\n }\n }\n}" } }, "schema": { "$ref": "#/components/schemas/AccountUserListingDocument" } } }, "description": "Success." }, "403": { "description": "User unauthorized to perform this action." }, "4XX": { "description": "Client error." }, "5XX": { "description": "Server error." } }, "summary": "List Account to User relationships", "tags": [ "accounts-users" ], "x-resource": "User", "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" } } } ] } ```