Carebit API

Digital Form Responses

Patient responses to DigitalForms.

Endpoints

Scroll this page to read every Digital Form Responses endpoint, or jump to one below.

get/v1/digital_form_responsesList a Patient's DigitalFormResponses
post/v1/digital_form_responsesCreate and send a DigitalFormResponse
get/v1/digital_form_responses/:idRetrieve a DigitalFormResponse

get/v1/digital_form_responses

List a Patient's DigitalFormResponses

Required API scopes: digital_form_responses.read

Parameters

patient_id
query · required
string
The Patient whose DigitalFormResponses should be returned.
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 DigitalFormResponse objects.

dataarrayrequired
- itemsobject
  - answersarrayrequired
    The answers currently recorded for the DigitalFormResponse.
    - itemsobject
      - attachment_urlstring | null · urirequired
        The temporary URL for an attached answer.
      - date_valuestring | null · daterequired
        The date supplied for a date question.
      - digital_form_questionobjectrequired
        A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer.
        choicesarrayrequired
        The choices available for a choice question.
        itemsobject
        idstring · uuidrequired
        The identifier of the DigitalFormQuestionChoice.
        numerical_valuenumber | nullrequired
        The optional numerical value assigned to the choice.
        text_valuestring | nullrequired
        The optional machine-readable text value assigned to the choice.
        titlestringrequired
        The choice shown to the Patient.
        help_textstring | nullrequired
        The supplementary guidance shown with the question.
        idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
        is_answer_requiredbooleanrequired
        Whether the Patient must answer the question.
        list_order_numberinteger | nullrequired
        The position of the question in the DigitalForm.
        question_typestringrequired
        The input and consent behavior of the question.
        Allowed values: consent_required | information_statement | multiple_choice_input | single_choice_input | text_input | number_input | date_input | signature_input
        titlestringrequired
        The question shown to the Patient.
      - digital_form_question_choice_idstring | null · uuidrequired
        The selected DigitalFormQuestionChoice.
      - digital_form_question_idstring · uuidrequired
        The DigitalFormQuestion answered.
      - has_consentedboolean | nullrequired
        Whether the Patient granted the requested consent.
      - idstring · uuidrequired
        The identifier of the DigitalFormQuestionAnswer.
      - numerical_valuenumber | nullrequired
        The numerical answer.
      - text_valuestring | nullrequired
        The text answer or selected choice title.
  - booking_idstring | null · uuidrequired
    The Booking associated with the response.
  - completed_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - digital_formobjectrequired
    - attachment_urlstring | null · urirequired
      The temporary URL for the attachment displayed with the DigitalForm.
    - 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.
    - objectanyrequired
      Discriminator value emitted at object.
    - patient_instructionsstring | nullrequired
      The sanitized instructions shown to the Patient.
    - questionsarrayrequired
      The ordered questions included in the DigitalForm.
      - itemsobject
        A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer.
        choicesarrayrequired
        The choices available for a choice question.
        itemsobject
        idstring · uuidrequired
        The identifier of the DigitalFormQuestionChoice.
        numerical_valuenumber | nullrequired
        The optional numerical value assigned to the choice.
        text_valuestring | nullrequired
        The optional machine-readable text value assigned to the choice.
        titlestringrequired
        The choice shown to the Patient.
        help_textstring | nullrequired
        The supplementary guidance shown with the question.
        idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
        is_answer_requiredbooleanrequired
        Whether the Patient must answer the question.
        list_order_numberinteger | nullrequired
        The position of the question in the DigitalForm.
        question_typestringrequired
        The input and consent behavior of the question.
        Allowed values: consent_required | information_statement | multiple_choice_input | single_choice_input | text_input | number_input | date_input | signature_input
        titlestringrequired
        The question shown to the Patient.
    - titlestringrequired
      The title of the DigitalForm.
    - updated_atstring · date-timerequired
      An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - due_atstring | null · 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.
  - linksobjectrequired
    URLs to related resources.
    - patientstring · urirequired
      The full URL of a related resource.
    - transmissionsstring · urirequired
      The full URL of a related resource.
  - objectanyrequired
    Discriminator value emitted at object.
  - patient_idstring · uuidrequired
    The Patient asked to complete the DigitalForm.
  - statusstringrequired
    The completion status of the DigitalFormResponse.
    Allowed values: awaiting_completion | partially_completed | overdue | completed
  - total_scoreinteger | nullrequired
    The sum of numerical answers configured to contribute to the score.
  - 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": "4262fdc0-c7a1-4856-83c4-16ed34cb8773",
      "object": "digital_form_response",
      "answers":  … ]
         … }
          "id": "7ae2abaf-6f3e-4fbf-842d-5cbbe91b8492",
          "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
          "date_value": "2026-01-01",
          "digital_form_question":  … }
            "id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
            "choices":  … ]
               … }
                "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
                "numerical_value": 1.5,
                "text_value": "yes",
                "title": "Dr"
              }
            ],
            "help_text": "Select every option that applies.",
            "is_answer_required": true,
            "list_order_number": 1,
            "question_type": "consent_required",
            "title": "Dr"
          },
          "digital_form_question_choice_id": "26a2ba65-f724-4add-8940-9f63f02f8711",
          "digital_form_question_id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
          "has_consented": true,
          "numerical_value": 1.5,
          "text_value": "The symptoms started two weeks ago."
        }
      ],
      "booking_id": "92a3b4c5-d6e7-4f01-8234-56789abcdef0",
      "completed_at": "2026-01-01T09:00:00Z",
      "created_at": "2026-01-01T09:00:00Z",
      "digital_form":  … }
        "id": "e75b04dc-2889-491d-8e08-691c3a830d9c",
        "object": "digital_form",
        "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
        "created_at": "2026-01-01T09:00:00Z",
        "patient_instructions": "Please complete this form before your appointment.",
        "questions":  … ]
           … }
            "id": "2214b284-64d6-4130-8b10-1602a2050126",
            "choices":  … ]
               … }
                "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
                "numerical_value": 1.5,
                "text_value": "yes",
                "title": "Dr"
              }
            ],
            "help_text": "Select every option that applies.",
            "is_answer_required": true,
            "list_order_number": 1,
            "question_type": "consent_required",
            "title": "Dr"
          }
        ],
        "title": "Dr",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "due_at": "2026-01-01T09:00:00Z",
      "links":  … }
        "patient": "https://api.carebit.co/v1/patients/1a2b3c4d-5e6f-4789-8abc-def012345678",
        "transmissions": "https://api.carebit.co/v1/transmissions?patient_id=1a2b3c4d-5e6f-4789-8abc-def012345678&resource_type=digital_form_response"
      },
      "patient_id": "1a2b3c4d-5e6f-4789-8abc-def012345678",
      "status": "awaiting_completion",
      "total_score": 1,
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzdGFydF90aW1lIjoiMjAyNi0wMS0wMVQwOTowMDowMFoifQ",
  "url": "/v1/digital_form_responses"
}

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/digital_form_responses?patient_id=8f14e45f-ea7d-4b6f-9c2a-1d3e5f7a9b0c" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN"

