CLclose
tasks

List or filter tasks

Changed on

The view parameter can be used to conveniently access the different task views. It accepts one of the following values:

  • inbox: Shows incomplete tasks up to the end of the user's day only (taking the time zone into account).
  • future: Shows incomplete tasks starting from the user's tomorrow only (taking the time zone into account).
  • archive: Shows complete tasks only.

Note that a view value of inbox or future will override any date__lt or date__gte parameters included in the same request.

The _order_by field allows ordering by date or date_created (descending order by prepending a minus, e.g. _order_by=-date).

get/task/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/task/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Query parameters

_limitinteger

Number of results to return.

_skipinteger

Number of results to skip before returning, for pagination.

assigned_tostring nullable
formatstring nullable
idstring nullable
id__instring nullable
is_completestring nullable
lead_idstring nullable
_order_bystring nullable
organization_idstring nullable
_typestring nullable
_type__instring nullable
viewstring nullable
datestring nullable
date__ltstring nullable
date__ltestring nullable
date__gtstring nullable
date__gtestring nullable
due_datestring nullable
due_date__ltstring nullable
due_date__ltestring nullable
due_date__gtstring nullable
due_date__gtestring nullable
date_created__ltstring nullable
date_created__ltestring nullable
date_created__gtstring nullable
date_created__gtestring nullable
date_updated__ltstring nullable
date_updated__ltestring nullable
date_updated__gtstring nullable
date_updated__gtestring nullable
_fieldsstring

Comma-separated list of fields to include in the response.

Response

Successful response

Changes

  • 7bdb9cfcca22Revision changes
    • warning

      for the query request parameter _limit, the max was set to 1000.00

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status