Skip to main content

Tasks

A task is an action item, often derived from a meeting. These endpoints list, search, create, update, complete and delete tasks.

Every endpoint below shows its parameters and response fields in the middle and a request sample with an example response on the right.

Base URL https://api.sally.ioVersion v1.0 current, not frozen yetHow versioning works

Lists the tasks of a directory (paginated, optionally filtered)​

GET/v1.0/directories/{directoryId}/tasks

The ?filter selects a task view (default myTasks); the all* variants are admin/owner only. An optional ?search substring matches the task subject. Pagination via ?page + ?pageSize (max. 100). Resolve responsibleUserId/ownerId via GET /v1.0/directories/{directoryId}/memberships/users/{userId}.

Field overview from the specification

Response fields:

  • page / pageSize / total / hasMore: pagination envelope (current page, page size, total count, whether more pages follow).
  • items (array): the tasks on this page. Each item has:
    • taskId (string): id of the task.
    • subject (string): task subject.
    • description (string | null): task description; null if unset.
    • ownerId (string): id of the user who owns (created) the task.
    • responsibleUserId (string | null): id of the user responsible for the task; null if unassigned.
    • dueDate (string | null): due date (ISO 8601); null if no due date is set.
    • isDone (boolean): whether the task is marked as done.
    • doneOn (string | null): timestamp when the task was completed (ISO 8601); null if not done.
    • isCanceled (boolean): whether the task is canceled.
    • canceledOn (string | null): timestamp when the task was canceled (ISO 8601); null if not canceled.
    • recordingSummaryId (string | null): id of the recording summary this task originated from; null if none.
    • appointmentId (string | null): id of the appointment this task is linked to; null if none.
    • createdOn (string): creation timestamp (ISO 8601).
    • modifiedOn (string): last modification timestamp (ISO 8601).

Path parameters

  • directoryIdstringrequired

    Id of the directory (the Sally company account) the resource belongs to. The directories a token can address are listed by GET /v1.0/me/directories/memberships.

Query parameters

  • filterstringoptional

    Named preset that combines scope and state. my… covers the tasks of the calling user, all… every task of the directory the caller may see. The state part is Tasks (any), Open, Overdue, Completed or Forwarded. Omitted means no preset filter.

    Allowed values: myTasksmyOpenmyOverduemyCompletedmyForwardedallTasksallOpenallOverdueallCompletedallForwarded
  • searchstringoptional

    Case-insensitive substring match on the task subject. The term may appear at the start, middle, or end.

  • pagenumberoptional

    Page number, 1-based. Defaults to 1.

  • pageSizenumberoptional

    Items per page. Defaults to 25, capped at 100.

  • fieldsstringoptional

    Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.

    Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.

    On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.

    Selectable here: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskId.

    Example: appointmentId,canceledOn

Response: each entry in items

  • taskIdstringrequired

    Id of the task.

  • subjectstringrequired

    Task subject.

  • descriptionstringrequirednullable

    Task description; null if unset.

  • ownerIdstringrequired

    Id of the user who owns (created) the task.

  • responsibleUserIdstringrequirednullable

    Id of the user responsible for the task; null if unassigned.

  • dueDatestringrequirednullable

    Due date (ISO 8601); null if no due date is set.

  • isDonebooleanrequired

    Whether the task is marked as done.

  • doneOnstringrequirednullable

    Timestamp when the task was completed (ISO 8601); null if not done.

  • isCanceledbooleanrequired

    Whether the task is canceled.

  • canceledOnstringrequirednullable

    Timestamp when the task was canceled (ISO 8601); null if not canceled.

  • recordingSummaryIdstringrequirednullable

    Id of the recording summary this task originated from; null if none.

  • appointmentIdstringrequirednullable

    Id of the appointment this task is linked to; null if none.

  • createdOnstringrequired

    Creation timestamp (ISO 8601).

  • modifiedOnstringrequired

    Last modification timestamp (ISO 8601).

Every page also carries page, pageSize, total, hasMore.

Status codes

  • 200Success
  • 400

    Invalid request (validation error).

  • 401

    Missing or invalid bearer token.

  • 404

    Resource not found or not accessible.

  • 429

    Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.

  • 500

    Internal server error.

Creates a task​

POST/v1.0/directories/{directoryId}/tasks

Creates a task. The caller becomes the owner.

Field overview from the specification

Body fields:

  • subject (string, required): task subject (1..1000 characters).
  • description (string, optional): task description (max. 4000 characters); null for none.
  • responsibleUserId (string, optional): id of the responsible user; null or omitted leaves the task unassigned.
  • dueDate (string, optional): due date as an ISO 8601 string; null for no due date.

