Admin APIs
openbb-entities

Create Entity

Create a new OpenBB entity.

This also sets up default entitlements for the entity.

post/api/v1/admin/openbb/entities

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/admin/openbb/entities
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Query parameters

idempotentboolean

If True (default), return the existing entity when the name already matches one instead of creating a new one. Pass False to force a genuinely new entity even on a name collision — e.g. to remediate an existing entity that's missing default permission maps, since those are only bootstrapped by OpenBB Hub on real creation, not on an idempotent match.

Request body

namestring required

Entity name

entity_type_uuidstring required

UUID of the entity type

emailstring email required

Entity contact email

admin_emailstring email required

Primary admin email

company_typestring required

Company type (e.g., 'Investment Firm')

organization_sizestring

Organization size (e.g., '10-50')

auminteger

Assets Under Management

countrystring

Country code or name

seatsinteger

Number of licensed seats

expiration_datestring date-time nullable

Expiration date in ISO 8601 format

Example request

{
  "admin_email": "admin@acme.com",
  "aum": 10000000,
  "company_type": "Investment Firm",
  "country": "USA",
  "email": "billing@acme.com",
  "entity_type_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "expiration_date": "2026-12-31T00:00:00Z",
  "name": "Acme Corp",
  "organization_size": "10-50",
  "seats": 50
}

Response

Successful Response

entity_uuidstring required
messagestring

Changes

No recorded changes to this operation across all 4 revisions of this API.