Tasks

Overview

Retrieve the actions a person needs to complete. Tasks enables developers to show consumers and business contacts what needs their attention next across WEX platforms. It includes an operation that returns a prioritized task list for a person, with optional filtering by task type. Use this resource to build to-do lists, dashboards, and reminders that help consumers act on time.

Why use the API?

• Modernization: It provides a standardized, clear, and modern RESTful endpoint, making it easier to integrate with current systems.
• Integration: It allows you to easily consume and integrate task data, powering your own consumer-facing experiences.
• Growth & Innovation: Using our API, you can improve your own products and create a smoother experience for your customers and consumers.

What can the API do?

The Tasks API allows you to perform functions related to the person’s:

• Prioritized task list
• Task types, such as repayments due and receipts needed [confirm examples]

Key Features

• Returns tasks in priority order, highest first. Tasks with equal priority are ordered oldest first.
• Identifies the person from person_id when supplied, or from the caller’s token when it is not.
• Filters results to one or more task types with a repeatable task_type parameter.
• Returns only the tasks visible to the person.
• Protects privacy by returning 404 instead of 403 when access is denied, so the existence of other persons is never revealed.

Tasks API Operations

The Tasks API includes the following operation. Select the API Reference tab to find functional information about it.

• Get Tasks