200 response

{
  "object": "list",
  "data":  … ]
     … }
      "id": "4262fdc0-c7a1-4856-83c4-16ed34cb8773",
      "object": "digital_form_response",
      "answers":  … ]
         … }
          "id": "7ae2abaf-6f3e-4fbf-842d-5cbbe91b8492",
          "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
          "date_value": "2026-01-01",
          "digital_form_question":  … }
            "id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
            "choices":  … ]
               … }
                "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
                "numerical_value": 1.5,
                "text_value": "yes",
                "title": "Dr"
              }
            ],
            "help_text": "Select every option that applies.",
            "is_answer_required": true,
            "list_order_number": 1,
            "question_type": "consent_required",
            "title": "Dr"
          },
          "digital_form_question_choice_id": "26a2ba65-f724-4add-8940-9f63f02f8711",
          "digital_form_question_id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
          "has_consented": true,
          "numerical_value": 1.5,
          "text_value": "The symptoms started two weeks ago."
        }
      ],
      "booking_id": "92a3b4c5-d6e7-4f01-8234-56789abcdef0",
      "completed_at": "2026-01-01T09:00:00Z",
      "created_at": "2026-01-01T09:00:00Z",
      "digital_form":  … }
        "id": "e75b04dc-2889-491d-8e08-691c3a830d9c",
        "object": "digital_form",
        "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
        "created_at": "2026-01-01T09:00:00Z",
        "patient_instructions": "Please complete this form before your appointment.",
        "questions":  … ]
           … }
            "id": "2214b284-64d6-4130-8b10-1602a2050126",
            "choices":  … ]
               … }
                "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
                "numerical_value": 1.5,
                "text_value": "yes",
                "title": "Dr"
              }
            ],
            "help_text": "Select every option that applies.",
            "is_answer_required": true,
            "list_order_number": 1,
            "question_type": "consent_required",
            "title": "Dr"
          }
        ],
        "title": "Dr",
        "updated_at": "2026-01-01T09:00:00Z"
      },
      "due_at": "2026-01-01T09:00:00Z",
      "links":  … }
        "patient": "https://api.carebit.co/v1/patients/1a2b3c4d-5e6f-4789-8abc-def012345678",
        "transmissions": "https://api.carebit.co/v1/transmissions?patient_id=1a2b3c4d-5e6f-4789-8abc-def012345678&resource_type=digital_form_response"
      },
      "patient_id": "1a2b3c4d-5e6f-4789-8abc-def012345678",
      "status": "awaiting_completion",
      "total_score": 1,
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzdGFydF90aW1lIjoiMjAyNi0wMS0wMVQwOTowMDowMFoifQ",
  "url": "/v1/digital_form_responses"
}

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"
  }
}

