Connectors

List a project's installations

Every installation the project holds, live and standby, oldest first.

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

role is live for the one that acts and standby for the spare the Disaster Recovery Program keeps; state is pending, connected, degraded (the health probe found something wrong, state_reason and state_detail say what, creator_actionable whether the creator can fix it), revoked (the platform withdrew it) or disconnected (the creator did); operational is the one-word answer to "can it act right now?". external_id, display_name, handle and avatar_url are the platform's own account for the installation. Credentials and settings are never serialised.

sales_paused and outage describe a connector outage: the platform refused this live installation outright (token revoked or regenerated, bot deleted). While sales_paused is true, outage carries the outage's id, the connector's reason code and started_at, and every plan that unlocks a place on this connector is refused at checkout with 422 VALIDATION_FAILED; both go back to false and null when the installation answers again, is replaced or is uninstalled. Connector outages describes what members see and how they are compensated; connector.outage_opened and connector.outage_closed announce both ends.

get/v1/projects/{project}/connectors

Request

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

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Response

Array of ConnectorInstallationResource

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.