Join Community
DocsDeveloper GuideAPI DocumentationChangelog
Organization

Get Organization Details

Get your organization's name, settings, and configuration.

Returns your organization's details. The organization is identified automatically from your API token — no request body needed.

Required: Owner, Editor, or Viewer role

POST
/getOrganizationDetail

Authorization

bearerToken

AuthorizationBearer <token>

API token for YourGPT Public APIs. Create tokens in Settings > API Tokens in your YourGPT dashboard.

In: header

Request Body

application/json

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.yourgpt.ai/chatbot/v1/getOrganizationDetail" \  -H "Content-Type: application/json" \  -d '{}'
{
  "type": "RXSUCCESS",
  "message": "Data Fetched Successfully!",
  "data": {
    "id": 100,
    "name": "My Organization",
    "created_by": 42,
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z",
    "user": {
      "id": 42,
      "name": "John Doe",
      "email": "john@example.com"
    },
    "OrganizationMembers": [
      {
        "id": 201,
        "user_id": 42,
        "role": "owner",
        "createdAt": "2025-01-15T10:30:00.000Z"
      }
    ],
    "OrganizationProjects": [
      {
        "id": 12345,
        "name": "My Chatbot",
        "project_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    ]
  }
}
{
  "type": "RXERROR",
  "message": "Invalid params"
}
{
  "type": "RXERROR",
  "message": "Invalid or revoked API token"
}
{
  "type": "RXERROR",
  "message": "You do not have permission to perform this action"
}