Error
A valid request URL is required to generate request examples{
"featureKey": "partner-program-participation",
"entitlementFeatureKey": "operate-agents-for-clients",
"protectedOAuthRenewalActionAvailable": true,
"state": "GRANTED",
"allowed": true,
"purchased": true,
"billingCustomerId": 4503599627370495,
"standing": {
"usable": true,
"reason": "<string>",
"authority": "BETA"
},
"ownership": {
"claimed": true
},
"registration": {
"registered": true
},
"readiness": {
"ready": true,
"reason": "<string>"
},
"denialReasons": [
"<string>"
],
"nextAction": "OPEN_PARENT_ORGANIZATION",
"paymentSetupUrl": "<string>",
"entitlementExpiresAt": "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
Get Partner Program access
Returns the authenticated organization’s Partner Program entitlement decision and whether a directly authorized administrator can recover the protected OAuth connection without receiving Partner workspace access.
GET
/
provider
/
partner-access
Error
A valid request URL is required to generate request examples{
"featureKey": "partner-program-participation",
"entitlementFeatureKey": "operate-agents-for-clients",
"protectedOAuthRenewalActionAvailable": true,
"state": "GRANTED",
"allowed": true,
"purchased": true,
"billingCustomerId": 4503599627370495,
"standing": {
"usable": true,
"reason": "<string>",
"authority": "BETA"
},
"ownership": {
"claimed": true
},
"registration": {
"registered": true
},
"readiness": {
"ready": true,
"reason": "<string>"
},
"denialReasons": [
"<string>"
],
"nextAction": "OPEN_PARENT_ORGANIZATION",
"paymentSetupUrl": "<string>",
"entitlementExpiresAt": "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
Response
Get Partner Program access
Available options:
partner-program-participation Available options:
operate-agents-for-clients Available options:
GRANTED, PENDING, DENIED, ERROR Required range:
0 < x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
OPEN_PARENT_ORGANIZATION, ACCEPT_OFFER, SET_UP_PAYMENT, FUND_PREPAY, RESOLVE_BILLING_HOLD, CLAIM_PROVIDER, COMPLETE_CERTIFICATION, CONTACT_SALES, WAIT_FOR_START, NONE 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)))$