List all digital member card delivery activities

​
Query Parameters
  • filter[member_id]
    Type: string

    Filter activities by the member ID belonging to the related user. Accepts alphanumeric strings.

  • filter[request_hash]
    Type: string

    Filter activities by the unique request hash for tracing API requests.

  • filter[date_from]
    Type: stringFormat: date-time

    Return activities created on or after the provided date. Format: ISO 8601 date/datetime (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).

  • filter[date_to]
    Type: stringFormat: date-time

    Return activities created on or before the provided date. Format: ISO 8601 date/datetime (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS).

  • filter[status]
    Type: string

    Filter activities by delivery status. Supported values: success, failed.

Headers
  • X-Api-Version
    Type: string

    Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-03-25.

Responses
  • application/json
  • application/json
Request Example for get/activities/card-deliveries
curl 'https://api.getcommunal.com/api/activities/card-deliveries?filter[member_id]=MEM-12345&filter[request_hash]=&filter[date_from]=2024-01-01&filter[date_to]=2024-12-31&filter[status]=failed' \
  --header 'X-Api-Version: 2026-03-25' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": 1234,
      "request_hash": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "message": "Membership card delivered to john@example.com",
      "delivered_at": "2025-06-15T14:30:00.000Z",
      "timestamp": 1718460600,
      "user_id": 42,
      "member_id": "MEM-12345",
      "obfuscated_emails": [
        "j***@example.com"
      ],
      "emails_attempted": [],
      "email_count": 1,
      "card_types": {
        "pdf": true,
        "apple_pass": false,
        "google_wallet": false
      },
      "status": "delivered",
      "failure_reason": null,
      "error_message": null
    }
  ],
  "total": 1
}