This page will help you get started with Foxentry API at no time.

Step 1: Get your API key

Security Scheme Type:HTTP Authorization Scheme:

In order to access our API, you have to obtain API key. It is then used as Bearerand should be present at every request.
Please sign up into Foxentry and create a project.

You can create your new API key at project's homepage.


Please keep in mind, it takes aproximately 1 minute to sync the new API key with our servers. If you try to to access the API right after you've generated your new key, it might not work.

Step 2: Send your first request

After you've created your API key it is now time to send your first request. API key should be present in every request using request header Authorization, with type Bearer. Please take a look at the curl example:

curl --request POST \
     --url \
     --header 'Api-Version: 2.0' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer YOUR_API_KEY' \
     --header 'content-type: application/json' \
     --data '
  "request": {
    "query": {
      "email": "[email protected]"

Make sure you're using correct endpoint URL address. If the API version is not specified, the request will be directed to our latest version.

If you fail to properly authenticate you will receive 401 Unauthorized error with body as follows:

"errors": [
      "group": "REQUEST",
      "type": "AUTH",
      "subtype": "string",
      "severity": "critical",
      "relatedTo": [],
      "description": "Invalid authorization credentials sent. Check for more information how to set up the AUTH properly."


You must keep your credentials safe. NEVER put your API key into client page. If you plan to integrate API calls in client flow without submitting the page to server, you should implement REST endpoint bound to the session, that will be used as a proxy to call Foxentry API.


You have the option to restrict the API key by IPv4 addresses. We highly recommend you do that.