post/v1/digital_form_responses

Create and send a DigitalFormResponse

Creates a pending DigitalFormResponse and queues an email asking the Patient to complete it.

Required API scopes: digital_form_responses.create

Parameters

Idempotency-Key
header · required
string
Client-generated idempotency key. Required for every POST/PATCH write. Replay of the same key with the same body returns the stored response with an Idempotency-Replayed: true header. Same key + different body returns 422 idempotency_key_reused. A duplicate that arrives while the first request is still in flight returns 409 idempotency_conflict with Retry-After: 1.

Request body

application/json

booking_idstring | null · uuid
The optional Booking associated with the response.
digital_form_idstring · uuidrequired
The DigitalForm to send to the Patient.
due_atstring | null · date-time
The optional time by which the Patient should complete the DigitalForm.
patient_idstring · uuidrequired
The Patient who should complete the DigitalForm.

Responses

201

The requested DigitalFormResponse.

answersarrayrequired
The answers currently recorded for the DigitalFormResponse.
- itemsobject
  - attachment_urlstring | null · urirequired
    The temporary URL for an attached answer.
  - date_valuestring | null · daterequired
    The date supplied for a date question.
  - digital_form_questionobjectrequired
    A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer.
    - choicesarrayrequired
      The choices available for a choice question.
      - itemsobject
        idstring · uuidrequired
        The identifier of the DigitalFormQuestionChoice.
        numerical_valuenumber | nullrequired
        The optional numerical value assigned to the choice.
        text_valuestring | nullrequired
        The optional machine-readable text value assigned to the choice.
        titlestringrequired
        The choice shown to the Patient.
    - help_textstring | nullrequired
      The supplementary guidance shown with the question.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - is_answer_requiredbooleanrequired
      Whether the Patient must answer the question.
    - list_order_numberinteger | nullrequired
      The position of the question in the DigitalForm.
    - question_typestringrequired
      The input and consent behavior of the question.
      Allowed values: consent_required | information_statement | multiple_choice_input | single_choice_input | text_input | number_input | date_input | signature_input
    - titlestringrequired
      The question shown to the Patient.
  - digital_form_question_choice_idstring | null · uuidrequired
    The selected DigitalFormQuestionChoice.
  - digital_form_question_idstring · uuidrequired
    The DigitalFormQuestion answered.
  - has_consentedboolean | nullrequired
    Whether the Patient granted the requested consent.
  - idstring · uuidrequired
    The identifier of the DigitalFormQuestionAnswer.
  - numerical_valuenumber | nullrequired
    The numerical answer.
  - text_valuestring | nullrequired
    The text answer or selected choice title.
booking_idstring | null · uuidrequired
The Booking associated with the response.
completed_atstring | null · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
digital_formobjectrequired
- attachment_urlstring | null · urirequired
  The temporary URL for the attachment displayed with the DigitalForm.
- 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.
- objectanyrequired
  Discriminator value emitted at object.
- patient_instructionsstring | nullrequired
  The sanitized instructions shown to the Patient.
