# List Whatsapp Batch Recipients

`GET /v1/whatsapp/batches/{batch_id}/recipients`

A batch's rows in upload order, each with its rendered message.

`status` may repeat; a row matching any of them is returned.

Authenticate with `Authorization: Bearer $TALQING_API_KEY`. Errors use the shared envelope: https://docs.talqing.com/api-reference/errors.md

## OpenAPI

```json
{
 "openapi":"3.1.0",
 "servers":[
  {
   "description":"Talqing API",
   "url":"https://api.talqing.com"
  }
 ],
 "paths":{
  "/v1/whatsapp/batches/{batch_id}/recipients":{
   "get":{
    "description":"A batch's rows in upload order, each with its rendered message.\n\n`status` may repeat; a row matching any of them is returned.",
    "operationId":"whatsapp.batches.recipients.list",
    "parameters":[
     {
      "in":"path",
      "name":"batch_id",
      "required":true,
      "schema":{
       "format":"uuid",
       "title":"Batch Id",
       "type":"string"
      }
     },
     {
      "in":"query",
      "name":"limit",
      "required":false,
      "schema":{
       "default":50,
       "maximum":200,
       "minimum":1,
       "title":"Limit",
       "type":"integer"
      }
     },
     {
      "in":"query",
      "name":"offset",
      "required":false,
      "schema":{
       "default":0,
       "minimum":0,
       "title":"Offset",
       "type":"integer"
      }
     },
     {
      "in":"query",
      "name":"status",
      "required":false,
      "schema":{
       "anyOf":[
        {
         "items":{
          "enum":[
           "ready",
           "skipped",
           "sending",
           "queued",
           "sent",
           "delivered",
           "read",
           "undelivered",
           "failed",
           "replied"
          ],
          "type":"string"
         },
         "type":"array"
        },
        {
         "type":"null"
        }
       ],
       "title":"Status"
      }
     }
    ],
    "responses":{
     "200":{
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/PageWhatsAppRecipientResponse"
        }
       }
      },
      "description":"Successful Response"
     },
     "401":{
      "$ref":"#/components/responses/Unauthorized"
     },
     "404":{
      "$ref":"#/components/responses/NotFound"
     },
     "422":{
      "$ref":"#/components/responses/ValidationFailed"
     },
     "default":{
      "$ref":"#/components/responses/Error"
     }
    },
    "security":[
     {
      "BearerAuth":[]
     },
     {
      "SessionCookie":[]
     }
    ],
    "summary":"List Whatsapp Batch Recipients",
    "tags":[
     "whatsapp"
    ]
   }
  }
 },
 "components":{
  "responses":{
   "Error":{
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ErrorResponse"
      }
     }
    },
    "description":"Unexpected error. Every error this API returns carries this body."
   },
   "NotFound":{
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ErrorResponse"
      }
     }
    },
    "description":"No such resource in this organization."
   },
   "Unauthorized":{
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ErrorResponse"
      }
     }
    },
    "description":"Missing credential, or one that is revoked or no longer a member of this organization."
   },
   "ValidationFailed":{
    "content":{
     "application/json":{
      "schema":{
       "$ref":"#/components/schemas/ErrorResponse"
      }
     }
    },
    "description":"The request did not match this operation's schema; `detail.errors` lists each field."
   }
  },
  "schemas":{
   "ErrorBody":{
    "description":"The structured half of our error contract: a human `message` plus a list\nof individual `errors` (used wherever we surface many problems at once,\nincluding tool publish, op-tree checks, and request validation). The global\nexception handlers normalize every API error to\n`{detail: {message, errors, code}}`, so SDKs can parse one shape consistently.",
    "properties":{
     "code":{
      "anyOf":[
       {
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "default":null,
      "description":"A stable identifier for this error, when it has one.",
      "title":"Code"
     },
     "errors":{
      "items":{
       "type":"string"
      },
      "title":"Errors",
      "type":"array"
     },
     "message":{
      "title":"Message",
      "type":"string"
     }
    },
    "required":[
     "message",
     "errors"
    ],
    "title":"ErrorBody",
    "type":"object"
   },
   "ErrorResponse":{
    "description":"The body of every error response, at every status code.",
    "properties":{
     "detail":{
      "$ref":"#/components/schemas/ErrorBody"
     }
    },
    "required":[
     "detail"
    ],
    "title":"ErrorResponse",
    "type":"object"
   },
   "PageWhatsAppRecipientResponse":{
    "properties":{
     "has_more":{
      "title":"Has More",
      "type":"boolean"
     },
     "items":{
      "items":{
       "$ref":"#/components/schemas/WhatsAppRecipientResponse"
      },
      "title":"Items",
      "type":"array"
     },
     "limit":{
      "title":"Limit",
      "type":"integer"
     },
     "offset":{
      "title":"Offset",
      "type":"integer"
     }
    },
    "required":[
     "items",
     "has_more",
     "limit",
     "offset"
    ],
    "title":"Page[WhatsAppRecipientResponse]",
    "type":"object"
   },
   "WhatsAppRecipientResponse":{
    "properties":{
     "conversation_id":{
      "anyOf":[
       {
        "format":"uuid",
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "title":"Conversation Id"
     },
     "delivered_at":{
      "anyOf":[
       {
        "format":"date-time",
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "title":"Delivered At"
     },
     "delivery_attempts":{
      "title":"Delivery Attempts",
      "type":"integer"
     },
     "error_code":{
      "anyOf":[
       {
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "title":"Error Code"
     },
     "id":{
      "format":"uuid",
      "title":"Id",
      "type":"string"
     },
     "input":{
      "additionalProperties":{
       "type":"string"
      },
      "title":"Input",
      "type":"object"
     },
     "last_error":{
      "anyOf":[
       {
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "title":"Last Error"
     },
     "next_attempt_at":{
      "anyOf":[
       {
        "format":"date-time",
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "title":"Next Attempt At"
     },
     "overrides":{
      "additionalProperties":{
       "type":"string"
      },
      "title":"Overrides",
      "type":"object"
     },
     "read_at":{
      "anyOf":[
       {
        "format":"date-time",
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "title":"Read At"
     },
     "rendered":{
      "title":"Rendered",
      "type":"string"
     },
     "replied_at":{
      "anyOf":[
       {
        "format":"date-time",
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "title":"Replied At"
     },
     "row_number":{
      "title":"Row Number",
      "type":"integer"
     },
     "send_attempts":{
      "title":"Send Attempts",
      "type":"integer"
     },
     "sent_at":{
      "anyOf":[
       {
        "format":"date-time",
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "title":"Sent At"
     },
     "skip_reason":{
      "anyOf":[
       {
        "enum":[
         "operator",
         "duplicate_recipient",
         "unfillable"
        ],
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "title":"Skip Reason"
     },
     "status":{
      "enum":[
       "ready",
       "skipped",
       "sending",
       "queued",
       "sent",
       "delivered",
       "read",
       "undelivered",
       "failed"
      ],
      "title":"Status",
      "type":"string"
     },
     "to_e164":{
      "anyOf":[
       {
        "type":"string"
       },
       {
        "type":"null"
       }
      ],
      "title":"To E164"
     },
     "updated_at":{
      "format":"date-time",
      "title":"Updated At",
      "type":"string"
     }
    },
    "required":[
     "id",
     "row_number",
     "to_e164",
     "input",
     "overrides",
     "rendered",
     "status",
     "skip_reason",
     "last_error",
     "error_code",
     "send_attempts",
     "delivery_attempts",
     "next_attempt_at",
     "sent_at",
     "delivered_at",
     "read_at",
     "replied_at",
     "conversation_id",
     "updated_at"
    ],
    "title":"WhatsAppRecipientResponse",
    "type":"object"
   }
  }
 }
}
```