--- title: "Tasks.list" method: GET path: "/entities/Tasks" tags: ["Activity"] --- # Tasks.list `GET /entities/Tasks` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Tasks` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a page of Task records, optionally filtered, sorted and limited to selected fields. ## Query parameters - `include-deleted` boolean - `first` integer - `last` integer - `before` string - `after` string - `expand` string - `order-by` string - `filter` object - `filter-op` object - `load-only` string ## Response `200` Page of Task records. - object - `success` boolean: True when the request succeeded; false on error. - `data` Task[] - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `id` string, uuid, required: Unique identifier of entity. - `active_reminder` string, date-time: Timestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). Empty when no reminder is pending. - `media_transcription_id` string, uuid: Id of the linked Media record holding the activity's call recording / transcription, when available. - `is_deleted` boolean: Specifies if the entity is considered deleted. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `activity_type` string, uri, required: Task type that classifies this task (e.g. Task, Call, Email). Drives form layout and icon. Related TaskType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'TaskType' for its fields. - `call` string, uri: Call record associated with this task when the task represents a phone call. Related Call record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Call' for its fields. - `call_outcome` string, uri: Configurable outcome of the call (e.g. Reached, Voicemail, No Answer). Related Data record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Data' for its fields. - `currency_exchange_rates_list` string, uri: Currency exchange rate list used to convert monetary fields linked to this task. Empty to inherit the team space default. Related CurrencyExchangeRatesList record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CurrencyExchangeRatesList' for its fields. - `owner` string, uri: Sales user who owns this task. May be empty when the task is unassigned and available for take-over. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields. - `unit` string, uri, required: Sales unit this task is assigned to. Determines which team members can see the record under unit-based sharing. Related SalesUnit record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'SalesUnit' for its fields. - `activity_type_id` string, uuid: Id of the task type. - `call_duration` integer: Duration of the recorded call. Set automatically when the task is linked to a call log. - `call_id` string, uuid: Id of the linked call record. - `call_outcome_id` string, uuid: Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer). - `currency_exchange_rates_list_id` string, uuid: Id of the currency exchange rate list applied to this task. - `description` string: Free-form description of what the task entails. - `due_date` string, date: Date by which the task is expected to be completed. - `duration` number, double: Estimated duration of the task. Stored as a duration value (days/hours/minutes). - `owner_id` string, uuid: Id of the task owner. - `priority` 1 | 2 | 3: Priority level of the task: Low, Medium or High. Integer enum value: 1 - Low, 2 - Medium, 3 - High - `share_mode` 0 | 1 | 2 | 3: Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit - `start_date` string, date: Date when work on the task is scheduled to begin. - `status` 1 | 2 | 3 | 4 | 5: Current status of the task (NotStarted, InProgress, Waiting, Completed, Deferred). Toggling to Completed marks any linked checklist items as done. Integer enum value: 1 - NotStarted, 2 - InProgress, 3 - Waiting, 4 - Completed, 5 - Deferred - `subject` string, required: Short summary line shown in lists and notifications. - `table_name` string, required: Discriminator identifying the concrete record type — always "task" for Task records. Read-only; useful when consuming polymorphic Activity results. - `unit_id` string, uuid: Id of the sales unit. - `revision` integer: Revision when entity was lastly changed. - `sharing_units` string[]: Sales units that have been granted shared access to this task. Editable only when share_mode allows unit sharing. - `sharing_clients` string[]: Users that have been granted shared access to this task. Editable only when share_mode allows user sharing. - `account_relations` string[]: Accounts this task is linked to. - `contact_relations` string[]: Contacts this task is linked to. - `lead_relations` string[]: Leads this task is linked to. - `opportunity_relations` string[]: Opportunities this task is linked to. - `project_relations` string[]: Projects this task is linked to, including the per-objective ordering. - `quote_relations` string[]: Quotes this task is linked to. - `custom_entity_relations` string[]: Custom entity records this task is linked to. - `exchange_entity_id` string: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. - `gapi_entity_id` string: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. - `o365_entity_id` string: External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. - `reminder` string, uri: Reminder set by the current authenticated user for this task. Per-user; empty when no reminder has been set. Related TaskReminder record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'TaskReminder' for its fields. - `task_recurrence` string, uri: Recurrence schedule generating periodic copies of this task, or empty when no recurrence is set up. Related TaskRecurrence record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'TaskRecurrence' for its fields. - `documents` string[]: Documents linked to this task. - `comments` string[]: Comments authored on this task. - `tags` string[]: Tag labels applied to this task. - `formatted_name` string, required: Display name of the task (alias of subject). - `modified_by_user` string, date-time: Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used. - `start_cursor` string: Cursor of the first record of the page. - `end_cursor` string: Cursor of the last record of the page. - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them. - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them. - `total` integer: Number of records that match the request, across all pages. ## Other responses - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)