Check-in request
One scheduled or manually triggered occurrence of a CheckIn. Each request fans out to its assignees so they can submit a FormResponse against the parent check-in form. Belongs to a CheckIn (which belongs to a Team). Assignees and respondedBy are managed one at a time through their sub-resource routes.
List Check-in requests
List checkInRequests. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by -createdAt unless you pass sort.
Required scope: check-in-requests:read
query Parameters
sortField to sort by. Prefix with - for descending (-createdAt); a createdAt:desc / createdAt:asc suffix works too, but never both markers at once. Default: -createdAt.
cursorOpaque cursor for the next page (the envelope nextCursor).
limitItems per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow nextCursor instead of assuming one page held everything.
includeTotalWhen true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
checkInId[eq]Filter where checkInId equals.
checkInId[in]Filter where checkInId is one of (comma-separated list).
createdAt[gt]Filter where createdAt is greater than.
createdAt[gte]Filter where createdAt is greater than or equal to.
createdAt[lt]Filter where createdAt is less than.
createdAt[lte]Filter where createdAt is less than or equal to.
updatedAt[gt]Filter where updatedAt is greater than.
updatedAt[gte]Filter where updatedAt is greater than or equal to.
updatedAt[lt]Filter where updatedAt is less than.
updatedAt[lte]Filter where updatedAt is less than or equal to.
reminderSentAt[gt]Filter where reminderSentAt is greater than.
reminderSentAt[gte]Filter where reminderSentAt is greater than or equal to.
reminderSentAt[lt]Filter where reminderSentAt is less than.
reminderSentAt[lte]Filter where reminderSentAt is less than or equal to.
List Check-in requests › Responses
OK
The page of results.
totalTotal rows matching the query (across pages).
limithasMorenextCursorOpaque cursor for the next page; null on the last page.
Create Check-in request
Create a Check-in request. Server-assigned fields are ignored if sent.
Required scope: check-in-requests:write
query Parameters
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
Headers
Idempotency-KeyOptional replay key (see Idempotent requests above).
Create Check-in request › Request Body
checkInIdThe check-in this request belongs to. Required when creating one, and immutable afterwards — the parent check-in decides both the workspace it lives in and the form that is answered.
assigneesTeam members asked to respond to this request. Copied from the parent check-in when the request is created; send an assignees array on the create body to override that. Add or remove members afterwards with POST/DELETE /check-in-requests/:id/assignees, and use ?expand=assignees to read them.
Create Check-in request › Responses
Created
idUnique identifier for this resource.
createdAtCreation timestamp.
checkInIdThe check-in this request belongs to. Required when creating one, and immutable afterwards — the parent check-in decides both the workspace it lives in and the form that is answered.
updatedAtLast update timestamp.
reminderSentAtWhen the most recent reminder for this request was sent, or null if no reminder has been sent yet. Server-managed (reminders are rate-limited to one every 8 hours) and read-only.
Team members asked to respond to this request. Copied from the parent check-in when the request is created; send an assignees array on the create body to override that. Add or remove members afterwards with POST/DELETE /check-in-requests/:id/assignees, and use ?expand=assignees to read them.
Team members who have submitted an answer to this request. Maintained by the submission flow and read-only — a request is complete once this covers every entry in assignees. Use ?expand=respondedBy to read it.
The related Check-in, present only when you pass ?expand=checkIn.
Get Check-in request
Retrieve a single Check-in request by id.
Required scope: check-in-requests:read
path Parameters
id^[0-9A-Za-z_!]+$ · requiredId of the Check-in request.
query Parameters
expandComma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.
Get Check-in request › Responses
OK
idUnique identifier for this resource.
createdAtCreation timestamp.
checkInIdThe check-in this request belongs to. Required when creating one, and immutable afterwards — the parent check-in decides both the workspace it lives in and the form that is answered.
updatedAtLast update timestamp.
reminderSentAtWhen the most recent reminder for this request was sent, or null if no reminder has been sent yet. Server-managed (reminders are rate-limited to one every 8 hours) and read-only.
Team members asked to respond to this request. Copied from the parent check-in when the request is created; send an assignees array on the create body to override that. Add or remove members afterwards with POST/DELETE /check-in-requests/:id/assignees, and use ?expand=assignees to read them.
Team members who have submitted an answer to this request. Maintained by the submission flow and read-only — a request is complete once this covers every entry in assignees. Use ?expand=respondedBy to read it.
The related Check-in, present only when you pass ?expand=checkIn.
Delete Check-in request
Permanently delete this Check-in request. This cannot be undone.
Required scope: check-in-requests:delete
path Parameters
id^[0-9A-Za-z_!]+$ · requiredId of the Check-in request.
Headers
Idempotency-KeyOptional replay key (see Idempotent requests above).
Delete Check-in request › Responses
No Content
Add assignees to a Check-in request
Link the given ids to this Check-in request as assignees. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete assignees set afterwards.
Required scopes: check-in-requests:write check-in-requests:link
path Parameters
id^[0-9A-Za-z_!]+$ · requiredId of the Check-in request.
Headers
Idempotency-KeyOptional replay key (see Idempotent requests above).
Add assignees to a Check-in request › Request Body
idsTeam Members to add or remove, by id.
Add assignees to a Check-in request › Responses
OK
The complete assignees set after the change.
affectedIdsThe ids that were actually linked (ones already linked are omitted).
missingIdsIds you sent that do not exist or are not visible to this token.
Remove assignees from a Check-in request
Unlink the given ids from this Check-in request's assignees. Removing one that is not linked changes nothing. Returns the complete assignees set afterwards.
Required scopes: check-in-requests:write check-in-requests:link
path Parameters
id^[0-9A-Za-z_!]+$ · requiredId of the Check-in request.
Headers
Idempotency-KeyOptional replay key (see Idempotent requests above).
Remove assignees from a Check-in request › Request Body
idsTeam Members to add or remove, by id.
Remove assignees from a Check-in request › Responses
OK
The complete assignees set after the change.
affectedIdsThe ids that were actually unlinked (ones not linked are omitted).