logo
ReportsList report recipients

List report recipients

Returns a paginated list of report recipients for the workspace. Supports search by name, email, or company.

curl -X GET "https://api.sendkit.ai/v1/reports/recipients?cursor=666f1a2b3c4d5e6f7a8b9c0d&limit=42&search=john" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "success": true,
  "data": [
    {
      "_id": "666f1a2b3c4d5e6f7a8b9c20",
      "name": "John Doe",
      "email": "john@example.com",
      "company": "Acme Inc",
      "role": "VP Sales",
      "reportType": "workspace",
      "campaignIds": [],
      "active": true,
      "schedule": {
        "enabled": true,
        "frequency": "weekly",
        "dayOfWeek": 1,
        "timeOfDay": "09:00",
        "timezone": "America/New_York",
        "nextScheduledAt": "2026-04-21T09:00:00.000Z"
      },
      "totalReportsSent": 5,
      "createdAt": "2026-03-01T10:00:00.000Z",
      "updatedAt": "2026-04-14T09:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 25,
    "total": 1,
    "hasMore": false,
    "nextCursor": "666f1a2b3c4d5e6f7a8b9c20"
  }
}
GET
/v1/reports/recipients
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
query
cursorstring

Cursor for pagination — use the nextCursor value from the previous response to fetch the next page

query
limitinteger

Items per page (default 25, max 100)

Min: 1 • Max: 100
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

Query Parameters

cursorstring

Cursor for pagination — use the nextCursor value from the previous response to fetch the next page

limitinteger

Items per page (default 25, max 100)

Responses

successboolean
dataarray
paginationobject