API Reference

The Sailup API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication. All endpoints are served under the /v1 base path.

Getting Started

Base URL

All API requests are made to the following base URL. Append the endpoint path to this URL for every request. Note that resource paths end with a trailing slash.

Base URL

https://api.sailup.io/v1

Authentication

The Sailup API authenticates requests with a project API key. You can manage your API keys in the Developer Settings section of your dashboard. Each key is scoped to a single project, so requests are automatically associated with the right project — no project ID is needed in the URL.

Include your API key in the Authorization header as a Bearer token. Every key is prefixed with sailup_. Requests without a valid key return 401 Unauthorized.

Example Header

Authorization: Bearer sailup_a1b2c3d4e5f6g7h8

Pagination

List endpoints return results in a paginated envelope. Control the page with the page and page_size query parameters.

pageinteger

Page number to return. Defaults to 1.

page_sizeinteger

Number of results per page. Defaults to 30, with a maximum of 1000.

count is the total number of records. next and previous are fully-qualified URLs for the adjacent pages, or null when there is no such page.

Paginated Response

{
  "count": 42,
  "next": "https://api.sailup.io/v1/contacts/?page=2",
  "previous": null,
  "results": []
}

Reference

Every endpoint, grouped by the resource it acts on.

SMS APISend an SMS to any MTN, Telecel, or AirtelTigo number in Ghana with a single POST request, then list and inspect messages to track their delivery status.Credits APICheck how many SMS credits a project has left and whether auto top-up is switched on. One authenticated GET request returns both.Contacts APICreate, read, update and delete the people you message, or bulk upsert them in a single request. Contacts can be grouped into lists for targeted campaigns.Lists APIGroup contacts into lists to organize segments and target messaging campaigns. Create lists, add and remove contacts, and read a list's membership.WebhooksReceive a signed POST the moment an SMS reaches a terminal delivery outcome, instead of polling. Covers event types, payloads, signature verification and retries.