We're announcing 🧑‍🚀 inter-galactic shipping ✨ for 3025!
Shipment API

​Organization Management

Endpoint

​List all organizations

GET
https://api.sh.example.com/v1
/organizations

Returns a list of all organizations in the hierarchy

​List all organizations › Responses

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

      Unique identifier for the organization

    • namestring · minLength: 1 · maxLength: 200 · required

      Name of the organization

    • parentcircular
    • subarray · maxItems: 100 · circular

      Child organizations (array circular reference)

​Create a new organization

POST
https://api.sh.example.com/v1
/organizations

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

​Create a new organization › Request Body

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

    Unique identifier for the organization

  • namestring · minLength: 1 · maxLength: 200 · required

    Name of the organization

  • parentcircular
  • subarray · maxItems: 100 · circular

    Child organizations (array circular reference)

​Create a new organization › Responses

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

      Unique identifier for the organization

    • namestring · minLength: 1 · maxLength: 200 · required

      Name of the organization

    • parentcircular
    • subarray · maxItems: 100 · circular

      Child organizations (array circular reference)

SchemasRoute Planning