List copies for an issue
List copies for an issue
Overview
List copies for an issue
gethttps://api.subsail.com/v1/issues/{id}/copies/
Request parameters
idstringRequiredpath
Resource ID (alphanumeric).
cursorstringquery
Opaque cursor from the previous response. Omit for the first page.
limitnumberquery
Items per page. Default: 50. Maximum: 200.
statusSent | Cancelled | Not sentquery
Filter by status.
subscriberstringquery
Filter by subscriber ID.
subscriptionstringquery
Filter by subscription ID.
countrystringquery
Filter by subscription country code.
Request body
No request body.
Request examples
No request body.
Responses
200Paginated list of copies
has_morebooleanRequiredTrue if more items are available after this page.
cursorstringRequiredPass this as cursor to fetch the next page. Null when has_more is false.
itemsCopy[]RequiredArray (Copy):
idnumberNumeric copy (subscription item) ID.
date_sentdatestatusSent | Cancelled | Not sentcountrystringISO country code.
issueIssueRefObject (IssueRef):
idstringnumbernumbernamestringsubscriber_idstringsubscription_idstringExample
JSON
{
"has_more": "<boolean>",
"cursor": "<string>",
"items": [
{
"id": "<number>",
"date_sent": "<date>",
"status": "<Sent | Cancelled | Not sent>",
"country": "<string>",
"issue": {
"id": "<string>",
"number": "<number>",
"name": "<string>"
},
"subscriber_id": "<string>",
"subscription_id": "<string>"
}
]
}401Missing or invalid API key (empty response body).
403Account is inactive (empty response body).
404Resource not found
errorbooleanRequiredmessagestringRequiredcodestringMachine-readable code, e.g. read_only_key for read-only key write attempts.
Example
JSON
{
"error": "<boolean>",
"message": "<string>",
"code": "<string>"
}