Listing all organisations of the user account¶

Sends a GET request to the endpoint /user/subaccounts.

Description¶

The List-My-Organizations request allows the user to request a list of all organisations to which the user belongs.

Requirements¶

Values of the request: none

Objects: none

Request¶

To request a list of all organisations to which the user belongs, no additional information needs to be added to the path of the request.

As a result, the user gets one or more objects UserSubAccountVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`organizationName`	The name of the organisation.	`string`
`organizationId`	The ID of the organisation.	`integer`
`isMainAccount`	Shows if the organisation is the main organisation which is super-ordinate to all sub-organisations.	`true` `false`
`id`	The ID of the entry.	`integer`

Example¶

Example response:

[
  {
    "objectType": "string",
    "organizationName": "string",
    "organizationId": 0,
    "isMainAccount": true,
    "id": 0,
    "modified": "string",
    "created": "string"
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	A list of `UserSubAccountVO` elements.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.