Use this API to retrieve a list of all collection points or retrieve a single collection point using the id query parameter. By default, the response will return details of all versions of a collection point with the active version listed first, but can be filtered using both the version and status query parameters.

🗒

Things to Know

Usage Guidelines

• Server-side caching behavior: To improve performance and reduce database load, this endpoint uses server-side caching with a 1‑hour TTL. Cached entries are automatically refreshed when collection point data is updated, ensuring responses remain current.
• Pagination and response caching: This API is pageable, and a single page may include multiple collection points. As a result:
  • End‑to‑end response caching is not always possible.
  • When data for one collection point changes, cache eviction may require re-fetching other collection points included in the same cached page.
  • Because of this, caching paginated responses is not efficient.
  • To mitigate impact, caching is applied at a component level, rather than caching the entire API response payload.
  Response times may vary depending on pagination and cache state.
• Optimized Caching Use Cases: Server-side caching is designed to be most effective when retrieving a specific collection point, querying by status, or querying by version. Broad, paginated list queries may experience variable performance depending on cache state.
• Client‑Side Caching Recommendations: Collection point metadata changes infrequently, and clients are expected to implement client-side caching to ensure optimal performance:
  • Cache metadata for 1–2 hours.
  • Avoid calling this API per user interaction or transaction.
  • Use cached metadata for downstream processing.
  • Refresh cached data on expiry.