- questionsarrayrequired
  The ordered questions included in the DigitalForm.
  - itemsobject
    A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer.
    - choicesarrayrequired
      The choices available for a choice question.
      - itemsobject
        idstring · uuidrequired
        The identifier of the DigitalFormQuestionChoice.
        numerical_valuenumber | nullrequired
        The optional numerical value assigned to the choice.
        text_valuestring | nullrequired
        The optional machine-readable text value assigned to the choice.
        titlestringrequired
        The choice shown to the Patient.
    - help_textstring | nullrequired
      The supplementary guidance shown with the question.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - is_answer_requiredbooleanrequired
      Whether the Patient must answer the question.
    - list_order_numberinteger | nullrequired
      The position of the question in the DigitalForm.
    - question_typestringrequired
      The input and consent behavior of the question.
      Allowed values: consent_required | information_statement | multiple_choice_input | single_choice_input | text_input | number_input | date_input | signature_input
    - titlestringrequired
      The question shown to the Patient.
- titlestringrequired
  The title of the DigitalForm.
- updated_atstring · date-timerequired
  An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
due_atstring | null · 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.
linksobjectrequired
URLs to related resources.
- patientstring · urirequired
  The full URL of a related resource.
- transmissionsstring · urirequired
  The full URL of a related resource.
objectanyrequired
Discriminator value emitted at object.
patient_idstring · uuidrequired
The Patient asked to complete the DigitalForm.
statusstringrequired
The completion status of the DigitalFormResponse.
Allowed values: awaiting_completion | partially_completed | overdue | completed
total_scoreinteger | nullrequired
The sum of numerical answers configured to contribute to the score.
updated_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.

Example

{
  "id": "4262fdc0-c7a1-4856-83c4-16ed34cb8773",
  "object": "digital_form_response",
  "answers":  … ]
     … }
      "id": "7ae2abaf-6f3e-4fbf-842d-5cbbe91b8492",
      "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
      "date_value": "2026-01-01",
      "digital_form_question":  … }
        "id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
        "choices":  … ]
           … }
            "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
            "numerical_value": 1.5,
            "text_value": "yes",
            "title": "Dr"
          }
        ],
        "help_text": "Select every option that applies.",
        "is_answer_required": true,
        "list_order_number": 1,
        "question_type": "consent_required",
        "title": "Dr"
      },
      "digital_form_question_choice_id": "26a2ba65-f724-4add-8940-9f63f02f8711",
      "digital_form_question_id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
      "has_consented": true,
      "numerical_value": 1.5,
      "text_value": "The symptoms started two weeks ago."
    }
  ],
  "booking_id": "92a3b4c5-d6e7-4f01-8234-56789abcdef0",
  "completed_at": "2026-01-01T09:00:00Z",
  "created_at": "2026-01-01T09:00:00Z",
  "digital_form":  … }
    "id": "e75b04dc-2889-491d-8e08-691c3a830d9c",
    "object": "digital_form",
    "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
    "created_at": "2026-01-01T09:00:00Z",
    "patient_instructions": "Please complete this form before your appointment.",
    "questions":  … ]
       … }
        "id": "2214b284-64d6-4130-8b10-1602a2050126",
        "choices":  … ]
           … }
            "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
            "numerical_value": 1.5,
            "text_value": "yes",
            "title": "Dr"
          }
        ],
        "help_text": "Select every option that applies.",
        "is_answer_required": true,
        "list_order_number": 1,
        "question_type": "consent_required",
        "title": "Dr"
      }
    ],
    "title": "Dr",
    "updated_at": "2026-01-01T09:00:00Z"
  },
  "due_at": "2026-01-01T09:00:00Z",
  "links":  … }
    "patient": "https://api.carebit.co/v1/patients/1a2b3c4d-5e6f-4789-8abc-def012345678",
    "transmissions": "https://api.carebit.co/v1/transmissions?patient_id=1a2b3c4d-5e6f-4789-8abc-def012345678&resource_type=digital_form_response"
  },
  "patient_id": "1a2b3c4d-5e6f-4789-8abc-def012345678",
  "status": "awaiting_completion",
  "total_score": 1,
  "updated_at": "2026-01-01T09:00:00Z"
}

400

The Idempotency-Key header is missing (idempotency_key_required) or exceeds 255 characters (idempotency_key_too_long).

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"
  }
}

409

A concurrent request holds the idempotency lease (idempotency_conflict). 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"
  }
}

422

The Idempotency-Key was previously used with a different request body (idempotency_key_reused), or the request body failed validation.

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 POST "https://api.carebit.co/v1/digital_form_responses" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "booking_id": "00000000-0000-4000-8000-000000000001",
  "digital_form_id": "00000000-0000-4000-8000-000000000020",
  "due_at": "2026-01-04T17:00:00Z",
  "patient_id": "00000000-0000-4000-8000-000000000004"
}'

201 response

{
  "id": "4262fdc0-c7a1-4856-83c4-16ed34cb8773",
  "object": "digital_form_response",
  "answers":  … ]
     … }
      "id": "7ae2abaf-6f3e-4fbf-842d-5cbbe91b8492",
      "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
      "date_value": "2026-01-01",
      "digital_form_question":  … }
        "id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
        "choices":  … ]
           … }
            "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
            "numerical_value": 1.5,
            "text_value": "yes",
            "title": "Dr"
          }
        ],
        "help_text": "Select every option that applies.",
        "is_answer_required": true,
        "list_order_number": 1,
        "question_type": "consent_required",
        "title": "Dr"
      },
      "digital_form_question_choice_id": "26a2ba65-f724-4add-8940-9f63f02f8711",
      "digital_form_question_id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
      "has_consented": true,
      "numerical_value": 1.5,
      "text_value": "The symptoms started two weeks ago."
    }
  ],
  "booking_id": "92a3b4c5-d6e7-4f01-8234-56789abcdef0",
  "completed_at": "2026-01-01T09:00:00Z",
  "created_at": "2026-01-01T09:00:00Z",
  "digital_form":  … }
    "id": "e75b04dc-2889-491d-8e08-691c3a830d9c",
    "object": "digital_form",
    "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
    "created_at": "2026-01-01T09:00:00Z",
    "patient_instructions": "Please complete this form before your appointment.",
    "questions":  … ]
       … }
        "id": "2214b284-64d6-4130-8b10-1602a2050126",
        "choices":  … ]
           … }
            "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
            "numerical_value": 1.5,
            "text_value": "yes",
            "title": "Dr"
          }
        ],
        "help_text": "Select every option that applies.",
        "is_answer_required": true,
        "list_order_number": 1,
        "question_type": "consent_required",
        "title": "Dr"
      }
    ],
    "title": "Dr",
    "updated_at": "2026-01-01T09:00:00Z"
  },
  "due_at": "2026-01-01T09:00:00Z",
  "links":  … }
    "patient": "https://api.carebit.co/v1/patients/1a2b3c4d-5e6f-4789-8abc-def012345678",
    "transmissions": "https://api.carebit.co/v1/transmissions?patient_id=1a2b3c4d-5e6f-4789-8abc-def012345678&resource_type=digital_form_response"
  },
  "patient_id": "1a2b3c4d-5e6f-4789-8abc-def012345678",
  "status": "awaiting_completion",
  "total_score": 1,
  "updated_at": "2026-01-01T09:00:00Z"
}

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"
  }
}

409 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"
  }
}

422 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"
  }
}

get/v1/digital_form_responses/:id

Retrieve a DigitalFormResponse

Required API scopes: digital_form_responses.read

Parameters

id
path · required
string
The identifier of the DigitalFormResponse.

Responses

200

The requested DigitalFormResponse.

