Skip to main content
GET
/
candidates
/
columns
Get candidate attribute definitions
curl --request GET \
  --url https://api.gospott.com/candidates/columns \
  --header 'x-api-key: <api-key>'
{
  "definitions": [
    {
      "viewType": "candidateName"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Response

Successfully retrieved all candidate attribute definitions

​
definitions
object[]
required

Array of attribute definitions for candidates. Each definition can be either a predefined attribute (e.g., name, email) or a custom attribute (text, number, select, etc.).