Error
A valid request URL is required to generate request examples{
"generatedAt": "2023-11-07T05:31:56Z",
"requestedCapability": {
"capabilityUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayName": "<string>"
},
"referrals": [
{
"referralUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"capabilityUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"capabilityName": "<string>",
"publisherName": "<string>",
"publisherDomain": "<string>",
"contactEmail": "jsmith@example.com",
"status": "NOT_STARTED",
"invitedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"deliveryAttemptedAt": "2023-11-07T05:31:56Z",
"acceptedCustomerId": 4503599627370496,
"acceptedAt": "2023-11-07T05:31:56Z",
"completedBindingUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completedAt": "2023-11-07T05:31:56Z"
}
]
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Storefront
List client onboarding referrals
Lists publisher invitations started by the authenticated Partner organization, including exact Source completion state.
GET
/
provider
/
account
/
client-referrals
Error
A valid request URL is required to generate request examples{
"generatedAt": "2023-11-07T05:31:56Z",
"requestedCapability": {
"capabilityUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayName": "<string>"
},
"referrals": [
{
"referralUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"capabilityUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"capabilityName": "<string>",
"publisherName": "<string>",
"publisherDomain": "<string>",
"contactEmail": "jsmith@example.com",
"status": "NOT_STARTED",
"invitedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"deliveryAttemptedAt": "2023-11-07T05:31:56Z",
"acceptedCustomerId": 4503599627370496,
"acceptedAt": "2023-11-07T05:31:56Z",
"completedBindingUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completedAt": "2023-11-07T05:31:56Z"
}
]
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Query Parameters
Return referrals for this exact Sales Agent before applying the bounded row limit.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Response
List client onboarding referrals
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Show child attributes
Show child attributes
Show child attributes
Show child attributes