Validate API key
curl --request GET \
--url https://my.jobin.cloud/api/openapi/v1/auth/validate \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://my.jobin.cloud/api/openapi/v1/auth/validate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/auth/validate"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/auth/validate' -Method GET -Headers $headers{
"valid": true,
"provider": "<string>",
"label": "<string>",
"workGroupId": "<string>",
"userId": "<string>",
"authScheme": {
"primary": "<string>"
},
"rateLimitGuidance": "<string>",
"sequenceGuidance": "<string>"
}{
"valid": true,
"error": "<string>"
}{
"valid": true,
"error": "<string>"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}Authentication
Validate API Key
Confirm that a Jobin API key is active before running contact or campaign automation.
GET
/
auth
/
validate
Validate API key
curl --request GET \
--url https://my.jobin.cloud/api/openapi/v1/auth/validate \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://my.jobin.cloud/api/openapi/v1/auth/validate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/auth/validate"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/auth/validate' -Method GET -Headers $headers{
"valid": true,
"provider": "<string>",
"label": "<string>",
"workGroupId": "<string>",
"userId": "<string>",
"authScheme": {
"primary": "<string>"
},
"rateLimitGuidance": "<string>",
"sequenceGuidance": "<string>"
}{
"valid": true,
"error": "<string>"
}{
"valid": true,
"error": "<string>"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}Use this endpoint as the first request in setup flows, health checks, and new integration onboarding.
Authorizations
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.
Always true for accepted API keys.
Human-readable provider or source label stored with the API key.
User-defined API key label shown in Jobin.
Authenticated Jobin workgroup identifier.
Jobin user identifier that owns the API key.
Authentication scheme supported by the public OpenAPI surface.
Show child attributes
Show child attributes
Operational guidance for public rate limits and retry behavior.
Product guidance for campaign and sequence orchestration after validation.
