Skip to main content
GET
Validate API key
Use this endpoint as the first request in setup flows, health checks, and new integration onboarding.

Authorizations

x-api-key
string
header
required

Primary public authentication method. Create keys in Jobin.cloud under Workgroups > Integrations > Custom integration.

Response

API key accepted

Response returned when a Jobin API key is valid.

valid
boolean

Always true for accepted API keys.

provider
string

Human-readable provider or source label stored with the API key.

label
string

User-defined API key label shown in Jobin.

workGroupId
string

Authenticated Jobin workgroup identifier.

userId
string

Jobin user identifier that owns the API key.

authScheme
object

Authentication scheme supported by the public OpenAPI surface.

rateLimitGuidance
string

Operational guidance for public rate limits and retry behavior.

sequenceGuidance
string

Product guidance for campaign and sequence orchestration after validation.