Skip to main content
GET
/
v3
/
orgs
/
{org_id}
/
organisation-bridges
/
{bridge_id}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/organisation-bridges/{bridge_id} \
  --header 'X-Session-Token: <api-key>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "meta": {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "initiating_organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "recipient_organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "originating_request": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

​
X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

​
org_id
string<uuid>
required

The unique identifier for the organisation.

​
bridge_id
string<uuid>
required

The unique identifier for the organisation bridge.

Query Parameters

​
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
initiating_organisation,
recipient_organisation,
initiating_request

Response

Get organisation bridge.

JSON API response object

​
data
object
required

An organisation bridge

​
jsonapi
object
required