Retrieve all RICALs

Retrieves all RICALs available in the requested ecosystem.

The response is a JSON list of the published RICALs and their version identifiers. To download an actual RICAL file (a CBOR encoded file matching the RICAL format defined in ISO/IEC 18013-5), call the Retrieve specific RICAL or Retrieve latest RICAL endpoint.

This endpoint is intended for public consumption, and as such does not require authentication.

Analytic events

• ECOSYSTEM_RICAL_RETRIEVE_LIST_START
• ECOSYSTEM_RICAL_RETRIEVE_LIST_SUCCESS
• ECOSYSTEM_RICAL_RETRIEVE_LIST_FAIL

Path Parameters

Query Parameters

Response Body

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/ricals/public"

{
  "data": [
    {
      "ricalIssueID": 1337,
      "date": "2024-07-28T23:01:13.000Z",
      "filename": "rical-2024-07-28-1722164473000.cbor",
      "isAutoPublished": false
    }
  ],
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}