Get default partner link
GET/v1/partnership/partner/default-link
Return the partner’s default public link as both a complete URL and its domain, path, and code components. Use it when an integration needs the standard link without selecting a custom code.
Required scopes:
- read:
partnership.all:readorpartnership.all.
Runtime restrictions:
- To retrieve your default partner link, complete the identity verification required for your partner account in your country.
Rate limits:
- This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.
Consistency and recovery notes:
- For temporary errors, retry the request with backoff and fresh authentication headers. Honor
Retry-Afterwhen returned. For authentication or access errors, correct the cause before retrying. See Troubleshooting for code-specific actions.
Possible errors:
ThrottledServiceTransportErrorErrorAuthenticationFailedPermissionDeniedValidationError
Responses
- 200
- 400
- 401
- 403
- 429
- 500
- 502
- 503
- 504
Successful response.
Bad request or validation error. The response uses either the numeric request-processing error response or the Partnership string-code error response.
Authentication failed. Authentication processing errors use numeric codes; a Partnership operation authentication error uses a string code.
Operation is not permitted for the authenticated API key, partner, or operation scope.
Rate limit exceeded.
Response Headers
Seconds to wait before retrying when the API provides a throttle wait time.
The API or a service required by the operation could not complete the request.
The API could not complete the request to the Partnership service.
A required service is temporarily unavailable or the request deadline was exceeded.
A service required by the Partnership operation could not be reached or timed out.