Get started with the API

The ApyConnect API lets you build on top of your workspace: contacts, conversations, multichannel messaging, campaigns, analytics, and webhooks. Base URL: https://api.apyconnect.io.

OpenAPI spec

The full 3.1 spec (same one that powers the Reference tab).

Download Postman

Collection ready to import into Postman/Insomnia.

1. Create an Application

Under Settings → API, create an Application. You’ll get a client_id and a client_secret (the secret is shown only once). Pick the scopes it will need.

2. Get an access token

Tokens are short-lived opaque Bearer tokens (~1 h), issued with the client_credentials grant:

curl -X POST https://api.apyconnect.io/oauth/token \
  -u "$CLIENT_ID:$CLIENT_SECRET" \
  -d grant_type=client_credentials

{ "access_token": "at_live_…", "token_type": "Bearer", "expires_in": 3600 }

Scopes aren’t requested here — the token inherits its Application’s scopes. Check them at GET /v1/me.

3. Make your first call

curl https://api.apyconnect.io/v1/contacts \
  -H "Authorization: Bearer $TOKEN"

Every response is wrapped and carries a request_id for support:

{
  "object": "list",
  "data": [ { "object": "contact", "id": "per_…", "name": "Ada Lovelace", "email": "ada@example.com" } ],
  "pagination": { "next_cursor": "…", "has_more": true, "limit": 25 },
  "meta": { "request_id": "req_…" }
}

Introduction

Reference

Get started with the API

OpenAPI spec

Download Postman

1. Create an Application

2. Get an access token

3. Make your first call

Next

OpenAPI spec

Download Postman

​1. Create an Application

​2. Get an access token

​3. Make your first call

​Next

1. Create an Application

2. Get an access token

3. Make your first call

Next