v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB
Organization

Get Organization

Fetch the details of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.

get/api/organization/{organization_id}

Path parameters

organization_idstring uuid required

The id of the organization you want to fetch.

Headers

TR-Organizationstring uuid required

The organization id to use for the request

Response

Organization with the id that was requested

Example response

{
  "organization": {
    "created_at": "2021-01-01 00:00:00.000",
    "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
    "name": "Trieve",
    "registerable": true,
    "updated_at": "2021-01-01 00:00:00.000"
  },
  "plan": {
    "amount": 1000,
    "chunk_count": 1000,
    "created_at": "2021-01-01 00:00:00.000",
    "dataset_count": 1,
    "file_storage": 512,
    "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
    "message_count": 1000,
    "name": "Free",
    "stripe_id": "plan_123",
    "updated_at": "2021-01-01 00:00:00.000",
    "user_count": 5
  },
  "subscription": {
    "created_at": "2021-01-01 00:00:00.000",
    "current_period_end": "2021-01-01 00:00:00.000",
    "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
    "organization_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
    "plan_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
    "stripe_id": "sub_123",
    "updated_at": "2021-01-01 00:00:00.000"
  }
}