Skip to main content
GET
/
api
/
flow-execution-contact
List Flow Execution Contacts
curl --request GET \
  --url https://api.hilos.io/api/flow-execution-contact \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contact": {
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "jsmith@example.com",
        "meta": {},
        "canonical_phone": "<string>",
        "is_deleted": true,
        "phone": "<string>",
        "id": "<string>",
        "created_on": "2023-11-07T05:31:56Z",
        "last_updated_on": "2023-11-07T05:31:56Z",
        "source": "<string>",
        "external_url": "<string>"
      },
      "status": "READY",
      "created_on": "2023-11-07T05:31:56Z",
      "reason": "<string>",
      "flow_name": "<string>",
      "is_chatbot_execution": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
contact
string<uuid>

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

​
execution_steps__step_id
string<uuid>
​
flow_execution
string<uuid>

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

​
flow_execution__flow
string<uuid>

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

​
flow_execution__flow_version
string<uuid>
​
id
string<uuid>
​
is_active
boolean

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.

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
search
string

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

Response

200 - application/json
​
count
integer
Example:

123

​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

​
results
object[]