Skip to main content

Overview

The Perspective External API is a REST API that lets you integrate your Perspective data with external systems and build custom workflows on top of it.

Base URL​

All API endpoints share the same base URL and are versioned under the /v1 prefix:

https://api.perspective.co/v1

For example, to list workspaces:

https://api.perspective.co/v1/workspaces

Authentication​

Every request must include your API key in the x-perspective-api-key header:

x-perspective-api-key: YOUR_API_KEY

See Authentication for how to obtain and manage your key.

Request format​

  • Use Content-Type: application/json for POST and PUT requests.
  • Path and query parameters follow standard HTTP conventions.

Response envelope​

All successful responses wrap the payload in a top-level data field:

{
"data": { ... }
}

List endpoints also include a meta object with pagination details:

{
"data": [ ... ],
"meta": {
"total": 240,
"page": 0,
"limit": 20,
"hasNext": true
}
}

See Pagination for query parameters and full pagination guidance.

Errors​

Error responses share a consistent shape:

{
"error": "A human-readable description of what went wrong",
"status": 401
}

See Errors for the full list of status codes and handling guidance.

Resources​

ResourceDescription
ContactsManage CRM contacts across your funnels
MetricsAccess KPI, chart, and insight analytics data
WorkspacesList workspaces and their associated campaigns

MCP server​

If you are building AI-powered workflows, the Perspective MCP server exposes the same data to AI assistants directly. See the MCP overview for setup instructions.