Get List Custom Opt-Out
This API allows you to retrieve the list of Custom Opt-Outs.
To create a new Custom Opt-Out, visit the Custom Opt-Out page in your Cellcast account or by API.
Parameters for getting List Custom Opt-Out
Headers Parameters
| Parameters | Description |
|---|---|
| Authorization | Please add provided Bearer token - linked to your Cellcast account. Check here |
| Content-Type | application/json |
Query Parameters
| Parameters | Type | Description | Required |
|---|---|---|---|
| page | integer | Page number for pagination | Yes |
| size | integer | Number of items per page | Yes |
Code Samples
GET https://api.cellcast.com/api/v1/apiClient/optoutlist?page=1&size=10
bash
curl --location 'https://api.cellcast.com/api/v1/apiClient/optoutlist?page=1&size=10' \
--header 'Content-Type: application/json' \
--header 'authorization: Bearer {{API_KEY}}' \Replace with the actual API key that you own.
Responses
200 Success
json
{
"maintainence": 0,
"new_version": 0,
"force_update": 0,
"invalid_token": 0,
"refresh_token": "",
"show_message": 0,
"is_enc": false,
"status": true,
"message": "You have 9 optout list(s)",
"message_type": "toast",
"data": {
"items": [
{
"title": "Create API",
"description": "API Description",
"options": [
{
"option1": "Option 1"
},
{
"option2": "option 2"
}
],
"createdBy": "680f524350eb4e38fead5161",
"createdAt": "2025-11-11T10:16:23.293Z",
"updatedAt": "2025-11-11T10:16:23.293Z"
},
{
"title": "Create API",
"description": "API Description",
"options": [
{
"option1": "Option 1"
},
{
"option2": "option 2"
}
],
"createdBy": "680f524350eb4e38fead5161",
"createdAt": "2025-11-11T10:14:25.687Z",
"updatedAt": "2025-11-11T10:14:25.687Z"
},
{
"title": "Create API",
"description": "API Description",
"options": [
{
"option1": "Option 1"
},
{
"option2": "option 2"
}
],
"createdBy": "680f524350eb4e38fead5161",
"createdAt": "2025-11-11T10:11:47.577Z",
"updatedAt": "2025-11-11T10:11:47.577Z"
},
{
"title": "ENWNEW",
"description": "We're sorry to see you go! Are yoEWNNEWNEu still interested in any of these contents?",
"options": [
{
"option1": "Not interested"
},
{
"option2": "asasa"
}
],
"createdBy": "680f524350eb4e38fead5161",
"createdAt": "2025-11-11T10:07:30.029Z",
"updatedAt": "2025-11-11T10:07:30.029Z"
},
{
"title": "My Custom Opt Out",
"description": "We're sorry to see you go! Are you still interested in any of these contents?",
"options": [
{
"option1": "Not interested"
},
{
"option2": "Not interested 2"
}
],
"createdBy": "680f524350eb4e38fead5161",
"createdAt": "2025-11-11T09:11:52.738Z",
"updatedAt": "2025-11-11T09:14:45.750Z"
},
{
"title": "New-Opt-Out",
"description": "We're sorry to see you go! Are you still interested in any of these contents?",
"options": [
{
"option1": "Not interested"
},
{
"option2": "Spam"
}
],
"createdBy": "680f524350eb4e38fead5161",
"createdAt": "2025-06-24T10:38:58.260Z",
"updatedAt": "2025-06-24T10:38:58.260Z"
},
{
"title": "Stop Link",
"description": "We're sorry to see you go! Are you still interested in any of these contents?",
"options": [],
"createdBy": "637fa4ebb824faa4688d1445",
"createdAt": "2024-07-01T05:52:14.342Z",
"updatedAt": "2024-07-01T05:52:14.342Z"
},
{
"title": "One Click OptOut",
"description": "To stop receiving messages of this type from us in the future please click the button below.",
"options": [],
"createdBy": "65e6e8c7b02dcb98a9ac70fe",
"createdAt": "2024-06-18T08:38:03.407Z",
"updatedAt": "2024-06-19T04:52:20.628Z"
},
{
"title": "Opt-out Survey",
"description": "To stop receiving messages of this type from us in the future please enter your number below and choose which option is most relevant to you.",
"options": [
{
"option1": "Offer me something better!"
},
{
"option2": "No longer interested in it!"
},
{
"option3": "Don`t want messages!"
}
],
"createdBy": "637fa4ebb824faa4688d1445",
"createdAt": "2023-12-22T12:28:42.742Z",
"updatedAt": "2024-02-01T05:21:24.393Z"
}
],
"total": 9,
"limit": 10,
"totalPages": 1,
"current": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": false,
"prevPage": null,
"nextPage": null
},
"error": {}
}401 Unauthorized
json
{
"code": 401,
"message": "Token expired",
"stack": "APIError: Token expired ...."
}