Path parameters

  • directoryIdstringrequired

    Id of the directory (the Sally company account) the resource belongs to. The directories a token can address are listed by GET /v1.0/me/directories/memberships.

Query parameters

  • fieldsstringoptional

    Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.

    Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.

    On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.

    Selectable here: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskId.

    Example: appointmentId,canceledOn

Request body application/json

  • subjectstringrequired

    Task subject (1..1000 characters).

  • descriptionstringoptionalnullable

    Task description (max. 4000 characters); null for none.

  • responsibleUserIdstringoptionalnullable

    Id of the responsible user; null for unassigned.

  • dueDatestringoptionalnullable

    Due date as an ISO 8601 string; null for no due date.

Response

  • taskIdstringrequired

    Id of the task.

  • subjectstringrequired

    Task subject.

  • descriptionstringrequirednullable

    Task description; null if unset.

  • ownerIdstringrequired

    Id of the user who owns (created) the task.

  • responsibleUserIdstringrequirednullable

    Id of the user responsible for the task; null if unassigned.

  • dueDatestringrequirednullable

    Due date (ISO 8601); null if no due date is set.

  • isDonebooleanrequired

    Whether the task is marked as done.

  • doneOnstringrequirednullable

    Timestamp when the task was completed (ISO 8601); null if not done.

  • isCanceledbooleanrequired

    Whether the task is canceled.

  • canceledOnstringrequirednullable

    Timestamp when the task was canceled (ISO 8601); null if not canceled.

  • recordingSummaryIdstringrequirednullable

    Id of the recording summary this task originated from; null if none.

  • appointmentIdstringrequirednullable

    Id of the appointment this task is linked to; null if none.

  • createdOnstringrequired

    Creation timestamp (ISO 8601).

  • modifiedOnstringrequired

    Last modification timestamp (ISO 8601).

Status codes

  • 200Success
  • 400

    Invalid request (validation error).

  • 401

    Missing or invalid bearer token.

  • 403

    Forbidden (insufficient permissions).

  • 404

    Resource not found or not accessible.

  • 429

    Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.

  • 500

    Internal server error.

POST/v1.0/directories/{directoryId}/tasks/search

Searches tasks.

Field overview from the specification

Body fields:

  • search (string, optional): case-insensitive substring over the task subject AND description.
  • responsible (string, optional): filter by responsible user id — your own is always allowed, another user or omitting it (= all responsibles) requires admin/owner.
  • status (string, optional): one of open (not done/canceled), completed, overdue (open + past due), canceled; omit for any status.
  • page (number, optional, default 1): 1-based page number.
  • pageSize (number, optional, default 25): page size (max. 100).

Results are sorted by due date ascending.

Path parameters

  • directoryIdstringrequired

    Id of the directory (the Sally company account) the resource belongs to. The directories a token can address are listed by GET /v1.0/me/directories/memberships.

Query parameters

  • fieldsstringoptional

    Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.

    Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.

    On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.

    Selectable here: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskId.

    Example: appointmentId,canceledOn

Request body application/json

  • searchstringoptionalnullable

    Case-insensitive substring match on the task subject AND description. The term may appear at the start, middle, or end.

  • responsiblestringoptionalnullable

    Filter by responsible user id. Your own id is always allowed; another user or omitting it (= all responsibles) requires admin/owner.

  • statusstringoptionalnullable

    Filter by status: open (not done/canceled), completed, overdue (open + past due), canceled. Omit for any status.

    Allowed values: opencompletedoverduecanceled
  • pagenumberoptional

    Page (1-based, default 1).

  • pageSizenumberoptional

    Page size (default 25, max 100).

Response: each entry in items

  • taskIdstringrequired

    Id of the task.

  • subjectstringrequired

    Task subject.

  • descriptionstringrequirednullable

    Task description; null if unset.

  • ownerIdstringrequired

    Id of the user who owns (created) the task.

  • responsibleUserIdstringrequirednullable

    Id of the user responsible for the task; null if unassigned.

  • dueDatestringrequirednullable

    Due date (ISO 8601); null if no due date is set.

  • isDonebooleanrequired

    Whether the task is marked as done.

  • doneOnstringrequirednullable

    Timestamp when the task was completed (ISO 8601); null if not done.

  • isCanceledbooleanrequired

    Whether the task is canceled.

  • canceledOnstringrequirednullable

    Timestamp when the task was canceled (ISO 8601); null if not canceled.

  • recordingSummaryIdstringrequirednullable

    Id of the recording summary this task originated from; null if none.

  • appointmentIdstringrequirednullable

    Id of the appointment this task is linked to; null if none.

  • createdOnstringrequired

    Creation timestamp (ISO 8601).

  • modifiedOnstringrequired

    Last modification timestamp (ISO 8601).

