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

    • id
      string

      Unique identifier for the organization

    • name
      string

      Name of the organization

    • parent
      object
      optional
      circular
    • sub
      array
      optional
      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

  • id
    string

    Unique identifier for the organization

  • name
    string

    Name of the organization

  • parent
    object
    optional
    circular
  • sub
    array
    optional
    circular

    Child organizations (array circular reference)

​Create a new organization › Responses

    • id
      string

      Unique identifier for the organization

    • name
      string

      Name of the organization

    • parent
      object
      optional
      circular
    • sub
      array
      optional
      circular

      Child organizations (array circular reference)