List email and SMS messages

curl --request GET \
  --url https://service.abundly.ai/workspaceapi/agents/{agentId}/messages \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://service.abundly.ai/workspaceapi/agents/{agentId}/messages"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://service.abundly.ai/workspaceapi/agents/{agentId}/messages', 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://service.abundly.ai/workspaceapi/agents/{agentId}/messages",
  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: Bearer <token>"
  ],
]);

$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://service.abundly.ai/workspaceapi/agents/{agentId}/messages"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://service.abundly.ai/workspaceapi/agents/{agentId}/messages")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "entries": [
    {
      "id": "<string>",
      "agentId": "<string>",
      "customerId": "<string>",
      "direction": "<string>",
      "channel": "<string>",
      "from": "<string>",
      "to": [
        "<string>"
      ],
      "body": "<string>",
      "createdAt": "<string>",
      "cc": [
        "<string>"
      ],
      "bcc": [
        "<string>"
      ],
      "subject": "<string>",
      "status": "<string>",
      "attachments": [
        {
          "filename": "<string>",
          "fileUrl": "<string>",
          "mimeType": "<string>",
          "documentId": "<string>"
        }
      ],
      "relatedActivityLogEntryId": "<string>"
    }
  ],
  "totalCount": 123,
  "page": 123,
  "pageSize": 123
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

workspaceapi

agents

{agentId}

messages

List email and SMS messages

curl --request GET \
  --url https://service.abundly.ai/workspaceapi/agents/{agentId}/messages \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://service.abundly.ai/workspaceapi/agents/{agentId}/messages"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://service.abundly.ai/workspaceapi/agents/{agentId}/messages', 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://service.abundly.ai/workspaceapi/agents/{agentId}/messages",
  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: Bearer <token>"
  ],
]);

$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://service.abundly.ai/workspaceapi/agents/{agentId}/messages"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://service.abundly.ai/workspaceapi/agents/{agentId}/messages")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "entries": [
    {
      "id": "<string>",
      "agentId": "<string>",
      "customerId": "<string>",
      "direction": "<string>",
      "channel": "<string>",
      "from": "<string>",
      "to": [
        "<string>"
      ],
      "body": "<string>",
      "createdAt": "<string>",
      "cc": [
        "<string>"
      ],
      "bcc": [
        "<string>"
      ],
      "subject": "<string>",
      "status": "<string>",
      "attachments": [
        {
          "filename": "<string>",
          "fileUrl": "<string>",
          "mimeType": "<string>",
          "documentId": "<string>"
        }
      ],
      "relatedActivityLogEntryId": "<string>"
    }
  ],
  "totalCount": 123,
  "page": 123,
  "pageSize": 123
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST, PUT, PATCH and DELETE endpoints the Workspace write API scope, and sending or revoking invitations (POST and DELETE /workspaceapi/invites) the Invite members scope. A key stops working when it expires or is disabled.

Path Parameters

agentId

string

required

The agent id.

Query Parameters

pageSize

integer

Page size (default 50).

Required range: 1 <= x <= 200

page

integer

Page number (default 1).

Required range: x >= 1

direction

enum<string>

Available options:

inbound,

outbound

channel

enum<string>

Available options:

email,

sms

since

string

ISO date string — only messages after this.

until

string

ISO date string — only messages before this.

Response

Success. Empty result sets are also 200.

Newest first. Only recorded while the agent has its message log enabled.

entries

object[]

required

Show child attributes

totalCount

number

required

Matches the active filter, so it changes as you narrow the query.

page

number

required

pageSize

number

required