Skip to content
campai
Book a consultationTry for free
GET/organizations/{organizationId}/hierarchy/parents

Get hierarchy settings of parent organizations

Returns the hierarchy settings of all parent organizations of the specified organization

Required permissions:

  • organization.read

Path Parameters

organizationIdstringrequired

Authentication: X-API-Key

Request

GET/organizations/{organizationId}/hierarchy/parents
curl --request GET 'https://cloud.campai.com/api/organizations/{organizationId}/hierarchy/parents' \
  --header 'X-API-Key: YOUR_API_KEY'

Responses

This endpoint returns different response codes based on the request outcome.

200Successful response

Content-Type: application/json

ObjectId as string

Additional properties are not allowed.

Response

200
[
  {
    "organization": "000000000000000000000001",
    "fields": {},
    "contacts": {
      "sharedSegments": [
        {
          "segment": {
            "filter": {
              "operator": "and",
              "groups": [
                {
                  "operator": "and",
                  "fields": [
                    {
                      "path": "string",
                      "comparator": "exists"
                    }
                  ]
                }
              ]
            },
            "name": "string",
            "hint": "string",
            "key": "string",
            "type": "member"
          },
          "fields": [
            "string"
          ],
          "levels": [
            "string"
          ],
          "registrations": 0
        }
      ]
    }
  }
]

400Invalid input data

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

400
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401Authorization not provided

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

401
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403Insufficient access

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

403
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

404Not found

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

404
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500Internal server error

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

500
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}