v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB

Black Kite Bridge

Get vendor engagements

Retrieves a paginated list of vendor engagements over Black Kite Bridge.

get/api/v2/bridge/engagements

Query parameters

page_numberinteger

Example:1

The number of the page requested.

page_size10 | 20 | 30 | 50 | 100 | 250

Example:10

The number of result items in a single response.

company_idsstring

Example:123,456,789

Comma-separated list of company IDs to filter engagements.

ecosystem_idsstring

Example:10,20

Comma-separated list of ecosystem IDs to filter engagements.

sharing_by_usersstring

Example:john@example.com

Comma-separated list of user email addresses who engaged with vendors, used to filter results.

shared_start_datestring date-time

Example:2023-08-01T08:30:30.682Z

Filter engagements by share date. Must be provided together with shared_end_date. Maximum range between start and end is 12 months.

shared_end_datestring date-time

Example:2023-08-04T08:30:30.682Z

Filter engagements by share date. Must be provided together with shared_start_date. Maximum range between start and end is 12 months.

status'NoResponse' | 'Registered' | 'Active'

Example:Active

Filter by engagement status. NoResponse: No response from vendor. Registered: Vendor has registered but no recent login. Active: Vendor has recent login activity.

Response

Success

CompanyIdinteger

The ID of the company in BlackKite.

CompanyNamestring

The name of the company in BlackKite.

Status'NoResponse' | 'Registered' | 'Active'

Current engagement status. NoResponse: No response from vendor, Registered: Vendor has registered but no recent login, Active: Vendor has recent login activity.

InitialShareDatestring date-time nullable

Timestamp of the initial share activity.

TotalReportsSharedinteger

Total number of reports shared with this vendor.

TotalTicketsAssignedinteger

Total number of tickets assigned to this vendor.

ClosedTicketsPercentageinteger

Percentage of closed tickets out of total assigned tickets.

TotalAssessmentsSharedinteger

Total number of assessments shared with this vendor.

Example response

[
  {
    "CompanyId": 12345,
    "CompanyName": "Example Vendor Corp",
    "Status": "Active",
    "InitialShareDate": "2024-03-09T10:30:00.000Z",
    "TotalReportsShared": 5,
    "TotalTicketsAssigned": 3,
    "ClosedTicketsPercentage": 67,
    "TotalAssessmentsShared": 2
  }
]