Divisions

List division

Lists divisions by hierarchy ID or level ID. Only one of the parameters should be provided with the request. Providing both generates an error.

get/corporate/v2/divisions

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/corporate/v2/divisions
  • Auth
    none declared

Query parameters

hierarchyIdstring

Hierarchy ID generated by the Create hierarchy endpoint. You only need to provide one of the parameters.

levelIdstring

Level ID generated by the Create hierarchy endpoint. You only need to provide one of the parameters.

Response

OK

Example response

{
  "divisions": [
    {
      "division_id": "6f8a456a-8b1a-4022-a2f8-7612595330b5",
      "division_code": "US",
      "parent_code": "my-parent-division",
      "name": "NY",
      "description": "NY - New York City",
      "level_id": "9bb95e15-c0e6-4c84-b644-350c76a83358",
      "hierarchy_id": "9bb95e15-c0e6-4c84-b644-350c76a83358",
      "administrative_division_id": 13,
      "program_ids": [
        1,
        2,
        3
      ]
    }
  ],
  "pagination": {
    "next_cursor": 124,
    "has_next": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.