Accounts

Make a GET request to /accounts to retrieve information about the account associated with your API key. This is a useful route to get summary stats about your account's JOFI usage and configured webhook settings.

Use GET /email-templates to look up valid email template IDs for your account.

GET /accounts
{
    "mode": "live",
    "object": "account",
    "id": 68,
    "display_name": "CoffeeBean Inc",
    "display_name_external": "The Coffee Company",
    "teams_count": 3,
    "users_count": 3,
    "invitations_count": 162,
    "test_takers_seats_used_count": 98,
    "prescreens_completed_count": 16,
    "thinking_skills_completed_count": 21,
    "personality_completed_count": 55,
    "career_interests_completed_count": 47,
    "webhook_endpoint": "https://www.example.com/webhooks/jofi",
    "webhooks_enabled": true
}

Response fields

Field	Description
`mode`	`"live"` or `"test"` depending on your API key
`object`	Always `"account"`
`id`	Account ID
`display_name`	Internal account name
`display_name_external`	External-facing account name, or `null` if unset
`teams_count`	Number of teams in the account
`users_count`	Number of users in the account
`invitations_count`	Total invitations across all teams
`test_takers_seats_used_count`	Test taker seats currently in use
`prescreens_completed_count`	Completed Prescreen assessments
`thinking_skills_completed_count`	Completed Thinking Skills assessments
`personality_completed_count`	Completed Personality assessments
`career_interests_completed_count`	Completed Career Interests assessments
`webhook_endpoint`	Configured production webhook URL, or `null` if none is set or the stored value is not a valid URL. See Webhooks.
`webhooks_enabled`	Whether JOFI enqueues production webhook deliveries for this account. Requires a valid live webhook URL to deliver events. See Webhooks.

With a test API key, returns a fake account object. See API Keys.

Response fields​

Response fields