Carebit API

Human Tasks

Tasks assigned to StaffMembers to complete.

Required API scopes: human_tasks.createhuman_tasks.readhuman_tasks.update

Endpoints

Scroll this page to read every Human Tasks endpoint, or jump to one below.

get/v1/human_tasksList HumanTaskshuman_tasks.read
post/v1/human_tasksCreate a HumanTaskhuman_tasks.create
get/v1/human_tasks/:idGet a HumanTaskhuman_tasks.read
patch/v1/human_tasks/:idUpdate a HumanTaskhuman_tasks.update
post/v1/human_tasks/:id/commentsAdd a Comment to a HumanTaskhuman_tasks.update

get/v1/human_tasks

List HumanTasks

Returns HumanTasks in the Organization's staff task queue. Filter by Patient, assigned StaffMember, or Document. Each HumanTask includes its Comments. Results are newest first.

Required API scopes: human_tasks.read

Parameters

patient_id
query
string
Return HumanTasks associated with this Patient.
staff_member_id
query
string
Return HumanTasks assigned to this StaffMember. Look up identifiers with GET /v1/staff_members.
document_id
query
string
Return HumanTasks associated with this Document, for example a Letter, TestResult, Photo, or BookingForm.
is_completed
query
boolean
When true, return only completed HumanTasks. When false, return only open HumanTasks.
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 HumanTask objects.

dataarrayrequired
- itemsobject
  - assigneesarrayrequired
    The people assigned to the HumanTask. Currently only staff_member is supported.
    - itemsobject
      - assignee_idstring · uuidrequired
        The identifier of the assignee. For staff_member, use an identifier from GET /v1/staff_members.
      - assignee_typestringrequired
        The type of assignee. Currently only staff_member is supported.
        Allowed values: staff_member
  - commentsarrayrequired
    Comments on the HumanTask, oldest first. Discarded Comments are omitted.
    - itemsobject
      - contentstringrequired
        The sanitized comment text.
      - created_atstring · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
      - created_by_staff_member_idstring | null · uuidrequired
        The StaffMember who wrote the Comment in Carebit. Null when the Comment was created through the API.
      - human_task_idstring · uuidrequired
        The HumanTask this Comment belongs to.
      - idstring · uuidrequired
        The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
      - linksobjectrequired
        URLs to related resources.
        created_by_staff_memberstring | null · urirequired
        The full URL of a related resource.
        human_taskstring · urirequired
        The full URL of a related resource.
      - objectanyrequired
        Discriminator value emitted at object.
      - updated_atstring · date-timerequired
        An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - completed_atstring | null · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - completed_by_staff_member_idstring | null · uuidrequired
    The StaffMember who completed the HumanTask in Carebit. Null when the HumanTask is open, or when it was completed through the API without a StaffMember.
  - contentstringrequired
    The sanitized description of the work to complete.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - creation_sourcestring | nullrequired
    How the HumanTask was created. api means the record was created through the Developer Platform API. Read-only.
    Allowed values: api | app | automation | import | staff_member | null
  - document_idstring | null · uuidrequired
    The Document associated with the HumanTask, when the HumanTask belongs to a Letter, TestResult, Photo, or BookingForm.
  - due_datestring · daterequired
    The date by which staff should complete the HumanTask.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - is_remindablebooleanrequired
    Whether Carebit can send reminders when the HumanTask becomes due.
  - is_urgentbooleanrequired
    Whether the HumanTask is marked as urgent.
  - linksobjectrequired
    URLs to related resources.
    - completed_by_staff_memberstring | null · urirequired
      The full URL of a related resource.
    - documentstring | null · urirequired
      The full URL of a related resource.
    - patientstring | null · urirequired
      The full URL of a related resource.
  - objectanyrequired
    Discriminator value emitted at object.
  - patient_idstring | null · uuidrequired
    The Patient associated with the HumanTask.
  - 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": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
      "object": "human_task",
      "assignees":  … ]
         … }
          "assignee_id": "00000000-0000-4000-8000-000000000021",
          "assignee_type": "staff_member"
        }
      ],
      "comments":  … ]
         … }
          "id": "e7bcd0e1-df8c-456f-8242-ef51dac3b061",
          "object": "comment",
          "content": "Moved this to the secretary after the Patient called.",
          "created_at": "2026-01-01T09:00:00Z",
          "created_by_staff_member_id": "820b1195-41c0-476a-8add-3f2e706e2c01",
          "human_task_id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
          "links":  … }
            "created_by_staff_member": "https://api.carebit.co/v1/created_by_staff_members/820b1195-41c0-476a-8add-3f2e706e2c01",
            "human_task": "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496"
          },
          "updated_at": "2026-01-01T09:00:00Z"
        }
      ],
      "completed_at": "2026-01-01T09:00:00Z",
      "completed_by_staff_member_id": "d5988084-3224-4174-8e46-83702cadb572",
      "content": "Review the Patient's completed consent form.",
      "created_at": "2026-01-01T09:00:00Z",
      "creation_source": "api",
      "document_id": "78aa99b3-1b45-47c3-8608-ece2f58b39ee",
      "due_date": "2026-01-01",
      "is_remindable": true,
      "is_urgent": true,
      "links":  … }
        "completed_by_staff_member": "https://api.carebit.co/v1/completed_by_staff_members/d5988084-3224-4174-8e46-83702cadb572",
        "document": "https://api.carebit.co/v1/documents/78aa99b3-1b45-47c3-8608-ece2f58b39ee",
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
      },
      "patient_id": "00000000-0000-4000-8000-000000000004",
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzdGFydF90aW1lIjoiMjAyNi0wMS0wMVQwOTowMDowMFoifQ",
  "url": "/v1/human_tasks"
}

400

A filter or 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"
  }
}

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

200 response

{
  "object": "list",
  "data":  … ]
     … }
      "id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
      "object": "human_task",
      "assignees":  … ]
         … }
          "assignee_id": "00000000-0000-4000-8000-000000000021",
          "assignee_type": "staff_member"
        }
      ],
      "comments":  … ]
         … }
          "id": "e7bcd0e1-df8c-456f-8242-ef51dac3b061",
          "object": "comment",
          "content": "Moved this to the secretary after the Patient called.",
          "created_at": "2026-01-01T09:00:00Z",
          "created_by_staff_member_id": "820b1195-41c0-476a-8add-3f2e706e2c01",
          "human_task_id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
          "links":  … }
            "created_by_staff_member": "https://api.carebit.co/v1/created_by_staff_members/820b1195-41c0-476a-8add-3f2e706e2c01",
            "human_task": "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496"
          },
          "updated_at": "2026-01-01T09:00:00Z"
        }
      ],
      "completed_at": "2026-01-01T09:00:00Z",
      "completed_by_staff_member_id": "d5988084-3224-4174-8e46-83702cadb572",
      "content": "Review the Patient's completed consent form.",
      "created_at": "2026-01-01T09:00:00Z",
      "creation_source": "api",
      "document_id": "78aa99b3-1b45-47c3-8608-ece2f58b39ee",
      "due_date": "2026-01-01",
      "is_remindable": true,
      "is_urgent": true,
      "links":  … }
        "completed_by_staff_member": "https://api.carebit.co/v1/completed_by_staff_members/d5988084-3224-4174-8e46-83702cadb572",
        "document": "https://api.carebit.co/v1/documents/78aa99b3-1b45-47c3-8608-ece2f58b39ee",
        "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
      },
      "patient_id": "00000000-0000-4000-8000-000000000004",
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJzdGFydF90aW1lIjoiMjAyNi0wMS0wMVQwOTowMDowMFoifQ",
  "url": "/v1/human_tasks"
}

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

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/human_tasks

