Get Org Structure

GET 
/v1/org-structure/:org_identifier

Get an organization structure by ID or short name, requires org:config:view or org:config:edit permissions on the organization

Request

Path Parameters

org_identifier anyrequired

Organization ID or short name

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

level uuidrequired

Level ID

level_type Level Type (string)

Level Type

level_name Level Name (string)

Level Name

• ]

Example (from schema)

[
  {
    "level": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "level_type": "string",
    "level_name": "string"
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...