Team Hierarchies

Use these operations to interact with team hierarchies in Cortex.

Required permissions

Your API key must have the Edit entities permission.

Operations

Retrieve team relationships

get

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Responses

200

Successfully found team relationships

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/teams/relationships

HTTPcURLJavaScriptPython

GET /api/v1/teams/relationships HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "edges": [
    {
      "childTeamTag": "text",
      "parentTeamTag": "text",
      "provider": "WORKDAY"
    }
  ]
}

Replace all relationships

put

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters

replacebooleanRequired

Supports only replace=true right now

Default: falseExample: true

Body

application/json

Responses

200

Successfully created team relationships

application/json

400

Bad Request

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/teams/relationships

HTTPcURLJavaScriptPython

PUT /api/v1/teams/relationships?replace=false HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "edges": [
    {
      "childTeamTag": "text",
      "parentTeamTag": "text"
    }
  ]
}

{
  "edges": [
    {
      "childTeamTag": "text",
      "parentTeamTag": "text",
      "provider": "WORKDAY"
    }
  ]
}