Create a HumanTask

Creates a HumanTask in the Organization's existing staff task queue. Look up assignable StaffMembers with GET /v1/staff_members.

Required API scopes: human_tasks.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

assigneesarray
The people to assign to the HumanTask. Each object requires assignee_type and assignee_id. Currently only staff_member is supported.
- itemsobject
  - assignee_idstring · uuidrequired
    The identifier of the assignee. For staff_member, use an identifier from GET /v1/staff_members.
  - assignee_typestringrequired
    The type of assignee. Currently only staff_member is supported.
    Allowed values: staff_member
contentstringrequired
The description of the work to complete.
document_idstring | null · uuid
The optional Document associated with the HumanTask, for example a Letter, TestResult, Photo, or BookingForm.
due_datestring · daterequired
The date by which staff should complete the HumanTask.
is_remindableboolean
Whether Carebit can send reminders when the HumanTask becomes due.
is_urgentboolean
Whether the HumanTask should be marked as urgent.
patient_idstring | null · uuid
The optional Patient associated with the HumanTask.

Responses

201

The requested HumanTask.

assigneesarrayrequired
The people assigned to the HumanTask. Currently only staff_member is supported.
- itemsobject
  - assignee_idstring · uuidrequired
    The identifier of the assignee. For staff_member, use an identifier from GET /v1/staff_members.
  - assignee_typestringrequired
    The type of assignee. Currently only staff_member is supported.
    Allowed values: staff_member
commentsarrayrequired
Comments on the HumanTask, oldest first. Discarded Comments are omitted.
- itemsobject
  - contentstringrequired
    The sanitized comment text.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - created_by_staff_member_idstring | null · uuidrequired
    The StaffMember who wrote the Comment in Carebit. Null when the Comment was created through the API.
  - human_task_idstring · uuidrequired
    The HumanTask this Comment belongs to.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - linksobjectrequired
    URLs to related resources.
    - created_by_staff_memberstring | null · urirequired
      The full URL of a related resource.
    - human_taskstring · urirequired
      The full URL of a related resource.
  - objectanyrequired
    Discriminator value emitted at object.
  - updated_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
completed_atstring | null · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
completed_by_staff_member_idstring | null · uuidrequired
The StaffMember who completed the HumanTask in Carebit. Null when the HumanTask is open, or when it was completed through the API without a StaffMember.
contentstringrequired
The sanitized description of the work to complete.
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
creation_sourcestring | nullrequired
How the HumanTask was created. api means the record was created through the Developer Platform API. Read-only.
Allowed values: api | app | automation | import | staff_member | null
document_idstring | null · uuidrequired
The Document associated with the HumanTask, when the HumanTask belongs to a Letter, TestResult, Photo, or BookingForm.
due_datestring · daterequired
The date by which staff should complete the HumanTask.
idstring · uuidrequired
The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
is_remindablebooleanrequired
Whether Carebit can send reminders when the HumanTask becomes due.
is_urgentbooleanrequired
Whether the HumanTask is marked as urgent.
linksobjectrequired
URLs to related resources.
- completed_by_staff_memberstring | null · urirequired
  The full URL of a related resource.
- documentstring | null · urirequired
  The full URL of a related resource.
- patientstring | null · urirequired
  The full URL of a related resource.
objectanyrequired
Discriminator value emitted at object.
patient_idstring | null · uuidrequired
The Patient associated with the HumanTask.
updated_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.

Example

