Skip to main content
GET
/
v3
/
orgs
/
{org_id}
/
organisation-bridge-requests
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/organisation-bridge-requests \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "code": "<string>",
        "notes": "<string>",
        "status": "initiated"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "initiating_organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "initiating_author": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "recipient_organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "recipient_user": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "organisation_bridge": {
          "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.

Query Parameters

​
limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
​
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
​
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • code: Filter by code
  • status_in: Filter by status

For more information on using named filters, see the docs

​
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
initiating_organisation,
initiating_author,
recipient_organisation,
recipient_user,
organisation_bridge

Response

List organisation bridge requests.

JSON API response object

​
data
A list of organisation bridge requests · object[]
required
​
jsonapi
object
required