Every page also carries page, pageSize, total, hasMore.

Status codes

  • 200Success
  • 400

    Invalid request (validation error).

  • 401

    Missing or invalid bearer token.

  • 403

    Forbidden (insufficient permissions).

  • 404

    Resource not found or not accessible.

  • 429

    Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.

  • 500

    Internal server error.

Returns a single task by id​

GET/v1.0/directories/{directoryId}/tasks/{taskId}

The caller must be allowed to view the task (owner, responsible, or admin/owner).

Field overview from the specification

Response fields:

  • taskId (string): id of the task.
  • subject (string): task subject.
  • description (string | null): task description; null if unset.
  • ownerId (string): id of the user who owns (created) the task.
  • responsibleUserId (string | null): id of the user responsible for the task; null if unassigned.
  • dueDate (string | null): due date (ISO 8601); null if no due date is set.
  • isDone (boolean): whether the task is marked as done.
  • doneOn (string | null): timestamp when the task was completed (ISO 8601); null if not done.
  • isCanceled (boolean): whether the task is canceled.
  • canceledOn (string | null): timestamp when the task was canceled (ISO 8601); null if not canceled.
  • recordingSummaryId (string | null): id of the recording summary this task originated from; null if none.
  • appointmentId (string | null): id of the appointment this task is linked to; null if none.
  • createdOn (string): creation timestamp (ISO 8601).
  • modifiedOn (string): last modification timestamp (ISO 8601).

Path parameters

  • directoryIdstringrequired

    Id of the directory (the Sally company account) the resource belongs to. The directories a token can address are listed by GET /v1.0/me/directories/memberships.

  • taskIdstringrequired

    Id of the task.

Query parameters

  • fieldsstringoptional

    Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.

    Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.

    On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.

    Selectable here: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskId.

    Example: appointmentId,canceledOn

Response

  • taskIdstringrequired

    Id of the task.

  • subjectstringrequired

    Task subject.

  • descriptionstringrequirednullable

    Task description; null if unset.

  • ownerIdstringrequired

    Id of the user who owns (created) the task.

  • responsibleUserIdstringrequirednullable

    Id of the user responsible for the task; null if unassigned.

  • dueDatestringrequirednullable

    Due date (ISO 8601); null if no due date is set.

  • isDonebooleanrequired

    Whether the task is marked as done.

  • doneOnstringrequirednullable

    Timestamp when the task was completed (ISO 8601); null if not done.

  • isCanceledbooleanrequired

    Whether the task is canceled.

  • canceledOnstringrequirednullable

    Timestamp when the task was canceled (ISO 8601); null if not canceled.

  • recordingSummaryIdstringrequirednullable

    Id of the recording summary this task originated from; null if none.

  • appointmentIdstringrequirednullable

    Id of the appointment this task is linked to; null if none.

  • createdOnstringrequired

    Creation timestamp (ISO 8601).

  • modifiedOnstringrequired

    Last modification timestamp (ISO 8601).

Status codes

  • 200Success
  • 400

    Invalid request (validation error).

  • 401

    Missing or invalid bearer token.

  • 404

    Resource not found or not accessible.

  • 429

    Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.

  • 500

    Internal server error.

Updates a task (partial update)​

PATCH/v1.0/directories/{directoryId}/tasks/{taskId}

Updates a task. Only the provided fields are changed; omitted fields keep their current value, a null value explicitly clears a field. The caller must be allowed to edit the task.

Field overview from the specification

Body fields:

  • subject (string, optional): new task subject (1..1000 characters).
  • description (string, optional): new task description (max. 4000 characters); null to clear.
  • responsibleUserId (string, optional): new id of the responsible user; null to unassign.
  • dueDate (string, optional): new due date as an ISO 8601 string; null to clear.

Path parameters

  • directoryIdstringrequired

    Id of the directory (the Sally company account) the resource belongs to. The directories a token can address are listed by GET /v1.0/me/directories/memberships.

  • taskIdstringrequired

    Id of the task.

Query parameters

  • fieldsstringoptional

    Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.

    Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.

    On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.

    Selectable here: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskId.

    Example: appointmentId,canceledOn

Request body application/json

  • subjectstringoptional

    New task subject (1..1000 characters).

  • descriptionstringoptionalnullable

    New task description (max. 4000 characters); null to clear.

  • responsibleUserIdstringoptionalnullable

    New id of the responsible user; null to unassign.

  • dueDatestringoptionalnullable

    New due date as an ISO 8601 string; null to clear.

