List and search tasks.
Changed onLists and searches for tasks using the available filters. Date bounds are inclusive. Requests without any of entityType, entityId, includeRelatedEntity, includeDeals, assignedUserIds, createdByUserId, finishedByUserId, metricIds, withAttachments, indexed=true, typesIn, dateField, excludePinned, sortBy or sortOrder must include at least one of dueDateGt, finishedDateGt, updatedDateGt or createdDateGt. Each lower bound must be within 31 calendar days of its upper bound (or today when no upper bound is supplied). With any of the listed filters, date bounds may be provided independently.
Filters: entityType and entityId must be supplied together. Different filters are combined with AND; IDs within assignedUserIds or metricIds, and values within typesIn, are combined with OR. If both metricId and metricIds are supplied, both constraints must match. finishedEq filters completion in both search modes. indexed=true selects indexed search without adding a filter. Omitting it or sending indexed=false keeps the legacy path when no new filter is present. dateField=due_at requires a due date; other dateField values are not supported. Results are limited to activities the authenticated user is allowed to access. Without sortBy, indexed results are ordered by creation descending, then update ascending. With sortBy (createdAt, updatedAt, dueDate or finishedAt), sortOrder accepts asc (default) or desc. Missing dates are placed last in either direction. Records with the same sort value have no guaranteed relative order. sortOrder without sortBy returns 400. dateField filters date presence independently of sorting. Omitting both sorting parameters uses the default ordering. meta.totalCount contains the total number of matching tasks when available. Pagination links keep their existing format.
Request
- Base URLhttps://api.agendor.com.br/v3
- AuthAPI key in header Authorization
Query parameters
Page of results to fetch.
Number of results to return per page.
Use to search for tasks that were finished on or after this date.
Use to search for tasks that were finished on or before this date.
Use to search for tasks due on or after this date.
Use to search for tasks due on or before this date.
Use to search for tasks that were updated on or after this date.
Use to search for tasks that were updated on or before this date.
Use to search for tasks that were created on or after this date.
Use to search for tasks that were created on or before this date.
Metric ID.
Filters tasks by completion status.
Entity type. Must be supplied together with entityId. Deals include ancestor deal activities.
Entity ID. Must be supplied together with entityType.
For organizations, includes activities of related people.
Includes related deals. For organizations, also includes deals of related people, independently of includeRelatedEntity.
Creator user ID.
User ID that finished the task.
Filters activities by whether they have attachments.
Selects indexed search when true, without adding a filter. Defaults to false; new filters still select indexed search.
Requires a due date to be present. Does not change ordering or require a date range.
Excludes active pins for the requested entity before pagination. Defaults to false; has no effect without an entity.
Date used to sort results. Missing dates are last; equal values have no guaranteed order.
Sort direction. Requires sortBy; defaults to asc only when sortBy is supplied.
Includes audioTranscription and audioSummary when available. Defaults to false.
Request body application/x-www-form-urlencoded
Response
OK
Changes
- warning
deleted the
queryrequest parameterstatus - info
added the new optional
queryrequest parameterindexed
- warning
- info
added the new optional
queryrequest parametercreatedByUserId - info
added the new optional
queryrequest parameterdateField - info
added the new optional
queryrequest parameterentityId - info
added the new optional
queryrequest parameterentityType - info
added the new optional
queryrequest parameterexcludePinned - info
added the new optional
queryrequest parameterfinishedByUserId - info
added the new optional
queryrequest parameterincludeDeals - info
added the new optional
queryrequest parameterincludeRelatedEntity - info
added the new optional
queryrequest parameterincludeVoip - info
added the new optional
queryrequest parametersortBy - info
added the new optional
queryrequest parametersortOrder - info
added the new optional
queryrequest parameterstatus - info
added the new optional
queryrequest parameterwithAttachments - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info