Menu

Contests

The contests resource is very basic. All of the contests you've created through the SlickText dashboard are available through the API. The following actions can be performed on this resource...

Retrieve All Contests

By default, the first set of 20 contests will be returned, but you can modify this number with limit and offset values in the query string. The max limit for a single request is 10,000.

GET https://api.slicktext.com/v1/contests?limit=30&offset=10

Example response:


                    {
                        "meta": {
                            "limit": 20,
                            "offset": 0,
                            "total": 1
                        },
                        "links": {
                            "self": "https://api.slicktext.com/v1/contests/"
                        },
                        "contests": [
                            {
                                "id": "2548645",
                                "textword": "426411",
                                "contestName": "Free Snowbaord",
                                "startTime": "2017-09-21 13:00:00",
                                "endTime": "2017-10-21 14:00:00",
                                "autoReply": "Thanks for entering for a chance to win a FREE Burton snowboard! Winner's will be announced 10/21",
                                "winnerMessage": "You are a winner! Show this text at your local Burton dealer to claim your prize.",
                                "created": "2017-08-21 11:09:55",
                                "loserMessage": null,
                                "sendLoserMessage": "0",
                                "status": "Scheduled",
                                "winners": [
                                    {
                                        "number": "+17165555555",
                                        "city": null,
                                        "state": null,
                                        "dateWon": "2017-10-21 14:00:00"
                                    },
                                    {
                                        "number": "+17164444444",
                                        "city": "JAMESTOWN",
                                        "state": "NY",
                                        "dateWon": "2017-10-21 14:00:00"
                                    }
                                ]
                            }
                        ]
                    }

Retrieve a Specific Contest

Retrieves the single contest with the id equal to {id}

GET https://api.slicktext.com/v1/contests/{id}

Example response:


                    {

                        "links": {
                            "self": "https://api.slicktext.com/v1/contests/2548645"
                        },
                        "contest": {
                           "id": "2548645",
                            "textword": "426411",
                            "contestName": "Free Snowbaord",
                            "startTime": "2017-09-21 13:00:00",
                            "endTime": "2017-10-21 14:00:00",
                            "autoReply": "Thanks for entering for a chance to win a FREE Burton snowboard! Winner's will be announced 10/21",
                            "winnerMessage": "You are a winner! Show this text at your local Burton dealer to claim your prize.",
                            "created": "2017-08-21 11:09:55",
                            "loserMessage": null,
                            "sendLoserMessage": "0",
                            "status": "Scheduled",
                            "winners": [
                                {
                                    "number": "+17165555555",
                                    "city": null,
                                    "state": null,
                                    "dateWon": "2017-10-21 14:00:00"
                                },
                                {
                                    "number": "+17164444444",
                                    "city": "JAMESTOWN",
                                    "state": "NY",
                                    "dateWon": "2017-10-21 14:00:00"
                                }
                            ]
                        }
                    }