List onboarding invites
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/onboardinginvites \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/onboardinginvites"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/onboardinginvites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/onboardinginvites';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"count": 123,
"data": [
{
"spProductId": "<string>",
"inviteId": "<string>",
"name": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"reference": "<string>",
"url": "<string>",
"notifications": {
"email": {
"enabled": true,
"sent": true
},
"sms": {
"enabled": true,
"sent": true
}
},
"status": "<string>",
"feesTemplateId": "<string>",
"onboardingFlowTemplateId": "",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"query": {
"criteria": {},
"options": {}
}
}Query
List onboarding invites
Returns onboarding invites and their current status — created, sent, completed, or cancelled.
POST
https://sandbox-platform.jupico.com
/
v1
/
query
/
onboardinginvites
List onboarding invites
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/onboardinginvites \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/onboardinginvites"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/onboardinginvites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/onboardinginvites';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"count": 123,
"data": [
{
"spProductId": "<string>",
"inviteId": "<string>",
"name": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"reference": "<string>",
"url": "<string>",
"notifications": {
"email": {
"enabled": true,
"sent": true
},
"sms": {
"enabled": true,
"sent": true
}
},
"status": "<string>",
"feesTemplateId": "<string>",
"onboardingFlowTemplateId": "",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"query": {
"criteria": {},
"options": {}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
The body is of type object.
Response
200 - application/json
Find Onboarding invites
Last modified on August 31, 2026
Was this page helpful?

