Authorization

To use the API, you need to generate an API key:

1. Sign in to your FoxyApps account at foxyapps.com
2. Navigate to your profile API settings at foxyapps.com/settings/api.
3. Click Generate new API token

<aside> 💡 Important: The API key is displayed only once, so make sure to save it in a secure location.

</aside>

Include this key in the 'Authorization' header of your request, prefixed by the word 'Bearer':

headers: {
  'Content-Type': 'application/json',
  'Authorization': `Bearer ${yourApiKey}`,
}

Making a request

To use one of your apps via the API:

1. Send a POST request to https://www.foxyapps.com/api/app
2. Include your API key in the request headers as shown above.
3. In the request body, include:
   • The id of the app you want to use
   • Key-value pairs for each input field in your app

You can find the example payload for each of your apps by navigating to foxyapps.com/my-apps and clicking Actions → API Schema

Example request body:

{
  "id": "fa04f53a-da6c-4b08-bca9-87772c3f228c",
  "textarea_2": "Your input here",
  "email": "[email protected]",
  "select_1": "Option A",
  "number_1": "42",
  "web_1": "<https://example.com>",
  "checkbox_field_1": "true"
}

<aside> 💡 Note: The API does not currently support apps that require PDF file uploads.

</aside>

Example request