answersarrayrequired
The answers currently recorded for the DigitalFormResponse.
- itemsobject
  - attachment_urlstring | null · urirequired
    The temporary URL for an attached answer.
  - date_valuestring | null · daterequired
    The date supplied for a date question.
  - digital_form_questionobjectrequired
    A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer.
    - choicesarrayrequired
      The choices available for a choice question.
      - itemsobject
        idstring · uuidrequired
        The identifier of the DigitalFormQuestionChoice.
        numerical_valuenumber | nullrequired
        The optional numerical value assigned to the choice.
        text_valuestring | nullrequired
        The optional machine-readable text value assigned to the choice.
        titlestringrequired
        The choice shown to the Patient.
    - help_textstring | nullrequired
      The supplementary guidance shown with the question.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - is_answer_requiredbooleanrequired
      Whether the Patient must answer the question.
    - list_order_numberinteger | nullrequired
      The position of the question in the DigitalForm.
    - question_typestringrequired
      The input and consent behavior of the question.
      Allowed values: consent_required | information_statement | multiple_choice_input | single_choice_input | text_input | number_input | date_input | signature_input
    - titlestringrequired
      The question shown to the Patient.
  - digital_form_question_choice_idstring | null · uuidrequired
    The selected DigitalFormQuestionChoice.
  - digital_form_question_idstring · uuidrequired
    The DigitalFormQuestion answered.
  - has_consentedboolean | nullrequired
    Whether the Patient granted the requested consent.
  - idstring · uuidrequired
    The identifier of the DigitalFormQuestionAnswer.
  - numerical_valuenumber | nullrequired
    The numerical answer.
  - text_valuestring | nullrequired
    The text answer or selected choice title.
booking_idstring | null · uuidrequired
The Booking associated with the response.
completed_atstring | null · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
digital_formobjectrequired
- attachment_urlstring | null · urirequired
  The temporary URL for the attachment displayed with the DigitalForm.
- 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.
- objectanyrequired
  Discriminator value emitted at object.
- patient_instructionsstring | nullrequired
  The sanitized instructions shown to the Patient.
- questionsarrayrequired
  The ordered questions included in the DigitalForm.
  - itemsobject
    A question on a DigitalForm. Embedded on DigitalForm and on each DigitalFormResponse answer.
    - choicesarrayrequired
      The choices available for a choice question.
      - itemsobject
        idstring · uuidrequired
        The identifier of the DigitalFormQuestionChoice.
        numerical_valuenumber | nullrequired
        The optional numerical value assigned to the choice.
        text_valuestring | nullrequired
        The optional machine-readable text value assigned to the choice.
        titlestringrequired
        The choice shown to the Patient.
    - help_textstring | nullrequired
      The supplementary guidance shown with the question.
    - idstring · uuidrequired
      The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
    - is_answer_requiredbooleanrequired
      Whether the Patient must answer the question.
    - list_order_numberinteger | nullrequired
      The position of the question in the DigitalForm.
    - question_typestringrequired
      The input and consent behavior of the question.
      Allowed values: consent_required | information_statement | multiple_choice_input | single_choice_input | text_input | number_input | date_input | signature_input
    - titlestringrequired
      The question shown to the Patient.
- titlestringrequired
  The title of the DigitalForm.
- updated_atstring · date-timerequired
  An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
due_atstring | null · 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.
linksobjectrequired
URLs to related resources.
- patientstring · urirequired
  The full URL of a related resource.
- transmissionsstring · urirequired
  The full URL of a related resource.
objectanyrequired
Discriminator value emitted at object.
patient_idstring · uuidrequired
The Patient asked to complete the DigitalForm.
statusstringrequired
The completion status of the DigitalFormResponse.
Allowed values: awaiting_completion | partially_completed | overdue | completed
total_scoreinteger | nullrequired
The sum of numerical answers configured to contribute to the score.
updated_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.

Example

