Skip to content

JSON API

Joe edited this page Jul 3, 2020 · 2 revisions

Send a POST request to the Lambda or server API endpoint with a JSON object body, the JSON object may contain the following attributes: domain, user, email. For example, to query for all records related to a given domain:

{"domain": "gmail.com"}

To query for all records related to an email:

{"email": "[email protected]"}

To query for all records related to a user:

{"user": "jdoe"}

Pagination

Each request will return up to 1,000 results, you can query additional pages by setting the page (JSON integer) value in a given request. Pages are zero-indexed:

{"domain": "gmail.com", "page": 1}

For example, using HTTPie:

http <API ENDPOINT>  x-api-key:<API KEY> domain=gmail.com page:=1
Clone this wiki locally