get/v1/transmissions

List Transmissions

Returns delivery logs. Supply at least one filter. When several filters are supplied, a Transmission must match every filter. patient_id returns every Transmission for that Patient. document_id returns Transmissions that sent that Letter, BookingForm, Photo, or TestResult. invoice_id, quote_id, booking_id, and digital_form_response_id return Transmissions for that record.

Required API scopes: transmissions.read

Parameters

booking_id
query
string
Return Transmissions for this Booking.
digital_form_response_id
query
string
Return Transmissions for this DigitalFormResponse.
document_id
query
string
Return Transmissions that sent this Letter, BookingForm, Photo, or TestResult.
invoice_id
query
string
Return Transmissions for this Invoice.
patient_id
query
string
Return Transmissions for a Patient with an active connection to the Organization.
quote_id
query
string
Return Transmissions for this Quote.
resource_type
query
string · enum: booking | digital_form_response | document | invoice | quote
Limit the results to one kind of record. document includes Transmissions that attach a Letter, BookingForm, Photo, or TestResult.
limit
query
integer
The maximum number of items to return. Defaults to 25; the maximum is 100.
starting_after
query
string
Return items after this resource ID. You cannot use this with cursor.
cursor
query
string
The next_cursor value from the previous page. You cannot use this with starting_after.

Responses

200

Paginated list of Transmission objects.

dataarrayrequired
- itemsobject
  - booking_idstring | null · uuidrequired
    The Booking this Transmission delivered. Null when the Transmission is not for a Booking.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - digital_form_response_idstring | null · uuidrequired
    The DigitalFormResponse this Transmission delivered. Null when the Transmission is not for a DigitalFormResponse.
  - directionstringrequired
    Whether the Transmission was sent or received by Carebit.
    Allowed values: outbound | inbound
  - document_idsarrayrequired
    Letters, BookingForms, Photos, and TestResults sent with this Transmission. Empty when no Document was attached.
    - itemsstring · uuid
  - error_messagestring | nullrequired
    The delivery error reported for a failed Transmission.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - invoice_idstring | null · uuidrequired
    The Invoice this Transmission delivered. Null when the Transmission is not for an Invoice.
  - linksobjectrequired
    URLs to related resources.
    - bookingstring | null · urirequired
      The full URL of a related resource.
    - digital_form_responsestring | null · urirequired
      The full URL of a related resource.
    - invoicestring | null · urirequired
      The full URL of a related resource.
    - patientstring | null · urirequired
      The full URL of a related resource.
  - message_templateobject | nullrequired
    The MessageTemplate used for this Transmission. Null when the Transmission has no MessageTemplate.
    - created_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - namestringrequired
      The display name of the MessageTemplate.
    - objectanyrequired
      Discriminator value emitted at object.
    - subjectstring | nullrequired
      The subject line of the MessageTemplate, including any Liquid tags.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - objectanyrequired
    Discriminator value emitted at object.
  - patient_idstring | null · uuidrequired
    The Patient this Transmission concerns. Null when the Transmission has no Patient.
  - quote_idstring | null · uuidrequired
    The Quote this Transmission delivered. Null when the Transmission is not for a Quote.
  - resource_typestring | nullrequired
    The record this Transmission delivered. Null when the Transmission only attaches Documents, or when the subject is not available in the public API.
    Allowed values: booking | digital_form_response | document | invoice | quote | null
  - sent_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - statusstringrequired
    The canonical delivery status of the Transmission.
    Allowed values: queued | processing | sending | sent | delivered | receiving | received | no_answer | busy | failed | canceled
  - subjectstring | nullrequired
    The subject line of the Transmission, when it has one.
  - tostringrequired
    The destination. This is an email address, phone number, fax number, or postal address, depending on transmission_method.
  - transmission_methodstringrequired
    The method used to send the Transmission.
    Allowed values: api | email | fax | post | sms
  - updated_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
