Skip to main content

Fetch related organizations

Returns the organization relations.

Path Parameters
organizationId uuid REQUIRED
Query Parameters
filter string

Optional filter expression

Example (Include all active relations): status:ACTIVE

Example (Include all inactive and relations in termination): status:INACTIVE OR status:IN_TERMINATION

q string

Query string will be searched in organization name

sort string

Sort results by parameter and ASC | DESC. e.g. 'name DESC'

Header Parameters
organization-id uuid

ID of organization context this request belongs to.

Responses
200

List of organization relations

Schema OPTIONAL
organizations object[] OPTIONAL
consumer object OPTIONAL
provider object OPTIONAL
status string OPTIONAL

Possible values: [INITIAL, ACTIVE, INACTIVE, IN_TERMINATION]

400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL