Skip to main content
GET
/
api
/
organization
/
{organization_id}
Get Organization
curl --request GET \
  --url https://api.trieve.ai/api/organization/{organization_id} \
  --header 'Authorization: <api-key>' \
  --header 'TR-Organization: <tr-organization>'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Organization
string<uuid>
required

The organization id to use for the request

Path Parameters

​
organization_id
string<uuid>
required

The id of the organization you want to fetch.

Response

Organization with the id that was requested

​
organization
object
required
Example:
{
  "created_at": "2021-01-01 00:00:00.000",
  "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "name": "Trieve",
  "partner_configuration": {
    "COMPANY_NAME": "Trieve",
    "DEMO_DOMAIN": "demos.trieve.ai",
    "FAVICON_URL": "https://cdn.trieve.ai/favicon.ico"
  },
  "registerable": true,
  "updated_at": "2021-01-01 00:00:00.000"
}
​
plan
object
  • Option 1
  • Option 2
Example:
{
  "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,
  "messages_per_month": 1000,
  "name": "Free",
  "stripe_id": "plan_123",
  "updated_at": "2021-01-01 00:00:00.000",
  "user_count": 5
}
​
subscription
object
  • Option 1
  • Option 2
Example:
{
  "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"
}