Nudges API

Nudges are outbound reminders tied to an employee and campaign period.

Endpoints

• GET /api/v1/nudges

Show/Create/Update/Delete: nudge endpoints are currently read-only list only.

Filtering, Sorting, Include

• Filters: id, campaign_period_id, employee_id, channel
• Sort fields: id, sent_at, channel, created_at, updated_at
• Include: employee, campaign_period

GET /api/v1/nudges

curl -X GET "https://cases.shipmentbot.com/api/v1/nudges?filter[channel]=email&filter[campaign_period_id]=11&sort=-sent_at&include=employee,campaign_period&page[number]=1&page[size]=25" \
  -H "Accept: application/json" \
  -H "X-API-Key: csb_live_your_token_here"

{
  "data": [
    {
      "id": "21",
      "type": "nudges",
      "attributes": {
        "channel": "email",
        "sent_at": "2026-03-05T16:00:00.000Z",
        "template_used": "weekly-reminder-v2",
        "created_at": "2026-03-05T16:00:00.000Z",
        "updated_at": "2026-03-05T16:00:00.000Z"
      },
      "relationships": {
        "employee": {
          "links": {
            "self": "https://cases.shipmentbot.com/api/v1/nudges?filter%5Bid%5D=21/relationships/employee",
            "related": "https://cases.shipmentbot.com/api/v1/employees/4"
          },
          "data": { "id": "4", "type": "employees" }
        },
        "campaign_period": {
          "links": {
            "self": "https://cases.shipmentbot.com/api/v1/nudges?filter%5Bid%5D=21/relationships/campaign_period",
            "related": "https://cases.shipmentbot.com/api/v1/campaign_periods/11"
          },
          "data": { "id": "11", "type": "campaign_periods" }
        }
      },
      "links": {
        "self": "https://cases.shipmentbot.com/api/v1/nudges?filter%5Bid%5D=21"
      }
    }
  ],
  "included": [],
  "links": {
    "self": "https://cases.shipmentbot.com/api/v1/nudges?filter%5Bchannel%5D=email&filter%5Bcampaign_period_id%5D=11&sort=-sent_at&include=employee%2Ccampaign_period&page%5Bnumber%5D=1&page%5Bsize%5D=25",
    "first": "https://cases.shipmentbot.com/api/v1/nudges?filter%5Bchannel%5D=email&filter%5Bcampaign_period_id%5D=11&sort=-sent_at&include=employee%2Ccampaign_period&page%5Bnumber%5D=1&page%5Bsize%5D=25",
    "last": "https://cases.shipmentbot.com/api/v1/nudges?filter%5Bchannel%5D=email&filter%5Bcampaign_period_id%5D=11&sort=-sent_at&include=employee%2Ccampaign_period&page%5Bnumber%5D=1&page%5Bsize%5D=25",
    "next": null,
    "prev": null
  },
  "meta": {
    "page": {
      "number": 1,
      "size": 25,
      "total_records": 1,
      "total_pages": 1
    }
  }
}

Error Example

401 Unauthorized

{
  "data": null,
  "included": [],
  "links": {
    "self": "https://cases.shipmentbot.com/api/v1/nudges"
  },
  "meta": {},
  "errors": [
    {
      "status": "401",
      "title": "Unauthorized",
      "detail": "X-API-Key header is required."
    }
  ]
}