Skip to content
English
  • There are no suggestions because the search field is empty.

API: How Do I Get Started With The EDITED API?

EDITED has two REST APIs: the Query API and the Jobs API. Whichever you use, the first steps are the same:

  1. Authenticate your request.
  2. Build a filter set to define the data you want.
  3. Submit your request and get your results back.

Step 3 is where the two APIs differ:

  • Query API: send your filter set to an endpoint and read the matching data straight back in the response. Best for targeted, point-in-time questions.
  • Jobs API: submit your filter set as a job, then retrieve the results once it has finished running. Built for large, bulk exports.

For the full walkthrough and example requests, see the quickstart for the API you're using: