Skip to main content

Craft API documentation

What this site covers​

The Craft API is the GraphQL API for company requests and intelligence reports. See the Craft API reference.

How to use the guides​

Each guide covers one use case end to end:

  1. Authenticate. See Authentication.
  2. Identify the company. See Identifiers.
  3. Run the use case. Each guide shows a sample request, a sample response, and the field that feeds the next call.
  4. Handle errors. Each guide shows an error response next to the success response. See also Errors.

Where the reference comes from​

The reference pages are generated from the live Craft API schema each time the site is published, so they match the API you call. Nothing on the reference pages is written by hand.

Legacy Client API​

The Client API is the previous GraphQL API. Use it only for integrations that have not moved to the Craft API yet. See the Client API reference.