Skip to main content
GET
/
radius
/
account-containers
List Containers
curl --request GET \
  --url https://api.altostrat.io/radius/account-containers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "parent_id": "<string>",
      "path": "<string>",
      "level": 123,
      "user_count": 123,
      "container_count": 123,
      "is_pinned": true,
      "metadata": {},
      "tags": [
        "<string>"
      ],
      "breadcrumbs": [
        {
          "id": "<string>",
          "name": "<string>",
          "level": 123
        }
      ],
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "pinned": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "parent_id": "<string>",
      "path": "<string>",
      "level": 123,
      "user_count": 123,
      "container_count": 123,
      "is_pinned": true,
      "metadata": {},
      "tags": [
        "<string>"
      ],
      "breadcrumbs": [
        {
          "id": "<string>",
          "name": "<string>",
          "level": 123
        }
      ],
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "pagination": {
    "per_page": 123,
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page
integer
default:25
cursor
string
parent_id
string

Filter by parent container ID. Omit to list root containers.

level
integer

Filter by hierarchy level.

include_pinned
boolean
default:false

Whether to include the 'pinned' collection in the response.

sort_by
enum<string>
Available options:
default,
name,
priority,
users,
containers
sort_dir
enum<string>
Available options:
asc,
desc

Response

200 - application/json

List of containers.

data
object[]
pinned
object[]
pagination
object