ACactivecampaign
Flows

List Flow Execution Contacts

Lists Flow Execution Contacts.

get/channel/whatsapp/flow-execution-contact

Request

  • Base URL
    https://{youraccountname}.api-us1.com/api/3
  • URL
    https://{youraccountname}.api-us1.com/api/3/channel/whatsapp/flow-execution-contact
  • Auth
    API key in header Token

Query parameters

contactstring uuid

A Contact Id to filter the Flow Execution Contacts and only get those from that Contact.

execution_steps__step_idstring uuid
flowstring uuid

A Flow Id to filter the Flow Execution Contacts and only get those from that Flow.

flow_executionstring uuid

A Flow Execution Id to filter the Flow Execution Contacts and only get those from that Flow Execution.

flow_versionstring uuid
idstring uuid
is_activeboolean

A boolean param to filter between active/in progress Flow Execution Contacs.

If the parameter is omitted it will respond with Flow Execution Contacts with any status.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

You can search with the contact__phone, contact__first_name, contact__last_name, contact__email fields.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.