Documentation

Developers · API

API reference

Core API conventions — pagination, filtering, errors — and the shared resources exposed across intSignal products.

This is the shared reference for the intSignal REST API. Product resources (such as SOC cases) follow every convention here.

Requests

  • Base URL: https://api.intsignal.com/v1
  • HTTPS only; JSON request and response bodies
  • Send Authorization: Bearer <token> on every request
  • Send Content-Type: application/json on POST/PATCH

Pagination

List endpoints return a page of data plus a next_cursor. Pass it back as cursor to get the next page; a null next_cursor means the last page.

curl "https://api.intsignal.com/v1/devices?limit=100" \
  -H "Authorization: Bearer $INTSIGNAL_TOKEN"
{ "data": [ /* … */ ], "next_cursor": "eyJvIjoxMDB9" }

Filtering & sorting

Most list endpoints accept resource-specific filters plus:

ParamDescription
sinceOnly records updated at/after an ISO 8601 timestamp
limitPage size (default 50, max 200)
cursorPagination cursor
orderasc or desc by updated time (default desc)

Errors

Errors use standard HTTP status codes and a consistent body:

{
  "error": {
    "code": "invalid_scope",
    "message": "Token is missing required scope: soc:write",
    "request_id": "req_2c9a1f"
  }
}
StatusMeaning
400Malformed request
401Missing/invalid token
403Valid token, insufficient scope
404Resource not found
409Conflict (e.g., duplicate)
429Rate limited — see Rate limits
5xxServer error — safe to retry with backoff

Always log the request_id; it lets support trace a specific call.

Shared resources

ResourceEndpointScope
Ping / healthGET /pingany
OrganizationGET /orgorg:read
DevicesGET /devicesdevices:read
SOC casesGET /soc/casessoc:read
WebhooksGET/POST /webhookswebhooks:write

Tip

Prefer webhooks over polling list endpoints on a tight loop — you will hit rate limits and add latency. Webhooks push changes as they happen.

Need a hand with Developers?Talk to our team →