コンテンツにスキップ
Authrim

List organizations.

GET
/api/admin/organizations
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/organizations?page=1&limit=20' \
  --header 'Authorization: Bearer <token>'

Lists organizations in the current tenant with page/limit pagination and optional search, active-state, plan, and organization-type filters. Timestamps are returned in milliseconds.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
integer
default: 1 >= 1

Page number.

limit
integer
default: 20 >= 1

Page size.

search
string

Escaped LIKE search over name and display_name.

is_active
boolean

Filter by active state.

plan
string

Filter by organization plan.

org_type
string

Filter by organization type.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Organization list response.

Media type application/json
object
organizations
required
Array<object>
object
id
required
string
tenant_id
required
string
name
required
string
display_name
required
string | null
parent_org_id
required
string | null
path
required
string
depth
required
integer
org_type
required
string
metadata_json
object
key
additional properties
is_active
required
boolean
created_at
required
integer format: int64
updated_at
required
integer format: int64
member_count
integer
key
additional properties
pagination
required
object
page
required
integer
>= 1
limit
required
integer
>= 1
total
required
integer
totalPages
required
integer
hasNext
required
boolean
hasPrev
required
boolean
key
additional properties
key
additional properties
Example 
{
  "organizations": [
    {
      "id": "org_acme",
      "tenant_id": "default",
      "name": "engineering",
      "display_name": "Engineering",
      "parent_org_id": null,
      "path": "/engineering",
      "depth": 0,
      "org_type": "department",
      "metadata_json": {},
      "is_active": true,
      "created_at": 1770000000,
      "updated_at": 1770000000,
      "member_count": 12
    }
  ]
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}