Retrieve onboarding status
1 min
GET
https://api.detected.app/api/v2/public/onboardings/{uuid}
Path Parameters
- uuidstringrequiredDescription
Responses
200
- OnboardingStatusResource
- dataobject[]Description
- codestringDescription
- titlestringDescription
- statusstring<pending | completed | in-progress | in-complete>DescriptionAllowedpendingcompletedin-progressin-complete
Response Headers
- X-RateLimit-Limit
- X-RateLimit-Remaining
401
- object
- messagestringDescription
404
- object
- messagestringDescription
429
- object
- messagestringDescription
curl
curl --request GET \
--url https://api.detected.app/api/v2/public/onboardings/{uuid} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.detected.app/api/v2/public/onboardings/{uuid}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.detected.app/api/v2/public/onboardings/{uuid}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.detected.app/api/v2/public/onboardings/{uuid}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// OK
{
"data": [
{
"code": "",
"title": "",
"status": ""
}
]
}401
// Unauthorized. The access token is missing, invalid or has expired.
{
"message": ""
}404
// Not Found. The requested resource does not exist, or is not available to your account.
{
"message": ""
}429
// Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the Retry-After header before trying again.
{
"message": ""
}