Get List Opt-Out/Unsubscribes

This API is to get List Opt-Out/Unsubscribes.

Parameters for getting List Opt-Out/Unsubscribes

Headers Parameters

Parameters	Description
Authorization	Please add provided Bearer token - linked to your Cellcast account. Check here
Content-Type	application/json

Request Query Parameters

Name	Example	Description
page	1	The page number to retrieve, starting from 1. Useful for paginating through a large dataset.
size	100	The number of items to include per page. This defines the limit of results returned in each response.

Code Samples

GET https://api.cellcast.com/api/v1/apiClient/getOptout

cURL

curl --location 'https://api.cellcast.com/api/v1/apiClient/getOptout?page=1&size=5' \
--header 'Content-Type: application/json' \
--header 'authorization: Bearer {{API_KEY}}' \

Replace with the actual API key that you own.

Responses

200 Success

    "meta": {
        "code": 200,
        "status": "SUCCESS"
    },
    "message": "You have 1000 optout contact(s)",
    "data": {
        "items": [
            {
                "number": "400000000",
                "last_name": "Thompson",
                "first_name": "Olivia",
                "full_name": "Olivia Thompson",
                "birthday": "",
                "address": "",
                "email": "[email protected]",
                "postalcode": "",
                "gender": "",
                "post_code": "",
                "date_of_birth": ""
            },
            {
                "number": "400000001",
                "last_name": "Carter",
                "first_name": "Ethan",
                "full_name": "Ethan Carter",
                "birthday": "",
                "address": "",
                "email": "[email protected]",
                "postalcode": "",
                "gender": "",
                "post_code": "",
                "date_of_birth": ""
            },
            {
                "number": "400000002",
                "last_name": "Ramirez",
                "first_name": "Sophia",
                "full_name": "Sophia Ramirez",
                "birthday": "",
                "address": "",
                "email": "[email protected]",
                "postalcode": "",
                "gender": "",
                "post_code": "",
                "date_of_birth": ""
            },
            {
                "number": "400000003",
                "last_name": "Anderson",
                "first_name": "Liam",
                "full_name": "Liam Anderson",
                "birthday": "",
                "address": "",
                "email": "[email protected]",
                "postalcode": "",
                "gender": "",
                "post_code": "",
                "date_of_birth": ""
            },
            {
                "number": "400000004",
                "last_name": "Martinez",
                "first_name": "Isabella",
                "full_name": "Isabella Martinez",
                "birthday": "",
                "address": "",
                "email": "[email protected]",
                "postalcode": "",
                "gender": "",
                "post_code": "",
                "date_of_birth": ""
            }
        ],
        "total": 1000,
        "limit": 5,
        "current": 1,
        "totalPages": 200,
        "pagingCounter": 1,
        "hasPrevPage": false,
        "hasNextPage": true,
        "prevPage": null,
        "nextPage": 2
    },
    "error": {}
}

401 Unauthorized

{
  "code": 401,
  "message": "Token expired",
  "stack": "APIError: Token expired ...."
}