has_morebooleanrequired
Whether another page is available after next_cursor.
next_cursorstring | nullrequired
The value to pass as cursor for the next page. Null on the last page.
objectanyrequired
Always list.
urlstringrequired
The API path that returned this list.

Example

{
  "object": "list",
  "data":  … ]
     … }
      "id": "17b62f19-f7c6-4155-85fa-e0e1be128239",
      "object": "transmission",
      "booking_id": "00000000-0000-4000-8000-000000000001",
      "created_at": "2026-01-01T09:00:00Z",
      "digital_form_response_id": "00000000-0000-4000-8000-000000000021",
      "direction": "outbound",
      "document_ids":  … ]
        "78aa99b3-1b45-47c3-8608-ece2f58b39ee"
      ],
      "error_message": "The recipient email address was rejected.",
      "invoice_id": "00000000-0000-4000-8000-000000000027",
      "links":  … }
        "booking": "https://api.carebit.co/v1/bookings/00000000-0000-4000-8000-000000000001",
        "digital_form_response": "https://api.carebit.co/v1/digital_form_responses/00000000-0000-4000-8000-000000000021",
        "invoice": "https://api.carebit.co/v1/invoices/00000000-0000-4000-8000-000000000027",
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
      },
      "message_template":  … }
        "id": "6e4de572-273e-4885-83f5-751918374c64",
        "object": "message_template",
        "created_at": "2026-01-01T09:00:00Z",
        "name": "Booking confirmation",
        "subject": "Confirmation of your booking with {{ clinician.formatted_name }}",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "patient_id": "00000000-0000-4000-8000-000000000004",
      "quote_id": "f72cd09f-9bdc-4341-8184-bf2f900a8669",
      "resource_type": "booking",
      "sent_at": "2026-01-01T09:00:00Z",
      "status": "queued",
      "subject": "Please complete your pre-operative consent form",
      "to": "alex.morgan@example.com",
      "transmission_method": "api",
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzdGFydF90aW1lIjoiMjAyNi0wMS0wMVQwOTowMDowMFoifQ",
  "url": "/v1/transmissions"
}

400

No filter was supplied, resource_type is not allowlisted, or a pagination parameter is invalid.

errorobjectrequired
The structured details that describe why the request failed.
- codestringrequired
  The machine-readable error code.
- errorsarray | null
  Additional errors from a failed validation.
  - itemsobject
    - codestring
      The machine-readable code for this validation error.
    - messagestring
      A message that explains this validation error.
    - paramstring | null
      The name of the parameter that caused this validation error, when known.
- messagestringrequired
  A message that explains the error and how to resolve it.
- paramstring | null
  The name of the parameter that caused the error, when known.
- typestringrequired
  The high-level category of the error.
  Allowed values: authentication_error | permission_error | invalid_request_error | rate_limit_error | api_error

Example

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

401

The access token is missing, invalid, expired, or revoked.

errorobjectrequired
The structured details that describe why the request failed.
- codestringrequired
  The machine-readable error code.
- errorsarray | null
  Additional errors from a failed validation.
  - itemsobject
    - codestring
      The machine-readable code for this validation error.
    - messagestring
      A message that explains this validation error.
    - paramstring | null
      The name of the parameter that caused this validation error, when known.
- messagestringrequired
  A message that explains the error and how to resolve it.
- paramstring | null
  The name of the parameter that caused the error, when known.
- typestringrequired
  The high-level category of the error.
  Allowed values: authentication_error | permission_error | invalid_request_error | rate_limit_error | api_error

Example

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

403

The access token lacks the required scope, or the project is disabled.

errorobjectrequired
The structured details that describe why the request failed.
- codestringrequired
  The machine-readable error code.
- errorsarray | null
  Additional errors from a failed validation.
  - itemsobject
    - codestring
      The machine-readable code for this validation error.
    - messagestring
      A message that explains this validation error.
    - paramstring | null
      The name of the parameter that caused this validation error, when known.
