Organization Management

Server

Download schema

List all organizations

GET

https://c1cf69108515455da09b5a33ff336111-oas.api.mockbin.io

/organizations

Bearer (JWT)

X-API-Key (header)

Returns a list of all organizations in the hierarchy

List all organizations › Responses

200

List of organizations

A shipping organization that can have sub-organizations (e.g. regional offices)

Organization

id

string · pattern: ^[a-zA-Z0-9-]+$ · required

Unique identifier for the organization

name

string · minLength: 1 · maxLength: 200 · required

Name of the organization

parent

circular

sub

array · maxItems: 100 · Organization (circular)

Child organizations (array circular reference)

Create a new organization

POST

https://c1cf69108515455da09b5a33ff336111-oas.api.mockbin.io

/organizations

Bearer (JWT)

X-API-Key (header)

Creates a new organization, optionally as part of an existing hierarchy

Create a new organization › Request Body

A shipping organization that can have sub-organizations (e.g. regional offices)

Organization

id

string · pattern: ^[a-zA-Z0-9-]+$ · required

Unique identifier for the organization

name

string · minLength: 1 · maxLength: 200 · required

Name of the organization

parent

circular

sub

array · maxItems: 100 · Organization (circular)

Child organizations (array circular reference)

Create a new organization › Responses

Organization created

A shipping organization that can have sub-organizations (e.g. regional offices)

Organization

id

string · pattern: ^[a-zA-Z0-9-]+$ · required

Unique identifier for the organization

name

string · minLength: 1 · maxLength: 200 · required

Name of the organization

parent

circular

sub

array · maxItems: 100 · Organization (circular)

Child organizations (array circular reference)

Schemas Route Planning