Skip to main content

Batch lookup of cases by the collection partner's own reference IDs.

GET 
/cases/by-partner-reference

Returns a dictionary mapping each partner reference to its corresponding case details.

Use Case: Use this endpoint to look up multiple cases at once using your own internal reference IDs. This is more efficient than making individual calls for each reference.

Parameters:

  • references (required) - Comma-separated list of partner reference strings (max 100)

Matching: Exact string match only. References not found or not assigned to you are omitted from the response (no error).

Response: A dictionary where keys are the partner reference strings and values are the case details. Missing references are silently omitted.

Request​

Responses​

Dictionary of reference to case