- messagestringrequired
  A message that explains the error and how to resolve it.
- paramstring | null
  The name of the parameter that caused the error, when known.
- typestringrequired
  The high-level category of the error.
  Allowed values: authentication_error | permission_error | invalid_request_error | rate_limit_error | api_error

Example

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

404

Error response.

errorobjectrequired
The structured details that describe why the request failed.
- codestringrequired
  The machine-readable error code.
- errorsarray | null
  Additional errors from a failed validation.
  - itemsobject
    - codestring
      The machine-readable code for this validation error.
    - messagestring
      A message that explains this validation error.
    - paramstring | null
      The name of the parameter that caused this validation error, when known.
- messagestringrequired
  A message that explains the error and how to resolve it.
- paramstring | null
  The name of the parameter that caused the error, when known.
- typestringrequired
  The high-level category of the error.
  Allowed values: authentication_error | permission_error | invalid_request_error | rate_limit_error | api_error

Example

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

429

Too many requests. Retry after the delay indicated by Retry-After.

errorobjectrequired
The structured details that describe why the request failed.
- codestringrequired
  The machine-readable error code.
- errorsarray | null
  Additional errors from a failed validation.
  - itemsobject
    - codestring
      The machine-readable code for this validation error.
    - messagestring
      A message that explains this validation error.
    - paramstring | null
      The name of the parameter that caused this validation error, when known.
- messagestringrequired
  A message that explains the error and how to resolve it.
- paramstring | null
  The name of the parameter that caused the error, when known.
- typestringrequired
  The high-level category of the error.
  Allowed values: authentication_error | permission_error | invalid_request_error | rate_limit_error | api_error

Example

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

Request

curl -X GET "https://api.carebit.co/v1/transmissions" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN"

200 response

{
  "object": "list",
  "data":  … ]
     … }
      "id": "17b62f19-f7c6-4155-85fa-e0e1be128239",
      "object": "transmission",
      "booking_id": "00000000-0000-4000-8000-000000000001",
      "created_at": "2026-01-01T09:00:00Z",
      "digital_form_response_id": "00000000-0000-4000-8000-000000000021",
      "direction": "outbound",
      "document_ids":  … ]
        "78aa99b3-1b45-47c3-8608-ece2f58b39ee"
      ],
      "error_message": "The recipient email address was rejected.",
      "invoice_id": "00000000-0000-4000-8000-000000000027",
      "links":  … }
        "booking": "https://api.carebit.co/v1/bookings/00000000-0000-4000-8000-000000000001",
        "digital_form_response": "https://api.carebit.co/v1/digital_form_responses/00000000-0000-4000-8000-000000000021",
        "invoice": "https://api.carebit.co/v1/invoices/00000000-0000-4000-8000-000000000027",
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
      },
      "message_template":  … }
        "id": "6e4de572-273e-4885-83f5-751918374c64",
        "object": "message_template",
        "created_at": "2026-01-01T09:00:00Z",
        "name": "Booking confirmation",
        "subject": "Confirmation of your booking with {{ clinician.formatted_name }}",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "patient_id": "00000000-0000-4000-8000-000000000004",
      "quote_id": "f72cd09f-9bdc-4341-8184-bf2f900a8669",
      "resource_type": "booking",
      "sent_at": "2026-01-01T09:00:00Z",
      "status": "queued",
      "subject": "Please complete your pre-operative consent form",
      "to": "alex.morgan@example.com",
      "transmission_method": "api",
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzdGFydF90aW1lIjoiMjAyNi0wMS0wMVQwOTowMDowMFoifQ",
  "url": "/v1/transmissions"
}

400 response

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

401 response

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

403 response

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

404 response

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

429 response

{
  "error":  … }
    "code": "resource_missing",
    "errors":  … ]
       … }
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "param": "patient_id"
      }
    ],
    "message": "The requested resource was not found.",
    "param": "patient_id",
    "type": "authentication_error"
  }
}

Endpoints

Parameters

Responses