Retrieve All Sends

GET

api

send

Retrieve All Sends

curl --request GET \
  --url https://app.staging.sendo.so/api/v3/send \
  --header 'Authorization: Bearer <token>'

{
  "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

page

integer

The page number of the results you want to retrieve (the first page is 1). See Pagination for more information.

per_page

integer

The number of sends to be returned per page (max is 100). See Pagination for more information.

Response

current_page

integer

required

The current page being returned (used for pagination purposes).

per_page

integer

required

The number of results being returned per page (used for pagination purposes).

total_count

integer

required

The total number of sends (used for pagination purposes).

sends

array

required

List of sends

Hide send

integer

required

The send’s identifier.

send_gid

string

required

The gid of the send.

type

string

required

The send’s type. Possible values are Amazon, Handwritten Notes, Inventoried Sends, Sendoso Choice, Sendoso Direct, eGifts International, eGifts USA

subtype

string

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 USA

currency

string

required

The send’s gift currency (in ISO 4217 format).

current_total_cost

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.

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.

created_at

string

required

The date and time the send was initiated (in ISO 8601 format).

touch

object

required

The campaign from which this send was initiated.

Hide touch

integer

required

The campaign’s identifier.

name

string

required

The campaign’s name.

recipient

object

required

The recipient that the gifts were sent to.

Hide recipient

name

integer

required

The recipient’s name.

string

required

The recipient’s email.

company_name

string

required

The recipient’s company name.

sender

object

required

The user that initiated the send.

Hide sender

integer

required

The sender user’s identifier.

name

string

required

The sender’s name.

string

required

The sender’s email address.

team_id

integer

required

The sender’s team identifier.

team_name

string

required

The sender’s team name.

sent_via

string

required

Platform where the sent was initiated from.

status_updates

array

required

List of the different send status changes and when they occurred.

Hide status_updates

status

integer

required

The status that the send changed to

occurred_at

string

required

The date and time when the status change occurred (in ISO 4217 format).

{
  "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"
        }
      ]
    }
  ]
}

Send Physical GiftThis endpoint allows you to send a physical item directly to a recipient when their address is known.

Retrieve All Sends

curl --request GET \
  --url https://app.staging.sendo.so/api/v3/send \
  --header 'Authorization: Bearer <token>'

{
  "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"
        }
      ]
    }
  ]
}

Getting Started

API Reference

Parameters

Response

Getting Started

API Reference

​Parameters

​Response

Parameters

Response