Carebit API

Digital Forms

Forms and consent requests that Patients can complete.

Endpoints

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

get/v1/digital_formsList DigitalForms
get/v1/digital_forms/:idRetrieve a DigitalForm

get/v1/digital_forms

List DigitalForms

Required API scopes: digital_forms.read

Parameters

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 DigitalForm objects.

dataarrayrequired
- itemsobject
  - 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.
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": "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"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzdGFydF90aW1lIjoiMjAyNi0wMS0wMVQwOTowMDowMFoifQ",
  "url": "/v1/digital_forms"
}

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

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_forms" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN"

200 response

{
  "object": "list",
  "data":  … ]
     … }
      "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"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzdGFydF90aW1lIjoiMjAyNi0wMS0wMVQwOTowMDowMFoifQ",
  "url": "/v1/digital_forms"
}

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

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_forms/:id

Retrieve a DigitalForm

Required API scopes: digital_forms.read

Parameters

id
path · required
string
The identifier of the DigitalForm.

Responses

200

The requested DigitalForm.

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.

Example

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

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

200 response

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

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.