Skip to main content
GET
/
settings
View current configuration
curl --request GET \
  --url https://api.errorgolf.com/v1/settings \
  --header 'Authorization: Bearer <token>'
{
  "name": "TechCorp Solutions",
  "email": "hiring@techcorp.com",
  "live_code": "1AB2CD3EF4",
  "test_code": "T123456789",
  "personalities": [
    "jaded_dev",
    "caffeinated_genius",
    "mad_scientist"
  ],
  "webhook_url": "https://api.yourcompany.com/webhooks/error-golf",
  "webhook_secret": "abc123def456ghi789",
  "per_candidate": 2,
  "created_at": "2025-07-03T01:01:50.474Z",
  "updated_at": "2025-07-04T01:46:27.018Z"
}

Authorizations

​
Authorization
string
header
required

JWT token from /token endpoint

Response

Current configuration retrieved

Company configuration and preferences

​
name
string

Company name

Example:

"TechCorp Solutions"

​
email
string

Company email address

Example:

"hiring@techcorp.com"

​
live_code
string

Live evaluation code (charges $39 per completion)

Example:

"1AB2CD3EF4"

​
test_code
string

Test code for webhook testing and development

Example:

"T123456789"

​
personalities
string[]

Personalities for evaluation (first, second, third)

Required array length: 3 elements
Example:
[
  "jaded_dev",
  "caffeinated_genius",
  "mad_scientist"
]
​
webhook_url
string | null

Webhook URL for result notifications

Example:

"https://api.yourcompany.com/webhooks/error-golf"

​
webhook_secret
string | null

Secret for webhook signature verification

Example:

"abc123def456ghi789"

​
per_candidate
integer

Maximum attempts allowed per candidate

Required range: 1 <= x <= 4
Example:

2

​
created_at
string<date-time>
Example:

"2025-07-03T01:01:50.474Z"

​
updated_at
string<date-time>
Example:

"2025-07-04T01:46:27.018Z"

⌘I