{
  "id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
  "object": "human_task",
  "assignees":  … ]
     … }
      "assignee_id": "00000000-0000-4000-8000-000000000021",
      "assignee_type": "staff_member"
    }
  ],
  "comments":  … ]
     … }
      "id": "e7bcd0e1-df8c-456f-8242-ef51dac3b061",
      "object": "comment",
      "content": "Moved this to the secretary after the Patient called.",
      "created_at": "2026-01-01T09:00:00Z",
      "created_by_staff_member_id": "820b1195-41c0-476a-8add-3f2e706e2c01",
      "human_task_id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
      "links":  … }
        "created_by_staff_member": "https://api.carebit.co/v1/created_by_staff_members/820b1195-41c0-476a-8add-3f2e706e2c01",
        "human_task": "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496"
      },
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "completed_at": "2026-01-01T09:00:00Z",
  "completed_by_staff_member_id": "d5988084-3224-4174-8e46-83702cadb572",
  "content": "Review the Patient's completed consent form.",
  "created_at": "2026-01-01T09:00:00Z",
  "creation_source": "api",
  "document_id": "78aa99b3-1b45-47c3-8608-ece2f58b39ee",
  "due_date": "2026-01-01",
  "is_remindable": true,
  "is_urgent": true,
  "links":  … }
    "completed_by_staff_member": "https://api.carebit.co/v1/completed_by_staff_members/d5988084-3224-4174-8e46-83702cadb572",
    "document": "https://api.carebit.co/v1/documents/78aa99b3-1b45-47c3-8608-ece2f58b39ee",
    "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
  },
  "patient_id": "00000000-0000-4000-8000-000000000004",
  "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/human_tasks" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "assignees": [
    {
      "assignee_id": "00000000-0000-4000-8000-000000000021",
      "assignee_type": "staff_member"
    }
  ],
  "content": "Review the Patient'\''s pre-operative DigitalFormResponse.",
  "due_date": "2026-01-04",
  "is_urgent": false,
  "patient_id": "00000000-0000-4000-8000-000000000004"
}'

201 response

{
  "id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
  "object": "human_task",
  "assignees":  … ]
     … }
      "assignee_id": "00000000-0000-4000-8000-000000000021",
      "assignee_type": "staff_member"
    }
  ],
  "comments":  … ]
     … }
      "id": "e7bcd0e1-df8c-456f-8242-ef51dac3b061",
      "object": "comment",
      "content": "Moved this to the secretary after the Patient called.",
      "created_at": "2026-01-01T09:00:00Z",
      "created_by_staff_member_id": "820b1195-41c0-476a-8add-3f2e706e2c01",
      "human_task_id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
      "links":  … }
        "created_by_staff_member": "https://api.carebit.co/v1/created_by_staff_members/820b1195-41c0-476a-8add-3f2e706e2c01",
        "human_task": "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496"
      },
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "completed_at": "2026-01-01T09:00:00Z",
  "completed_by_staff_member_id": "d5988084-3224-4174-8e46-83702cadb572",
  "content": "Review the Patient's completed consent form.",
  "created_at": "2026-01-01T09:00:00Z",
  "creation_source": "api",
  "document_id": "78aa99b3-1b45-47c3-8608-ece2f58b39ee",
  "due_date": "2026-01-01",
  "is_remindable": true,
  "is_urgent": true,
  "links":  … }
    "completed_by_staff_member": "https://api.carebit.co/v1/completed_by_staff_members/d5988084-3224-4174-8e46-83702cadb572",
    "document": "https://api.carebit.co/v1/documents/78aa99b3-1b45-47c3-8608-ece2f58b39ee",
    "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
  },
  "patient_id": "00000000-0000-4000-8000-000000000004",
  "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/human_tasks/:id

Get a HumanTask

Returns one HumanTask in the Organization's staff task queue, including its Comments.

Required API scopes: human_tasks.read

Parameters

id
path · required
string
-

Responses

200

The requested HumanTask.

assigneesarrayrequired
The people assigned to the HumanTask. Currently only staff_member is supported.
- itemsobject
  - assignee_idstring · uuidrequired
    The identifier of the assignee. For staff_member, use an identifier from GET /v1/staff_members.
  - assignee_typestringrequired
    The type of assignee. Currently only staff_member is supported.
    Allowed values: staff_member
