Records

The following endpoints allow you to view consent records for the specified merchant/domain company or property.

Get records

get

Retrieve a list of consent records generated by properties within this company

Authorizations

bearerAuth

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

property_idstringOptional

Filter results by the given property id

receipt_typestring · enumOptional

Filter results by the given receipt type

Possible values:

receipt_statusstring · enumOptional

Filter results based on the receipt status

Possible values:

Responses

200

Result with an array of records

application/json

get

/portal/instance/company/records

HTTPcURLJavaScriptPython

GET /api/portal/instance/company/records HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Result with an array of records

{
  "meta": {
    "current_page": 1,
    "next_page": 1,
    "prev_page": 1
  },
  "result": [
    {
      "receipt_id": "RCPT_hUQKjW16QoVkvKPjQFQ1goZs5NmN00Dx",
      "receipt_type": "COOKIE_CONSENT",
      "receipt_status": "ALLOWED",
      "country": "text",
      "region": "text",
      "jurisdiction": "text",
      "meta": {},
      "data_collection": [
        {
          "name": "text",
          "description": "text",
          "fields": [
            {
              "categories": [
                "text"
              ],
              "consent_type": "text",
              "name": "text"
            }
          ],
          "partners": [
            {
              "name": "text",
              "usage": "text",
              "url": "text"
            }
          ],
          "processors": [
            {}
          ],
          "purposes": [
            {
              "category": "text",
              "is_primary": true,
              "is_profiling": true,
              "legal_base": "text",
              "legal_description": "text",
              "name": "text",
              "status": "text",
              "termination": "text"
            }
          ]
        }
      ],
      "data_controller": {
        "name": "text",
        "logo": "https://example.com",
        "phone_number": "text",
        "url": "text",
        "email": "text",
        "address": {
          "id": "text",
          "country": "RO",
          "state": "text",
          "address": "text",
          "address_2": "text",
          "postal_code": "text",
          "phone_number": 40755111222
        }
      },
      "signature": "text",
      "subject": "text",
      "subject_auth": "text",
      "subject_data": {},
      "property_id": "text",
      "created_at": "2026-02-03T09:48:30.760Z"
    }
  ]
}

Get record

get

Retrieve the information of a receipt record

Authorizations

bearerAuth

AuthorizationstringRequired

API key generated in Clym Partner Portal.

Path parameters

idstringRequired

The consent record id

Example: RCPT_SJqfau0ZlUpIGyXgTL3LEE9q1T7t3xxx

Query parameters

merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional

Responses

200

Result record information

application/json

get

/portal/instance/company/records/{id}

HTTPcURLJavaScriptPython

GET /api/portal/instance/company/records/{id} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Result record information

{
  "result": {
    "receipt_id": "RCPT_hUQKjW16QoVkvKPjQFQ1goZs5NmN00Dx",
    "receipt_type": "COOKIE_CONSENT",
    "receipt_status": "ALLOWED",
    "country": "text",
    "region": "text",
    "jurisdiction": "text",
    "meta": {},
    "data_collection": [
      {
        "name": "text",
        "description": "text",
        "fields": [
          {
            "categories": [
              "text"
            ],
            "consent_type": "text",
            "name": "text"
          }
        ],
        "partners": [
          {
            "name": "text",
            "usage": "text",
            "url": "text"
          }
        ],
        "processors": [
          {}
        ],
        "purposes": [
          {
            "category": "text",
            "is_primary": true,
            "is_profiling": true,
            "legal_base": "text",
            "legal_description": "text",
            "name": "text",
            "status": "text",
            "termination": "text"
          }
        ]
      }
    ],
    "data_controller": {
      "name": "text",
      "logo": "https://example.com",
      "phone_number": "text",
      "url": "text",
      "email": "text",
      "address": {
        "id": "text",
        "country": "RO",
        "state": "text",
        "address": "text",
        "address_2": "text",
        "postal_code": "text",
        "phone_number": 40755111222
      }
    },
    "signature": "text",
    "subject": "text",
    "subject_auth": "text",
    "subject_data": {},
    "property_id": "text",
    "created_at": "2026-02-03T09:48:30.760Z"
  }
}