List events - Cargo | GTM Infrastructure for AI Agents

List events

curl --request GET \
  --url https://api.getcargo.io/v1/mailboxManagement/events \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.getcargo.io/v1/mailboxManagement/events', 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.getcargo.io/v1/mailboxManagement/events",
  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://api.getcargo.io/v1/mailboxManagement/events"

	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://api.getcargo.io/v1/mailboxManagement/events")

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

{
  "count": 4503599627370495,
  "events": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspaceUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mailboxUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "messageUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "threadUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "sent",
      "occurredAt": "<string>",
      "actorEmail": "<string>",
      "url": "<string>",
      "inboundRfcMessageId": "<string>",
      "userAgent": "<string>",
      "snippet": "<string>",
      "meta": {},
      "createdAt": "<string>"
    }
  ]
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

GET

mailboxManagement

events

List events

curl --request GET \
  --url https://api.getcargo.io/v1/mailboxManagement/events \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.getcargo.io/v1/mailboxManagement/events', 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.getcargo.io/v1/mailboxManagement/events",
  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://api.getcargo.io/v1/mailboxManagement/events"

	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://api.getcargo.io/v1/mailboxManagement/events")

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

{
  "count": 4503599627370495,
  "events": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspaceUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mailboxUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "messageUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "threadUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "sent",
      "occurredAt": "<string>",
      "actorEmail": "<string>",
      "url": "<string>",
      "inboundRfcMessageId": "<string>",
      "userAgent": "<string>",
      "snippet": "<string>",
      "meta": {},
      "createdAt": "<string>"
    }
  ]
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

Authorizations

Authorization

string

header

required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Query Parameters

mailboxUuid

string<uuid>

Only return events on messages sent from this mailbox.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

messageUuid

string<uuid>

Only return events on this message.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

threadUuid

string<uuid>

Only return events in this conversation.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

kinds

enum<string>[]

Optional kind filter.

Available options:

sent,

opened,

clicked,

replied,

bounced,

unsubscribed

occurredAfter

string<date-time>

Include events that happened at or after this ISO timestamp.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

occurredBefore

string<date-time>

Include events that happened at or before this ISO timestamp.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

string

Case-insensitive match on actor address, reply snippet, recipient, or the outbound subject.

Minimum string length: 1

limit

integer

default:50

Maximum number of events to return.

Required range: x <= 200

offset

integer

default:0

Number of events to skip.

Required range: 0 <= x <= 9007199254740991

Response

List events

count

integer

required

Total number of events matching the filters.

Required range: 0 <= x <= 9007199254740991

events

Events · object[]

required

Page of events, newest first.

Show child attributes