Get an administered organization
Portal · getPortalOrganization
GET
/portal/organizations/{organizationId}Base URL: https://api.businessmode.io/v1
Authentication
Human bearer token
The requirement above comes from this operation's OpenAPI security declaration. See Authentication.
Parameters
| Name | In | Required | Type and constraints |
|---|---|---|---|
organizationId | path | Yes | stringFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Request body
No request body is defined.
Responses
For status codes, request IDs, and safe retry decisions, see Errors & recovery. Known-code descriptions below are operation-specific, not a complete global error enum.
200 Successful response.
Content type: application/json
object · PortalOrganizationResponse
- No additional properties
| Field | Type | Required | Description / constraints |
|---|---|---|---|
externalId | anyOf | Yes | View nested schemaanyOf anyOf · 2 alternatives Alternative 1string
Alternative 2null |
id | string | Yes | Format: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
name | string | Yes | Minimum length: 1 · Maximum length: 200 |
projectId | string | Yes | Format: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
400 Invalid request.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
401 Authentication failed.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
404 The authorized resource was not found.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
429 Too many requests. Honor Retry-After before retrying with the same logical Idempotency-Key, where required. Known error codes: rate_limit_exceeded.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|
500 An unexpected server error occurred.
Content type: application/json
object · ErrorResponse
- No additional properties
| Field | Type | Required | Description / constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error | object | Yes | No additional propertiesView nested schemaobject
|