commentsarrayrequired
Comments on the HumanTask, oldest first. Discarded Comments are omitted.
- itemsobject
  - contentstringrequired
    The sanitized comment text.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - created_by_staff_member_idstring | null · uuidrequired
    The StaffMember who wrote the Comment in Carebit. Null when the Comment was created through the API.
  - human_task_idstring · uuidrequired
    The HumanTask this Comment belongs to.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - linksobjectrequired
    URLs to related resources.
    - created_by_staff_memberstring | null · urirequired
      The full URL of a related resource.
    - human_taskstring · urirequired
      The full URL of a related resource.
  - objectanyrequired
    Discriminator value emitted at object.
  - updated_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
completed_atstring | null · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
completed_by_staff_member_idstring | null · uuidrequired
The StaffMember who completed the HumanTask in Carebit. Null when the HumanTask is open, or when it was completed through the API without a StaffMember.
contentstringrequired
The sanitized description of the work to complete.
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
creation_sourcestring | nullrequired
How the HumanTask was created. api means the record was created through the Developer Platform API. Read-only.
Allowed values: api | app | automation | import | staff_member | null
document_idstring | null · uuidrequired
The Document associated with the HumanTask, when the HumanTask belongs to a Letter, TestResult, Photo, or BookingForm.
due_datestring · daterequired
The date by which staff should complete the HumanTask.
idstring · uuidrequired
The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
is_remindablebooleanrequired
Whether Carebit can send reminders when the HumanTask becomes due.
is_urgentbooleanrequired
Whether the HumanTask is marked as urgent.
linksobjectrequired
URLs to related resources.
- completed_by_staff_memberstring | null · urirequired
  The full URL of a related resource.
- documentstring | null · urirequired
  The full URL of a related resource.
- patientstring | null · urirequired
  The full URL of a related resource.
objectanyrequired
Discriminator value emitted at object.
patient_idstring | null · uuidrequired
The Patient associated with the HumanTask.
updated_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.

Example

{
  "id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
  "object": "human_task",
  "assignees":  … ]
     … }
      "assignee_id": "00000000-0000-4000-8000-000000000021",
      "assignee_type": "staff_member"
    }
  ],
  "comments":  … ]
     … }
      "id": "e7bcd0e1-df8c-456f-8242-ef51dac3b061",
      "object": "comment",
      "content": "Moved this to the secretary after the Patient called.",
      "created_at": "2026-01-01T09:00:00Z",
      "created_by_staff_member_id": "820b1195-41c0-476a-8add-3f2e706e2c01",
      "human_task_id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
      "links":  … }
        "created_by_staff_member": "https://api.carebit.co/v1/created_by_staff_members/820b1195-41c0-476a-8add-3f2e706e2c01",
        "human_task": "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496"
      },
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "completed_at": "2026-01-01T09:00:00Z",
  "completed_by_staff_member_id": "d5988084-3224-4174-8e46-83702cadb572",
  "content": "Review the Patient's completed consent form.",
  "created_at": "2026-01-01T09:00:00Z",
  "creation_source": "api",
  "document_id": "78aa99b3-1b45-47c3-8608-ece2f58b39ee",
  "due_date": "2026-01-01",
  "is_remindable": true,
  "is_urgent": true,
  "links":  … }
    "completed_by_staff_member": "https://api.carebit.co/v1/completed_by_staff_members/d5988084-3224-4174-8e46-83702cadb572",
    "document": "https://api.carebit.co/v1/documents/78aa99b3-1b45-47c3-8608-ece2f58b39ee",
    "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
  },
  "patient_id": "00000000-0000-4000-8000-000000000004",
  "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/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN"

200 response

