Getting started

Base URL, request format and how the API scopes to your account.

The CloudShope API is a REST API over HTTPS. Requests and responses are JSON, except when you are uploading a file.

Every path in this reference is relative to the base URL:

https://nextgenpanel.cloudshope.com/api/v1

Your first request

List the SMS campaigns on your account:

curl https://nextgenpanel.cloudshope.com/api/v1/sms/campaigns \
  -H "Authorization: Bearer cs_live_your_token_here"

Every endpoint requires an Authorization header. See Authentication for how to create a token.

Responses

A single resource is returned as a bare JSON object. A collection is wrapped in a `data` array with a `page` object beside it:

{
  "data": [ { "id": 1204, "campaign_name": "Diwali offer", "status": "Delivered" } ],
  "page": { "next_cursor": null, "has_more": false }
}

Errors are returned as `application/problem+json`. See Errors for the shape and the status codes.

Your account

The token identifies the account. You never pass an account id, user id or owner in the request body — the API scopes every read and write to the token's account on its own. A parameter like `workspaceId` selects something *within* your account; it can never reach another account's data.