Skip to main content
GET
/
host-connections
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "host_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "guest_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "host_name": "<string>",
      "host_email": "jsmith@example.com",
      "owner_email": "jsmith@example.com",
      "status": "connected",
      "archived": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "archived_at": "2023-11-07T05:31:56Z",
      "active_action_type": "documents_update_request",
      "active_action_updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_items": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Requester-Organization-ID
string<uuid>
required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

​
Target-Organization-ID
string<uuid>
required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Query Parameters

​
statuses
enum<string>[]
required
Available options:
connected,
disconnected
​
search_field
enum<string>
default:host_name
Available options:
host_name,
host_email,
owner_email
​
search_text
string | null
Required string length: 1 - 255
​
order_by
enum<string>
default:host_name
Available options:
host_name,
host_email,
owner_email,
created_at,
updated_at,
archived_at,
active_action_updated_at
​
order_dir
enum<string>
default:asc
Available options:
asc,
desc
​
archived
boolean | null
​
active_action_types
enum<string>[] | null
Minimum array length: 1
Available options:
documents_update_request,
analytics_request
​
limit
integer
required
Required range: x <= 100
​
offset
integer
required
Required range: x >= 0

Response

Successful Response

​
items
HostConnection · object[]
required
​
total_items
integer
required
Required range: x >= 0