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
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}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
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}Check your API key before running a workflow. A successful response contains
valid: true.
Rate limit: 30 requests/minute for the applicable authentication budget. Details.Authorizations
Response
API key accepted
Response returned when a Jobin API key is valid.