{
  "id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
  "object": "human_task",
  "assignees":  … ]
     … }
      "assignee_id": "00000000-0000-4000-8000-000000000021",
      "assignee_type": "staff_member"
    }
  ],
  "comments":  … ]
     … }
      "id": "e7bcd0e1-df8c-456f-8242-ef51dac3b061",
      "object": "comment",
      "content": "Moved this to the secretary after the Patient called.",
      "created_at": "2026-01-01T09:00:00Z",
      "created_by_staff_member_id": "820b1195-41c0-476a-8add-3f2e706e2c01",
      "human_task_id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
      "links":  … }
        "created_by_staff_member": "https://api.carebit.co/v1/created_by_staff_members/820b1195-41c0-476a-8add-3f2e706e2c01",
        "human_task": "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496"
      },
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "completed_at": "2026-01-01T09:00:00Z",
  "completed_by_staff_member_id": "d5988084-3224-4174-8e46-83702cadb572",
  "content": "Review the Patient's completed consent form.",
  "created_at": "2026-01-01T09:00:00Z",
  "creation_source": "api",
  "document_id": "78aa99b3-1b45-47c3-8608-ece2f58b39ee",
  "due_date": "2026-01-01",
  "is_remindable": true,
  "is_urgent": true,
  "links":  … }
    "completed_by_staff_member": "https://api.carebit.co/v1/completed_by_staff_members/d5988084-3224-4174-8e46-83702cadb572",
    "document": "https://api.carebit.co/v1/documents/78aa99b3-1b45-47c3-8608-ece2f58b39ee",
    "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
  },
  "patient_id": "00000000-0000-4000-8000-000000000004",
  "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"
  }
}

patch/v1/human_tasks/:id

Update a HumanTask

Updates a HumanTask in the Organization's staff task queue. Set completed_at to an ISO 8601 timestamp to complete it, or to null to reopen it. Replace assignees to reassign it. Add a Comment with POST /v1/human_tasks/{id}/comments. Look up assignable StaffMembers with GET /v1/staff_members.

Required API scopes: human_tasks.update

Parameters

id
path · required
string
-
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

assigneesarray
The people to assign to the HumanTask. Each object requires assignee_type and assignee_id. Currently only staff_member is supported. Replaces the current assignees.
- itemsobject
  - assignee_idstring · uuidrequired
    The identifier of the assignee. For staff_member, use an identifier from GET /v1/staff_members.
  - assignee_typestringrequired
    The type of assignee. Currently only staff_member is supported.
    Allowed values: staff_member
completed_atstring | null · date-time
Set an ISO 8601 timestamp to complete the HumanTask. Set it to null to reopen the HumanTask.
contentstring
The description of the work to complete.
document_idstring | null · uuid
The optional Document associated with the HumanTask, for example a Letter, TestResult, Photo, or BookingForm. Set it to null to clear it.
due_datestring · date
The date by which staff should complete the HumanTask.
is_remindableboolean
Whether Carebit can send reminders when the HumanTask becomes due.
is_urgentboolean
Whether the HumanTask should be marked as urgent.
patient_idstring | null · uuid
The optional Patient associated with the HumanTask. Set it to null to clear it.

Responses

200

The requested HumanTask.

assigneesarrayrequired
The people assigned to the HumanTask. Currently only staff_member is supported.
- itemsobject
  - assignee_idstring · uuidrequired
    The identifier of the assignee. For staff_member, use an identifier from GET /v1/staff_members.
  - assignee_typestringrequired
    The type of assignee. Currently only staff_member is supported.
    Allowed values: staff_member
commentsarrayrequired
Comments on the HumanTask, oldest first. Discarded Comments are omitted.
- itemsobject
  - contentstringrequired
    The sanitized comment text.
  - created_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
  - created_by_staff_member_idstring | null · uuidrequired
    The StaffMember who wrote the Comment in Carebit. Null when the Comment was created through the API.
  - human_task_idstring · uuidrequired
    The HumanTask this Comment belongs to.
  - idstring · uuidrequired
    The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
  - linksobjectrequired
    URLs to related resources.
    - created_by_staff_memberstring | null · urirequired
      The full URL of a related resource.
    - human_taskstring · urirequired
      The full URL of a related resource.
  - objectanyrequired
    Discriminator value emitted at object.
  - updated_atstring · date-timerequired
    An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
