List all flow execution contact

Lists Flow Execution Contacts.

GET /api/flow-execution-contact

List Flow Execution Contacts

cURL

curl --request GET \
  --url https://api.hilos.io/api/flow-execution-contact \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.hilos.io/api/flow-execution-contact"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hilos.io/api/flow-execution-contact', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hilos.io/api/flow-execution-contact",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hilos.io/api/flow-execution-contact"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hilos.io/api/flow-execution-contact")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hilos.io/api/flow-execution-contact")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "contact": {
        "canonical_phone": "<string>",
        "phone": "<string>",
        "id": "<string>",
        "last_updated_on": "2023-11-07T05:31:56Z",
        "source": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "[e-mail]",
        "meta": {},
        "is_deleted": true,
        "created_on": "2023-11-07T05:31:56Z",
        "external_url": "<string>"
      },
      "flow_name": "<string>",
      "is_chatbot_execution": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_on": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  ]
}

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[]

Show child attributes