Skip to main content
Stairoids is a B2B signal platform: it aggregates buying and engagement signals from across your GTM stack, scores the companies and people behind them, and surfaces who to reach out to. The public API gives you programmatic, read-only access to that scored data.

​
What you can do

The API exposes the data Stairoids has already computed for your organization. Use it to:
  • Pull your scored companies and rank them by intent — search, by funnel stage, by industry, by id, or by the people who work there.
  • Read the buying-signal activity timeline for a company or a person, or a general cross-company feed.
  • Get your best outreach opportunities — high-intent companies paired with the best person to contact.
  • Read funnel & pipeline analytics — stage distribution, velocity, and buying-signal / marketing-touched trends.
  • Read marketing attribution — traffic sources, campaigns, and the accounts they drove.
  • Read LinkedIn ad engagement — campaigns, posts, likes, and per-company engagement.
  • List your reference data — ICPs, buyer personas, labels, account lists, and signal types.
The public API is read-only: it does not create, update, or delete anything, and it is not how you send signals into Stairoids. To push signals in, use an integration or an incoming automation.

​
Base URL

All public API endpoints live under:

​
Authentication

Every request must include your organization’s API key in the X-Api-Key header. See Authentication for how to get and rotate it.

​
Request and response format

  • Requests and responses use JSON. Send Content-Type: application/json on any request that has a body.
  • Timestamps are Unix epoch milliseconds (an integer) — both in the time-window filters you send and in the fields you get back. There are no ISO-8601 date strings.

​
Pagination

Most list endpoints accept page (zero-based) and size (max 100) — as query parameters on GET endpoints, or as fields in the JSON body on POST search endpoints — and return this envelope:
Some endpoints return a plain JSON array instead (for example the reference lists, and the general activity feed, which is bounded by a limit rather than paged), and a few return a single result object with their own fields.

​
Status codes

Plan or permission limits can also return 402 or 403. Note there is no 404 — a resource that isn’t in your pipeline comes back as 400 with errorType: NOT_FOUND. Endpoint errors return a small JSON body with a machine-readable code (a 401 for a missing or invalid key is rejected earlier, and has no body):

​
Next steps

Authentication

Get your API key and send it with every request.

Core Concepts

Understand the signals, scoring, and funnel behind the data.