Operations

Get Summary

get

Retrieves a summary of company details, connectors, and flows for the current company or another company profile that you manage.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

company_idstringRequired

The unique identifier of the company.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/operations/summary/{company_id}

HTTPcURLJavaScriptPython

GET /api/v1/patchworks/operations/summary/{company_id} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "company": {
    "id": 0,
    "name": "string",
    "status": "string",
    "partner_name": null,
    "hubspot_id": null,
    "subscription": {
      "tier": "string",
      "allowance": {},
      "trial_ends_at": null
    },
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  },
  "connectors": {
    "total": 0,
    "all": []
  },
  "flows": {
    "total": 0,
    "enabled": 0,
    "all": []
  },
  "next": null
}