Skip to main content
POST
Get tasks
Send an empty object {} for the first page. Page size defaults to 50 and is capped at 100. If lastEvaluatedKey is present in the response, pass it back in the next request to load the following page.

Authorizations

Personal access token from Pingmee Settings → Developer Tools

x-api-key
string
header
required

Business API key from Pingmee Settings → Developer Tools

Body

application/json

Pagination and filter parameters. Send an empty object {} to use defaults.

phoneNumberId
string

Filter tasks by business phone number identifier.

agentId
string

Filter tasks assigned to this agent.

participantsIdentifiers
string

Filter tasks linked to this conversation (participantsIdentifiers).

lastEvaluatedKey
object

Key returned from a previous request. Pass this value to fetch the next page of tasks.

limit
integer
default:50

Maximum number of tasks to return.

Required range: 1 <= x <= 100

Response

Tasks

dbObject
object[]

List of tasks returned for this page of results.

hasMoreItemsToFetch
boolean
lastEvaluatedKey
object

If present, call the same endpoint again and pass this value as lastEvaluatedKey to retrieve the next page of results. Pagination is cursor-based, not page-number based.

Last modified on August 30, 2026