Read Receipt Service - API Contract

GET /api/v1/read-receipts/api/v1/read-receipts

List all read receipts

Public

Response Example

{
  "data": [
    {
      "receipt_id": "rr-0091",
      "contact_id": "c-00123",
      "field_key": "email",
      "user_id": "user-034",
      "read_at": "2026-03-10T14:05:00Z",
      "status": "read"
    },
    {
      "receipt_id": "rr-0090",
      "contact_id": "c-00123",
      "field_key": "phone",
      "user_id": "user-077",
      "read_at": "2026-03-09T09:22:00Z",
      "status": "read"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 47
  }
}

GET /api/v1/read-receipts/api/v1/read-receipts/:id

Get read receipt by ID

Public

Response Example

{
  "receipt_id": "rr-0091",
  "contact_id": "c-00123",
  "field_key": "email",
  "user_id": "user-034",
  "read_at": "2026-03-10T14:05:00Z",
  "status": "read"
}

POST /api/v1/read-receipts/api/v1/read-receipts

Record a read receipt (recordReadReceipt)

Public

Request Example

{
  "contact_id": "c-00123",
  "field_key": "date_of_birth",
  "user_id": "user-034"
}

Response Example

{
  "receipt_id": "rr-0099",
  "contact_id": "c-00123",
  "field_key": "date_of_birth",
  "user_id": "user-034",
  "read_at": "2026-03-26T11:10:00Z",
  "status": "read",
  "created_at": "2026-03-26T11:10:00Z"
}

PUT /api/v1/read-receipts/api/v1/read-receipts/:id

Update a read receipt record

Public

Request Example

{
  "status": "acknowledged",
  "user_id": "user-034"
}

Response Example

{
  "receipt_id": "rr-0091",
  "contact_id": "c-00123",
  "field_key": "email",
  "user_id": "user-034",
  "status": "acknowledged",
  "updated_at": "2026-03-26T12:00:00Z"
}

DELETE /api/v1/read-receipts/api/v1/read-receipts/:id

Delete a read receipt

Public

Response Example

{
  "receipt_id": "rr-0091",
  "deleted": true,
  "deleted_at": "2026-03-26T12:35:00Z"
}

GET /api/v1/read-receipts/api/v1/read-receipts/status

Get read receipt status for a contact field (getReadReceiptStatus)

Public

Response Example

{
  "contact_id": "c-00123",
  "field_key": "email",
  "status": "read",
  "last_read_by": "user-034",
  "last_read_at": "2026-03-10T14:05:00Z"
}

GET /api/v1/read-receipts/api/v1/read-receipts/contact/:id

List all read receipts for a contact (listReadReceipts)

Public

Response Example

{
  "data": [
    {
      "receipt_id": "rr-0091",
      "field_key": "email",
      "user_id": "user-034",
      "read_at": "2026-03-10T14:05:00Z",
      "status": "read"
    },
    {
      "receipt_id": "rr-0088",
      "field_key": "phone",
      "user_id": "user-055",
      "read_at": "2026-03-08T16:40:00Z",
      "status": "read"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 8
  }
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}