API Reference

API Keys

Create and manage API keys for the Surface API

Every request to the Surface API needs an API key. A key is scoped to one environment and can reach every resource in that environment.

Creating an API Key

Get API key from Surface
  1. Log in to your Surface account.
  2. Go to Settings > API Keys.
  3. Click on + Add API Key.
  4. Give your key a name and click Create.
  5. Copy and note down the API key immediately, as it won't be shown again.

A key is shown once, when you create it. Store it somewhere secure. If you lose it, create a new one.

Using Your API Key

Include your API key in the x-api-key header for all API requests:

curl -X GET 'https://forms.withsurface.com/api/v1/responses' \
  -H 'x-api-key: your-api-key-here'

On this page