Sends
Retrieve All Sends
Retrieves a list of all sends initiated by anyone in the organization.
GET
/
api
/
v3
/
send
Retrieve All Sends
curl --request GET \
--url https://app.staging.sendo.so/api/v3/send \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.staging.sendo.so/api/v3/send"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.staging.sendo.so/api/v3/send', 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://app.staging.sendo.so/api/v3/send",
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://app.staging.sendo.so/api/v3/send"
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))
}HttpResponse<String> response = Unirest.get("https://app.staging.sendo.so/api/v3/send")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.staging.sendo.so/api/v3/send")
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{
"current_page": 1,
"per_page": 10,
"total_count": 892,
"sends": [
{
"id": 1,
"send_gid": "Z2lkOi8vc2VuZG9zby9TZW5kLzQ0",
"type": "eGifts USA",
"subtype": "eGift Cards USA",
"currency": "USD",
"current_total_cost": "2.0",
"status": "Expired",
"created_at": "2022-09-12T12:08:27-07:00",
"touch": {
"id": 12,
"name": "eGift Cards USA"
},
"recipient": {
"name": "John Doe",
"email": "johndoe@acme.com",
"company_name": "Acme"
},
"sender": {
"id": 123,
"name": "Marc Fernandez",
"email": "marc.fernandez@sendoso.com",
"team_id": 123,
"team_name": "Marketing Ops"
},
"sent_via": "Sendoso.com",
"status_updates": [
{
"status": "Sent",
"occurred_at": "2022-09-12T12:08:27-07:00"
},
{
"status": "Opened",
"occurred_at": "2022-09-12T12:08:58-07:00"
},
{
"status": "Clicked",
"occurred_at": "2022-09-12T12:08:58-07:00"
},
{
"status": "Expired",
"occurred_at": "2022-12-11T00:00:02-08:00"
}
]
},
{
"id": 2,
"send_gid": "Z2lkOi8vc2VuZG9zby9TZW5kLzE",
"type": "Inventoried Sends",
"subtype": "Custom",
"currency": "USD",
"current_total_cost": "5.0",
"status": "Address Confirmation - Cancelled",
"created_at": "2022-12-21T23:37:22-08:00",
"touch": {
"id": 25,
"name": "Triggered inventory"
},
"recipient": {
"name": "Marc Fernandez Girones",
"email": "marc.fernandez@sendoso.com",
"company_name": "Sendoso"
},
"sender": {
"id": 123,
"name": "Marc Fernandez",
"email": "marc.fernandez@sendoso.com",
"team_id": 123,
"team_name": "Marketing Ops"
},
"sent_via": "Salesforce Trigger",
"status_updates": [
{
"status": "Confirming Address",
"occurred_at": "2022-12-22T05:42:27-08:00"
},
{
"status": "Address Confirmation - Cancelled",
"occurred_at": "2022-12-27T09:00:05-08:00"
}
]
}
]
}
Parameters
integer
The page number of the results you want to retrieve (the first page is 1). See Pagination for more information.
integer
The number of sends to be returned per page (max is 100). See Pagination for more information.
Response
integer
required
The current page being returned (used for pagination purposes).
integer
required
The number of results being returned per page (used for pagination purposes).
integer
required
The total number of sends (used for pagination purposes).
array
required
List of sends
Hide send
Hide send
integer
required
The send’s identifier.
string
required
The gid of the send.
string
required
The send’s type. Possible values are
Amazon, Handwritten Notes, Inventoried Sends, Sendoso Choice, Sendoso Direct, eGifts International, eGifts USAstring
required
The send’s subtype. Possible values are
Bundles, Buy/Send via Amazon, Buy/Send via Amazon UK, Coffee, Custom, Custom Bundles, DDO_GIFT, Donate to Charity, Experiences, Handwritten Notes, Lunch, On-Demand, Visa eGift Credit Card (US), Wine, eGift Cards Australia, eGift Cards Brazil, eGift Cards Canada, eGift Cards France, eGift Cards Germany, eGift Cards India, eGift Cards Ireland, eGift Cards Italy, eGift Cards Mexico, eGift Cards Netherlands, eGift Cards New Zealand, eGift Cards Poland, eGift Cards Singapore, eGift Cards Slovakia, eGift Cards UK, eGift Cards USAstring
required
The send’s gift currency (in
ISO 4217 format).string
required
The send’s cost at the time that this request was made. Note that this cost could change overtime until the send is in a final status.
string
required
The current send’s status. Possible values are
Address Confirmation - Cancelled, Bounced and Credited, Cancelled, Clicked, Collecting recipient info, Confirming Address, Delivered, Expired and Credited, Failed, Opened, Packed, Paused, Processing, Refunded, Sent, Shipped, Undeliverable, Used, pending.string
required
The date and time the send was initiated (in
ISO 8601 format).object
required
object
required
object
required
string
required
Platform where the sent was initiated from.
{
"current_page": 1,
"per_page": 10,
"total_count": 892,
"sends": [
{
"id": 1,
"send_gid": "Z2lkOi8vc2VuZG9zby9TZW5kLzQ0",
"type": "eGifts USA",
"subtype": "eGift Cards USA",
"currency": "USD",
"current_total_cost": "2.0",
"status": "Expired",
"created_at": "2022-09-12T12:08:27-07:00",
"touch": {
"id": 12,
"name": "eGift Cards USA"
},
"recipient": {
"name": "John Doe",
"email": "johndoe@acme.com",
"company_name": "Acme"
},
"sender": {
"id": 123,
"name": "Marc Fernandez",
"email": "marc.fernandez@sendoso.com",
"team_id": 123,
"team_name": "Marketing Ops"
},
"sent_via": "Sendoso.com",
"status_updates": [
{
"status": "Sent",
"occurred_at": "2022-09-12T12:08:27-07:00"
},
{
"status": "Opened",
"occurred_at": "2022-09-12T12:08:58-07:00"
},
{
"status": "Clicked",
"occurred_at": "2022-09-12T12:08:58-07:00"
},
{
"status": "Expired",
"occurred_at": "2022-12-11T00:00:02-08:00"
}
]
},
{
"id": 2,
"send_gid": "Z2lkOi8vc2VuZG9zby9TZW5kLzE",
"type": "Inventoried Sends",
"subtype": "Custom",
"currency": "USD",
"current_total_cost": "5.0",
"status": "Address Confirmation - Cancelled",
"created_at": "2022-12-21T23:37:22-08:00",
"touch": {
"id": 25,
"name": "Triggered inventory"
},
"recipient": {
"name": "Marc Fernandez Girones",
"email": "marc.fernandez@sendoso.com",
"company_name": "Sendoso"
},
"sender": {
"id": 123,
"name": "Marc Fernandez",
"email": "marc.fernandez@sendoso.com",
"team_id": 123,
"team_name": "Marketing Ops"
},
"sent_via": "Salesforce Trigger",
"status_updates": [
{
"status": "Confirming Address",
"occurred_at": "2022-12-22T05:42:27-08:00"
},
{
"status": "Address Confirmation - Cancelled",
"occurred_at": "2022-12-27T09:00:05-08:00"
}
]
}
]
}
Previous
Send Physical GiftThis endpoint allows you to send a physical item directly to a recipient when their address is known.
Next
⌘I
Retrieve All Sends
curl --request GET \
--url https://app.staging.sendo.so/api/v3/send \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.staging.sendo.so/api/v3/send"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.staging.sendo.so/api/v3/send', 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://app.staging.sendo.so/api/v3/send",
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://app.staging.sendo.so/api/v3/send"
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))
}HttpResponse<String> response = Unirest.get("https://app.staging.sendo.so/api/v3/send")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.staging.sendo.so/api/v3/send")
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{
"current_page": 1,
"per_page": 10,
"total_count": 892,
"sends": [
{
"id": 1,
"send_gid": "Z2lkOi8vc2VuZG9zby9TZW5kLzQ0",
"type": "eGifts USA",
"subtype": "eGift Cards USA",
"currency": "USD",
"current_total_cost": "2.0",
"status": "Expired",
"created_at": "2022-09-12T12:08:27-07:00",
"touch": {
"id": 12,
"name": "eGift Cards USA"
},
"recipient": {
"name": "John Doe",
"email": "johndoe@acme.com",
"company_name": "Acme"
},
"sender": {
"id": 123,
"name": "Marc Fernandez",
"email": "marc.fernandez@sendoso.com",
"team_id": 123,
"team_name": "Marketing Ops"
},
"sent_via": "Sendoso.com",
"status_updates": [
{
"status": "Sent",
"occurred_at": "2022-09-12T12:08:27-07:00"
},
{
"status": "Opened",
"occurred_at": "2022-09-12T12:08:58-07:00"
},
{
"status": "Clicked",
"occurred_at": "2022-09-12T12:08:58-07:00"
},
{
"status": "Expired",
"occurred_at": "2022-12-11T00:00:02-08:00"
}
]
},
{
"id": 2,
"send_gid": "Z2lkOi8vc2VuZG9zby9TZW5kLzE",
"type": "Inventoried Sends",
"subtype": "Custom",
"currency": "USD",
"current_total_cost": "5.0",
"status": "Address Confirmation - Cancelled",
"created_at": "2022-12-21T23:37:22-08:00",
"touch": {
"id": 25,
"name": "Triggered inventory"
},
"recipient": {
"name": "Marc Fernandez Girones",
"email": "marc.fernandez@sendoso.com",
"company_name": "Sendoso"
},
"sender": {
"id": 123,
"name": "Marc Fernandez",
"email": "marc.fernandez@sendoso.com",
"team_id": 123,
"team_name": "Marketing Ops"
},
"sent_via": "Salesforce Trigger",
"status_updates": [
{
"status": "Confirming Address",
"occurred_at": "2022-12-22T05:42:27-08:00"
},
{
"status": "Address Confirmation - Cancelled",
"occurred_at": "2022-12-27T09:00:05-08:00"
}
]
}
]
}