Skip to content
Clym Partner Portal

API reference

Getting started

In this section

  • API structure What the Partner API covers, the base URL, request format, and the JSON response envelope.
  • Authorization Authenticating requests with a Partner API key.
  • Errors HTTP status codes, the error envelope, and common error codes.
  • Pagination Paging through list endpoint results.
  • Instance endpoints Working with a merchant's company, property and users through /portal/instance.

© 2026 Clym Partner PortalTermsPrivacy policyCookie policy