completed_atstring | null · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
completed_by_staff_member_idstring | null · uuidrequired
The StaffMember who completed the HumanTask in Carebit. Null when the HumanTask is open, or when it was completed through the API without a StaffMember.
contentstringrequired
The sanitized description of the work to complete.
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
creation_sourcestring | nullrequired
How the HumanTask was created. api means the record was created through the Developer Platform API. Read-only.
Allowed values: api | app | automation | import | staff_member | null
document_idstring | null · uuidrequired
The Document associated with the HumanTask, when the HumanTask belongs to a Letter, TestResult, Photo, or BookingForm.
due_datestring · daterequired
The date by which staff should complete the HumanTask.
idstring · uuidrequired
The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
is_remindablebooleanrequired
Whether Carebit can send reminders when the HumanTask becomes due.
is_urgentbooleanrequired
Whether the HumanTask is marked as urgent.
linksobjectrequired
URLs to related resources.
- completed_by_staff_memberstring | null · urirequired
  The full URL of a related resource.
- documentstring | null · urirequired
  The full URL of a related resource.
- patientstring | null · urirequired
  The full URL of a related resource.
objectanyrequired
Discriminator value emitted at object.
patient_idstring | null · uuidrequired
The Patient associated with the HumanTask.
updated_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.

Example

{
  "id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
  "object": "human_task",
  "assignees":  … ]
     … }
      "assignee_id": "00000000-0000-4000-8000-000000000021",
      "assignee_type": "staff_member"
    }
  ],
  "comments":  … ]
     … }
      "id": "e7bcd0e1-df8c-456f-8242-ef51dac3b061",
      "object": "comment",
      "content": "Moved this to the secretary after the Patient called.",
      "created_at": "2026-01-01T09:00:00Z",
      "created_by_staff_member_id": "820b1195-41c0-476a-8add-3f2e706e2c01",
      "human_task_id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
      "links":  … }
        "created_by_staff_member": "https://api.carebit.co/v1/created_by_staff_members/820b1195-41c0-476a-8add-3f2e706e2c01",
        "human_task": "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496"
      },
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "completed_at": "2026-01-01T09:00:00Z",
  "completed_by_staff_member_id": "d5988084-3224-4174-8e46-83702cadb572",
  "content": "Review the Patient's completed consent form.",
  "created_at": "2026-01-01T09:00:00Z",
  "creation_source": "api",
  "document_id": "78aa99b3-1b45-47c3-8608-ece2f58b39ee",
  "due_date": "2026-01-01",
  "is_remindable": true,
  "is_urgent": true,
  "links":  … }
    "completed_by_staff_member": "https://api.carebit.co/v1/completed_by_staff_members/d5988084-3224-4174-8e46-83702cadb572",
    "document": "https://api.carebit.co/v1/documents/78aa99b3-1b45-47c3-8608-ece2f58b39ee",
    "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
  },
  "patient_id": "00000000-0000-4000-8000-000000000004",
  "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 PATCH "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "completed_at": "2026-01-04T10:00:00Z"
}'

200 response