{
  "id": "4262fdc0-c7a1-4856-83c4-16ed34cb8773",
  "object": "digital_form_response",
  "answers":  … ]
     … }
      "id": "7ae2abaf-6f3e-4fbf-842d-5cbbe91b8492",
      "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
      "date_value": "2026-01-01",
      "digital_form_question":  … }
        "id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
        "choices":  … ]
           … }
            "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
            "numerical_value": 1.5,
            "text_value": "yes",
            "title": "Dr"
          }
        ],
        "help_text": "Select every option that applies.",
        "is_answer_required": true,
        "list_order_number": 1,
        "question_type": "consent_required",
        "title": "Dr"
      },
      "digital_form_question_choice_id": "26a2ba65-f724-4add-8940-9f63f02f8711",
      "digital_form_question_id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
      "has_consented": true,
      "numerical_value": 1.5,
      "text_value": "The symptoms started two weeks ago."
    }
  ],
  "booking_id": "92a3b4c5-d6e7-4f01-8234-56789abcdef0",
  "completed_at": "2026-01-01T09:00:00Z",
  "created_at": "2026-01-01T09:00:00Z",
  "digital_form":  … }
    "id": "e75b04dc-2889-491d-8e08-691c3a830d9c",
    "object": "digital_form",
    "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
    "created_at": "2026-01-01T09:00:00Z",
    "patient_instructions": "Please complete this form before your appointment.",
    "questions":  … ]
       … }
        "id": "2214b284-64d6-4130-8b10-1602a2050126",
        "choices":  … ]
           … }
            "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
            "numerical_value": 1.5,
            "text_value": "yes",
            "title": "Dr"
          }
        ],
        "help_text": "Select every option that applies.",
        "is_answer_required": true,
        "list_order_number": 1,
        "question_type": "consent_required",
        "title": "Dr"
      }
    ],
    "title": "Dr",
    "updated_at": "2026-01-01T09:00:00Z"
  },
  "due_at": "2026-01-01T09:00:00Z",
  "links":  … }
    "patient": "https://api.carebit.co/v1/patients/1a2b3c4d-5e6f-4789-8abc-def012345678",
    "transmissions": "https://api.carebit.co/v1/transmissions?patient_id=1a2b3c4d-5e6f-4789-8abc-def012345678&resource_type=digital_form_response"
  },
  "patient_id": "1a2b3c4d-5e6f-4789-8abc-def012345678",
  "status": "awaiting_completion",
  "total_score": 1,
  "updated_at": "2026-01-01T09:00:00Z"
}

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/digital_form_responses/8f14e45f-ea7d-4b6f-9c2a-1d3e5f7a9b0c" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN"

200 response

{
  "id": "4262fdc0-c7a1-4856-83c4-16ed34cb8773",
  "object": "digital_form_response",
  "answers":  … ]
     … }
      "id": "7ae2abaf-6f3e-4fbf-842d-5cbbe91b8492",
      "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
      "date_value": "2026-01-01",
      "digital_form_question":  … }
        "id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
        "choices":  … ]
           … }
            "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
            "numerical_value": 1.5,
            "text_value": "yes",
            "title": "Dr"
          }
        ],
        "help_text": "Select every option that applies.",
        "is_answer_required": true,
        "list_order_number": 1,
        "question_type": "consent_required",
        "title": "Dr"
      },
      "digital_form_question_choice_id": "26a2ba65-f724-4add-8940-9f63f02f8711",
      "digital_form_question_id": "6d826770-c3ae-43c6-8b16-5ff8a72a24da",
      "has_consented": true,
      "numerical_value": 1.5,
      "text_value": "The symptoms started two weeks ago."
    }
  ],
  "booking_id": "92a3b4c5-d6e7-4f01-8234-56789abcdef0",
  "completed_at": "2026-01-01T09:00:00Z",
  "created_at": "2026-01-01T09:00:00Z",
  "digital_form":  … }
    "id": "e75b04dc-2889-491d-8e08-691c3a830d9c",
    "object": "digital_form",
    "attachment_url": "https://files.example.invalid/document.pdf?signature=test",
    "created_at": "2026-01-01T09:00:00Z",
    "patient_instructions": "Please complete this form before your appointment.",
    "questions":  … ]
       … }
        "id": "2214b284-64d6-4130-8b10-1602a2050126",
        "choices":  … ]
           … }
            "id": "4f4f0cb8-0f36-42ed-8292-e679adb19729",
            "numerical_value": 1.5,
            "text_value": "yes",
            "title": "Dr"
          }
        ],
        "help_text": "Select every option that applies.",
        "is_answer_required": true,
        "list_order_number": 1,
        "question_type": "consent_required",
        "title": "Dr"
      }
    ],
    "title": "Dr",
    "updated_at": "2026-01-01T09:00:00Z"
  },
  "due_at": "2026-01-01T09:00:00Z",
  "links":  … }
    "patient": "https://api.carebit.co/v1/patients/1a2b3c4d-5e6f-4789-8abc-def012345678",
    "transmissions": "https://api.carebit.co/v1/transmissions?patient_id=1a2b3c4d-5e6f-4789-8abc-def012345678&resource_type=digital_form_response"
  },
  "patient_id": "1a2b3c4d-5e6f-4789-8abc-def012345678",
  "status": "awaiting_completion",
  "total_score": 1,
  "updated_at": "2026-01-01T09:00:00Z"
}

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"
  }
}

Prefer plain text? Append ?format=md or send Accept: text/markdown to receive this page as raw Markdown.