Aller au contenu

Lister les nœuds de l'arbre organisationnel du tenant

GET
/v1/org-units
curl --request GET \
--url 'https://example.com/v1/org-units?pageSize=50&page=1' \
--header 'X-API-Key: <X-API-Key>'
pageSize
integer
>= 1 <= 100
Example
50
page
integer
>= 1
Example
1

Page de nœuds org (hiérarchie)

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
code
required
string
name
required
string
unitKind
required
string
depth
required
integer
parentId
string format: uuid
nullable
meta
required
object
page
required
integer
>= 1
pageSize
required
integer
>= 1
total
required
integer
Example
{
"meta": {
"page": 1,
"pageSize": 20,
"total": 42
}
}

Paramètres invalides

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Non authentifié

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Permission refusée

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}