VTvtex
Task

List tasks

Changed on

This endpoint allows you to filter VTEX DO tasks. You can choose between the following filtering options:

  • Assignees: using assignee.email and status. Example: https://{{accountName}}.{{environment}}.com.br/api/do/tasks?assignee.email={{person@email.com}}&status={{open}}.

  • Targets: using targetId and status. Example: https://{{accountName}}.{{environment}}.com.br/api/do/tasks?target.id={{name}}&status={{open}}.

  • Paged tasks: using page, perPage and status. Example: https://{{accountName}}.{{environment}}.com.br/api/do/tasks?page={{1}}&perPage={{10}}&status=;{{-Closed}}.

  • Context: using context, page, perPage and status. Example: https://{{accountName}}.{{environment}}.com.br/api/do/tasks?context={{context}}&page={{1}}&perPage={{10}}&status={{-Closed}}.

Permissions

This endpoint does not require License Manager resources.

get/tasks

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br/api/do
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/do/tasks
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Query parameters

assignee.emailstring
Example:assigneeName@email.com

If you wish to list tasks by assignee, insert the desired assignee's email and status.

target.idstring
Example:{{targetId}}

If you wish to list tasks by target, insert the desired targetId and status.

contextstring
Example:page

If you wish to list tasks by context, insert the desired context, page, perPage and status.

pagestring
Example:{{page}}

If you wish to list tasks by context, also insert the desired page.

perPagestring
Example:{{desired number per page}}

If you wish to list tasks by context, also insert the desired perPage value.

statusstring
Example:open

If you wish to list tasks by context, also insert the desired status.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

piiHiddenboolean

If the VTEX account uses PII data architecture (true), or not (false).

Changes

  • 03abee02b4eaRevision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

  • 8b1e2c5c9e08Revision changes
    • breaking

      the response property // became nullable for the status