Connectors

Get a project's installation of a connector

The project's installation of that connector in the live role, in whatever state, in the shape the installations list describes.

curl https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/connectors/example/installation \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"
get/v1/projects/{project}/connectors/{key}/installation

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/connectors/{key}/installation
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

keystring required

The connector key from the route.

Response

200 with the installation.

Example response

{
  "data": {
    "id": "3b8f0c6e-2d41-4a97-9e5f-1c7d6b2a8e40",
    "connector": "example",
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "scope": "project",
    "role": "live",
    "state": "connected",
    "operational": true,
    "external_id": "7123456789",
    "display_name": "Research Bot",
    "handle": "research_bot",
    "health_checked_at": "2026-09-12T06:00:00Z",
    "doctor_ran_at": "2026-09-12T06:00:00Z",
    "doctor_healthy": true,
    "connected_at": "2026-04-21T09:15:00Z",
    "verified_at": "2026-09-12T06:00:00Z",
    "created_at": "2026-04-21T09:15:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.