{
  "id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
  "object": "human_task",
  "assignees":  … ]
     … }
      "assignee_id": "00000000-0000-4000-8000-000000000021",
      "assignee_type": "staff_member"
    }
  ],
  "comments":  … ]
     … }
      "id": "e7bcd0e1-df8c-456f-8242-ef51dac3b061",
      "object": "comment",
      "content": "Moved this to the secretary after the Patient called.",
      "created_at": "2026-01-01T09:00:00Z",
      "created_by_staff_member_id": "820b1195-41c0-476a-8add-3f2e706e2c01",
      "human_task_id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
      "links":  … }
        "created_by_staff_member": "https://api.carebit.co/v1/created_by_staff_members/820b1195-41c0-476a-8add-3f2e706e2c01",
        "human_task": "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496"
      },
      "updated_at": "2026-01-01T09:00:00Z"
    }
  ],
  "completed_at": "2026-01-01T09:00:00Z",
  "completed_by_staff_member_id": "d5988084-3224-4174-8e46-83702cadb572",
  "content": "Review the Patient's completed consent form.",
  "created_at": "2026-01-01T09:00:00Z",
  "creation_source": "api",
  "document_id": "78aa99b3-1b45-47c3-8608-ece2f58b39ee",
  "due_date": "2026-01-01",
  "is_remindable": true,
  "is_urgent": true,
  "links":  … }
    "completed_by_staff_member": "https://api.carebit.co/v1/completed_by_staff_members/d5988084-3224-4174-8e46-83702cadb572",
    "document": "https://api.carebit.co/v1/documents/78aa99b3-1b45-47c3-8608-ece2f58b39ee",
    "patient": "https://api.carebit.co/v1/patients/00000000-0000-4000-8000-000000000004"
  },
  "patient_id": "00000000-0000-4000-8000-000000000004",
  "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"
  }
}

post/v1/human_tasks/:id/comments

Add a Comment to a HumanTask

Adds a Comment to a HumanTask in the Organization's staff task queue. Use this with PATCH /v1/human_tasks/{id} to comment, complete, or reassign a HumanTask.

Required API scopes: human_tasks.update

Parameters

id
path · required
string
-
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

contentstringrequired
The comment text to add to the HumanTask.

Responses

201

The requested Comment.

contentstringrequired
The sanitized comment text.
created_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.
created_by_staff_member_idstring | null · uuidrequired
The StaffMember who wrote the Comment in Carebit. Null when the Comment was created through the API.
human_task_idstring · uuidrequired
The HumanTask this Comment belongs to.
idstring · uuidrequired
The resource's unique identifier, formatted as an RFC 4122 version 4 UUID.
linksobjectrequired
URLs to related resources.
- created_by_staff_memberstring | null · urirequired
  The full URL of a related resource.
- human_taskstring · urirequired
  The full URL of a related resource.
objectanyrequired
Discriminator value emitted at object.
updated_atstring · date-timerequired
An ISO 8601 timestamp in UTC, with a Z suffix. For example, 2026-07-01T09:00:00Z.

Example

{
  "id": "e7bcd0e1-df8c-456f-8242-ef51dac3b061",
  "object": "comment",
  "content": "Moved this to the secretary after the Patient called.",
  "created_at": "2026-01-01T09:00:00Z",
  "created_by_staff_member_id": "820b1195-41c0-476a-8add-3f2e706e2c01",
  "human_task_id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
  "links":  … }
    "created_by_staff_member": "https://api.carebit.co/v1/created_by_staff_members/820b1195-41c0-476a-8add-3f2e706e2c01",
    "human_task": "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496"
  },
  "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/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496/comments" \
  -H "Authorization: Bearer $CAREBIT_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "Moved this to the secretary after the Patient called."
}'

201 response

{
  "id": "e7bcd0e1-df8c-456f-8242-ef51dac3b061",
  "object": "comment",
  "content": "Moved this to the secretary after the Patient called.",
  "created_at": "2026-01-01T09:00:00Z",
  "created_by_staff_member_id": "820b1195-41c0-476a-8add-3f2e706e2c01",
  "human_task_id": "8408d9e2-6643-4aee-8ebd-8edf57ead496",
  "links":  … }
    "created_by_staff_member": "https://api.carebit.co/v1/created_by_staff_members/820b1195-41c0-476a-8add-3f2e706e2c01",
    "human_task": "https://api.carebit.co/v1/human_tasks/8408d9e2-6643-4aee-8ebd-8edf57ead496"
  },
  "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"
  }
}

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