listActionPlans

Returns a paginated list of the seller's action plans, sorted newest first by createdDate. Multiple filters are combined with a logical AND. Multiple values in a single filter are combined with a logical OR.

Query Params
statuses
array of strings

Filters by plan status.

statuses
Allowed:
planTemplateIds
array of strings

Filters by plan template IDs. Multiple values allowed.

planTemplateIds
actionItemIds
array of strings

Filters by associated action item IDs. Multiple values allowed.

actionItemIds
date-time

Plans created at or after this timestamp. Timestamp is in ISO 8601 format.

date-time

Plans created at or before this timestamp. Timestamp is in ISO 8601 format.

integer
≤ 20
Defaults to 10

Maximum number of results per page.

string

A token to retrieve a specific page of results. Pass the nextToken value from a previous response.

Note: The previousToken value is not yet supported.

string

The locale for localized content, as an ISO 639 language code and ISO 3166 country code separated by a hyphen. Defaults to en-US.

includedData
array of strings

Additional data to return in the response. Specify steps to return each plan's steps with their resolved input and output values.

includedData
Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json