Skip to content
Developers

Endpoints

Reminders

Team reminders on contacts, conversations and bookings. The workspace owner sees every reminder; anyone else sees the reminders they created or are assigned to.

Paths are relative to the base URL. Each card lists the permission the call needs and every parameter, with its type and limits.

GET
/reminders

List reminders, newest first.

Any team member
Paginated

Query parameters

  • statusoptionalenum

    Reminder state.

    Allowed values:opensnoozedclosed

  • assigned_tooptionalstring

    Reminders assigned to this user.

  • entity_typeoptionalenum

    What the reminder is about.

    Allowed values:contactconversationappointmentbooking

  • entity_idoptionalinteger

    ID of that record. Needs entity_type.

  • due_beforeoptionalstring (ISO 8601 date-time with offset)

    Due at or before this time.

  • due_afteroptionalstring (ISO 8601 date-time with offset)

    Due at or after this time.

GET
/reminders/:id

Retrieve a reminder.

Any team member

Path parameters

  • idrequiredinteger

    Reminder ID.

POST
/reminders

Create a reminder.

Any team member

JSON body

  • titlerequiredstring

    1–200 characters, single line.

  • due_atrequiredstring (ISO 8601 date-time with offset)

    When the reminder is due.

  • entity_typerequiredenum

    What the reminder is about.

    Allowed values:contactconversationappointmentbooking

  • entity_idrequiredinteger

    ID of that record.

  • noteoptionalstring

    Up to 4,700 characters.

  • assigned_user_idsoptionalarray of strings

    1–50 user IDs from GET /users.

PATCH
/reminders/:id

Update a reminder. Send at least one field.

Any team member

Path parameters

  • idrequiredinteger

    Reminder ID.

JSON body

  • titleoptionalstring

    1–200 characters, single line.

  • noteoptionalstring | null

    Up to 4,700 characters.

  • due_atoptionalstring (ISO 8601 date-time with offset)

    New due time.

  • assigned_user_idsoptionalarray of strings

    1–50 user IDs.

POST
/reminders/:id/snooze

Move a reminder to later. Send exactly one of until or preset.

Any team member

Path parameters

  • idrequiredinteger

    Reminder ID.

JSON body

  • untiloptionalstring (ISO 8601 date-time with offset)

    New due time.

  • presetoptionalenum

    A quick snooze.

    Allowed values:1h3htomorrow_92d1w

POST
/reminders/:id/close

Mark a reminder done.

Any team member

Path parameters

  • idrequiredinteger

    Reminder ID.

POST
/reminders/:id/assign

Replace the people assigned to a reminder.

Any team member

Path parameters

  • idrequiredinteger

    Reminder ID.

JSON body

  • user_idsrequiredarray of strings

    1–50 user IDs.

DELETE
/reminders/:id

Delete a reminder. Only its creator or the workspace owner can.

Any team member

Path parameters

  • idrequiredinteger

    Reminder ID.