Skip to content

Gets information about the organization

get/v1/organizations/{slug}

OAuth scopes

  • organizations:read

The fine-grained token must include the following permissions to access this endpoint:

  • organization_admin_read

Path parameters

  • slug
    Required
    string

    Organization slug

Response codes

  • 200
  • 401
  • 403
  • 429

Response (200)

{
"id": "lorem",
"name": "lorem",
"plan": "free",
"opt_in_tags": [
"AI_SQL_GENERATOR_OPT_IN"
],
"allowed_release_channels": [
"internal"
]
}
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"plan": {
"type": "string",
"enum": [
"free",
"pro",
"team",
"enterprise",
"platform"
]
},
"opt_in_tags": {
"type": "array",
"items": {
"enum": [
"AI_SQL_GENERATOR_OPT_IN",
"AI_DATA_GENERATOR_OPT_IN",
"AI_LOG_GENERATOR_OPT_IN"
]
}
},
"allowed_release_channels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"internal",
"alpha",
"beta",
"ga",
"withdrawn",
"preview"
]
}
}
},
"required": [
"id",
"name",
"opt_in_tags",
"allowed_release_channels"
]
}