Base URL

https://app.owlbound.ai/api/v1

Content Type

Content-Type: application/json

All API requests require a valid API key. Create and manage keys from the Developer tab in your Owlbound workspace.

Methods

Key types

Scopes control which resources a key can access. Secret keys can be configured with any combination. Publishable keys are restricted to signals:write only.

Default Scopes by Key Type

// Secret keys include all scopes by default
{
 "scopes": [
 "intelligence:read",
 "enrichment:read",
 "enrichment:write",
 "messages:read",
 "signals:read",
 "signals:write",
 "contacts:read",
 "contacts:write",
 "sequences:read",
 "sequences:write",
 "workflows:read",
 "workflows:write",
 "connectors:read",
 "connectors:write"
 ]
}

Rate limits are applied per API key using a sliding window. When exceeded, the API returns 429 Too Many Requests with a Retry-After header (in seconds).

Rate Limit Headers

HTTP/1.1 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1705312200

Use the capabilities endpoint to see each public API action, its required scope, and the credit cost recorded for successful calls. These successful calls are also mirrored into the workspace usage ledger with an api.* capability ID.

Capability inventory

curl https://app.owlbound.ai/api/v1/capabilities

Response Format

All responses use a consistent JSON envelope with a data key for successful requests and an error key for failures. Successful responses include a meta object with a unique request ID.

Response fields

API root. Returns version information, available endpoints, and authentication details. Does not require authentication.

Response body

Health check endpoint. Use this to monitor API availability from your infrastructure. Does not require authentication.

Response body

Returns information about the authenticated API key including workspace name, key type, granted scopes, and current rate limits. Useful for verifying key configuration.

Response body

Returns a paginated list of contacts in your workspace. Supports filtering by status, source, and company, with configurable sorting.

Query parameters

Create a new contact in your workspace. At least one of firstName, lastName, email, or linkedInUrl is required. Duplicate detection runs on email and LinkedIn URL.

Request body

Full-text search across contacts. Searches name, title, company, email, and tags.

Request body

Get a single contact by ID. Returns detailed contact information including enrichment data, scores, and connection status.

Update one or more fields on an existing contact. Only include fields you want to change.

Archive (soft-delete) a contact. The contact can be restored later from the dashboard. Optionally include a reason.

Queue a contact for data enrichment. The system will scrape LinkedIn profile data, find email/phone, analyze activity, check connection status, and score against ICP profiles. This is an asynchronous operation — poll GET /v1/enrichment/:contactId to check progress.

Powered by

Apollo

FullEnrich

ZoomInfo

Request body (optional)

Check enrichment status for a contact. Returns current phase, completed phases, and any errors. Use this to poll for enrichment completion after calling POST /v1/contacts/:id/enrich.

AI-score a contact against a specific ICP (Ideal Customer Profile). Returns a 0-100 score, verdict, breakdown by category, and reasoning. This is a synchronous operation that calls the AI model in real time.

Request body

List combined intent and social signals. Returns a unified view of job changes, funding rounds, social posts, and other buying signals.

Query parameters

Ingest an external intent signal. Use this to send buying signals from your own systems, webhooks, or third-party tools into the GTM platform. This endpoint works with publishable keys.

Request body

Get signal statistics by type and priority for a given time range. Useful for dashboards and reporting.

Query parameters

List companies in your workspace with optional industry filter and pagination.

Query parameters

Create or update a company by LinkedIn URL. Existing non-empty fields are preserved so enrichment and CRM data are not overwritten accidentally.

Get a single company by ID with full details and contact count.

Enroll a contact into an active outreach sequence. The API checks workspace ownership, exclusion rules, archived status, duplicate active enrollments, and sequence steps.

Trigger an active signal workflow for a contact by creating a custom webhook signal and routing it through the signal router.

List connector instances with redacted configuration and computed health. Use it to power connector dashboards, external monitoring, and agent audits.

Get one connector with its redacted setup and latest computed health status.