List v2 conversations

GET

conversations

curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/conversations \
  --header 'x-api-key: <api-key>'

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

fetch('https://api-sandbox.featherhq.com/v1/conversations', 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-sandbox.featherhq.com/v1/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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-sandbox.featherhq.com/v1/conversations"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/conversations")

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

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

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

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "channel": "<string>",
      "surface": "<string>",
      "status": "queued",
      "priority": "low",
      "message_count": 123,
      "started_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "external_session_id": "<string>",
      "session_type": "live",
      "subject": "<string>",
      "assigned_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "retention_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "summary": "<string>",
      "metadata": {},
      "context_variables": {},
      "first_message_at": "2023-11-07T05:31:56Z",
      "last_message_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "closed_at": "2023-11-07T05:31:56Z",
      "ttl_expires_at": "2023-11-07T05:31:56Z",
      "retention_expires_at": "2023-11-07T05:31:56Z",
      "archived_at": "2023-11-07T05:31:56Z",
      "memory_sync_state": "pending",
      "duration_ms": 123,
      "summary_preview": "<string>",
      "has_recording": false,
      "eval_summary": {
        "total": 0,
        "succeeded": 0,
        "failed": 0,
        "pending": 0,
        "critical_total": 0,
        "critical_succeeded": 0,
        "critical_failed": 0,
        "critical_pending": 0,
        "eval_status": "none"
      },
      "test_features": {
        "identity_resolution": true,
        "memory": true,
        "summarization": true,
        "extraction": true,
        "evaluations": true,
        "knowledge_gap_analysis": true,
        "version": 1
      },
      "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision_name": "<string>",
      "revision_version": 123,
      "team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "team_revision_name": "<string>",
      "from_number": "<string>",
      "to_number": "<string>",
      "email": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

Query Parameters

status

string | null

channel

string | null

end_user_id

string<uuid> | null

assigned_agent_id

string<uuid> | null

priority

string | null

started_after

string<date-time> | null

Lower-bound (inclusive) on conversation started_at.

started_before

string<date-time> | null

Upper-bound (inclusive) on conversation started_at.

string | null

Case-insensitive substring match on subject/summary.

eval_filter

enum<string> | null

Available options:

has_evals,

no_evals,

all_passed,

any_failed

from_number

string | null

Originating phone number, matched as normalized E.164. On an inbound session this is the customer's caller ID; on an outbound one it is the platform number that dialed. Applies to voice and SMS.

to_number

string | null

Destination phone number, matched as normalized E.164. On an inbound session this is the platform number that was dialed; on an outbound one it is the customer's number. Applies to voice and SMS.

string | null

Sessions whose end user owns this email address (case-insensitive).

string<uuid> | null

Exact-match lookup by session id.

external_session_id

string | null

Exact-match lookup by the caller-supplied external session id.

limit

integer

default:50

Required range: 1 <= x <= 200

cursor

string | null

Response

Successful Response

items

SessionResponse · object[]

required

Show child attributes

has_more

boolean

required

next_cursor

string | null

List v2 conversations

curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/conversations \
  --header 'x-api-key: <api-key>'

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

fetch('https://api-sandbox.featherhq.com/v1/conversations', 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-sandbox.featherhq.com/v1/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <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-sandbox.featherhq.com/v1/conversations"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/conversations")

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

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

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

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "channel": "<string>",
      "surface": "<string>",
      "status": "queued",
      "priority": "low",
      "message_count": 123,
      "started_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "external_session_id": "<string>",
      "session_type": "live",
      "subject": "<string>",
      "assigned_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "retention_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "summary": "<string>",
      "metadata": {},
      "context_variables": {},
      "first_message_at": "2023-11-07T05:31:56Z",
      "last_message_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "closed_at": "2023-11-07T05:31:56Z",
      "ttl_expires_at": "2023-11-07T05:31:56Z",
      "retention_expires_at": "2023-11-07T05:31:56Z",
      "archived_at": "2023-11-07T05:31:56Z",
      "memory_sync_state": "pending",
      "duration_ms": 123,
      "summary_preview": "<string>",
      "has_recording": false,
      "eval_summary": {
        "total": 0,
        "succeeded": 0,
        "failed": 0,
        "pending": 0,
        "critical_total": 0,
        "critical_succeeded": 0,
        "critical_failed": 0,
        "critical_pending": 0,
        "eval_status": "none"
      },
      "test_features": {
        "identity_resolution": true,
        "memory": true,
        "summarization": true,
        "extraction": true,
        "evaluations": true,
        "knowledge_gap_analysis": true,
        "version": 1
      },
      "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision_name": "<string>",
      "revision_version": 123,
      "team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "team_revision_name": "<string>",
      "from_number": "<string>",
      "to_number": "<string>",
      "email": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}