Response

  • taskIdstringrequired

    Id of the task.

  • subjectstringrequired

    Task subject.

  • descriptionstringrequirednullable

    Task description; null if unset.

  • ownerIdstringrequired

    Id of the user who owns (created) the task.

  • responsibleUserIdstringrequirednullable

    Id of the user responsible for the task; null if unassigned.

  • dueDatestringrequirednullable

    Due date (ISO 8601); null if no due date is set.

  • isDonebooleanrequired

    Whether the task is marked as done.

  • doneOnstringrequirednullable

    Timestamp when the task was completed (ISO 8601); null if not done.

  • isCanceledbooleanrequired

    Whether the task is canceled.

  • canceledOnstringrequirednullable

    Timestamp when the task was canceled (ISO 8601); null if not canceled.

  • recordingSummaryIdstringrequirednullable

    Id of the recording summary this task originated from; null if none.

  • appointmentIdstringrequirednullable

    Id of the appointment this task is linked to; null if none.

  • createdOnstringrequired

    Creation timestamp (ISO 8601).

  • modifiedOnstringrequired

    Last modification timestamp (ISO 8601).

Status codes

  • 200Success
  • 400

    Invalid request (validation error).

  • 401

    Missing or invalid bearer token.

  • 403

    Forbidden (insufficient permissions).

  • 404

    Resource not found or not accessible.

  • 429

    Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.

  • 500

    Internal server error.

Deletes a task (soft-delete)​

DELETE/v1.0/directories/{directoryId}/tasks/{taskId}

Only the owner or an admin/owner may delete a task.

Path parameters

  • directoryIdstringrequired

    Id of the directory (the Sally company account) the resource belongs to. The directories a token can address are listed by GET /v1.0/me/directories/memberships.

  • taskIdstringrequired

    Id of the task.

Status codes

  • 204Success
  • 400

    Invalid request (validation error).

  • 401

    Missing or invalid bearer token.

  • 403

    Forbidden (insufficient permissions).

  • 404

    Resource not found or not accessible.

  • 429

    Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.

  • 500

    Internal server error.

Toggles the done status of a task​

POST/v1.0/directories/{directoryId}/tasks/{taskId}/done

Toggles the done status of a task.

Field overview from the specification

Body fields:

  • isDone (boolean, required): true to mark the task as done, false to reopen it.

Path parameters

  • directoryIdstringrequired

    Id of the directory (the Sally company account) the resource belongs to. The directories a token can address are listed by GET /v1.0/me/directories/memberships.

  • taskIdstringrequired

    Id of the task.

Query parameters

  • fieldsstringoptional

    Comma-separated list of the fields to return. Leave it out and you get every field — including fields added in the future, which is your call to make: name your fields if you want to be shielded from that.

    Only first-level fields can be named. A nested list such as attendees, tags or sectionItems is returned whole or not at all; attendees.name is not supported.

    On a paged response the selection applies to the entries in items; page, pageSize, total and hasMore are always returned. An unknown name is rejected with 400 rather than ignored.

    Selectable here: appointmentId, canceledOn, createdOn, description, doneOn, dueDate, isCanceled, isDone, modifiedOn, ownerId, recordingSummaryId, responsibleUserId, subject, taskId.

    Example: appointmentId,canceledOn

Request body application/json

  • isDonebooleanrequired

    True to mark the task as done, false to reopen it.

Response

  • taskIdstringrequired

    Id of the task.

  • subjectstringrequired

    Task subject.

  • descriptionstringrequirednullable

    Task description; null if unset.

  • ownerIdstringrequired

    Id of the user who owns (created) the task.

  • responsibleUserIdstringrequirednullable

    Id of the user responsible for the task; null if unassigned.

  • dueDatestringrequirednullable

    Due date (ISO 8601); null if no due date is set.

  • isDonebooleanrequired

    Whether the task is marked as done.

  • doneOnstringrequirednullable

    Timestamp when the task was completed (ISO 8601); null if not done.

  • isCanceledbooleanrequired

    Whether the task is canceled.

  • canceledOnstringrequirednullable

    Timestamp when the task was canceled (ISO 8601); null if not canceled.

  • recordingSummaryIdstringrequirednullable

    Id of the recording summary this task originated from; null if none.

  • appointmentIdstringrequirednullable

    Id of the appointment this task is linked to; null if none.

  • createdOnstringrequired

    Creation timestamp (ISO 8601).

  • modifiedOnstringrequired

    Last modification timestamp (ISO 8601).

Status codes

  • 200Success
  • 400

    Invalid request (validation error).

  • 401

    Missing or invalid bearer token.

  • 403

    Forbidden (insufficient permissions).

  • 404

    Resource not found or not accessible.

  • 429

    Rate limit exceeded (per token/IP). Transcription uploads may also return code FUP_LIMIT_EXCEEDED or TOO_MANY_CONCURRENT_TRANSCRIPTIONS.

  • 500

    Internal server error.