Spectre API

Spectre API

The Spectre API provides programmatic access to Spectre products and services.

Authentication

All requests require a bearer token. Include it in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN_HERE

If you do not have an API token, please contact the Spectre team at apis@spectre.uk.com.

The JSON Standard

The API adheres to the JSON standard and uses the JSON media type.

  • Accept: application/vnd.api+json
  • Content-Type: application/vnd.api+json

Learn more about JSON at https://jsonapi.org.

Environments

Resource Areas

  • Property Reports: Endpoints for working with user data, reports, and leads (e.g., get current user, list/create reports, list/create leads).
  • Email: Endpoints for contacts and segments (e.g., create contacts, list/create segments).

Refer to the Reference section for the full endpoint list, request/response schemas, and examples.

Common Query Parameters

Some endpoints support standard JSON query parameters:

  • include: Include related entities (e.g., include=pdf, include=accounts,company,company.reportTemplates).
  • page[size]: Set the number of results per page.
  • page[number]: Set the page number.

Check each endpoint in the Reference for supported parameters and relationships.

Errors

The API uses standard HTTP status codes and returns JSON error objects on failure. Common responses include 400, 401, 403, 404, 406, 415, and 500.

Example (condensed):

{
  "errors": [
    { "title": "Unauthorized", "code": "401" }
  ]
}