List organizations administered by the human

Portal · listPortalOrganizations

GET/portal/organizations

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

NameInRequiredType and constraints
limitqueryNointegerMinimum: 1 · Maximum: 100 · Default: 50
offsetqueryNointegerMinimum: 0 · Maximum: 9007199254740991 · Default: 0

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 · ListPortalOrganizationsResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
nextOffsetanyOfYes
View nested schema
anyOf

anyOf · 2 alternatives

Alternative 1
integer
  • Minimum: 0
  • Maximum: 9007199254740991
Alternative 2
null
organizationsarrayYes
View nested schema
array
Array items
object
  • No additional properties
FieldTypeRequiredDescription / constraints
externalIdanyOfYes
View nested schema
anyOf

anyOf · 2 alternatives

Alternative 1
string
  • Minimum length: 1
  • Maximum length: 255
Alternative 2
null
idstringYesFormat: 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})$
namestringYesMinimum length: 1 · Maximum length: 200
projectIdstringYesFormat: 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
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

401 Authentication failed.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

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
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

500 An unexpected server error occurred.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

← All API operations