Getting Started with the Vibe API Reference

Use this guide to make your first authenticated request to the Vibe API in five minutes.

How the Reference is organized

The Reference is grouped into three products:

Vibe Developer Platform API — the OAuth-authenticated REST API for building integrations on top of Vibe. All Account, Advertiser, Campaign, Strategy, Creative, Audience, Reporting, Impression Tracker, and Reference Data endpoints live here.

What every Developer Platform request needs

Authorization: Bearer {access_token} — see OAuth.
X-Vibe-Revision: 2026-05 (or your pinned revision) — see API Versioning.
Content-Type: application/json for requests with a body.

What you'll need

A Vibe account. Sign up at vibe.co or sign in if you already have one.
An OAuth client. In the Vibe dashboard, open My Applications, click Create app, fill in your app name, redirect URIs, requested scopes, and grant types. Once created, your client_id and client_secret are issued in the portal — copy the secret immediately, you will not be able to see it again. Your credentials can be used only on your account unless the application is reviewed and approved by Vibe (manual process).

Note: app approval is manual at launch. Dynamic Client Registration (RFC 7591) is not supported in v1.

If you don't yet see My Applications in your dashboard menu, the Developer Portal is currently behind a feature flag — contact your Vibe partner manager to have it enabled on your account.
A REST client. We use curl in these examples; any HTTP client works.

For the full OAuth walkthrough, see Start your OAuth flow.

Step 2 — Make your first call

Every Vibe API call needs two headers:

Authorization: Bearer {'<access_token>'} — the token from Step 1.
- X-Vibe-Revision: 2026-05 — pins the request to a specific API revision. We strongly recommend pinning in production. See Required headers and scopes.
  
  List the accounts your token can see:
```
curl https://api.vibe.co/accounts \
  -H "Authorization: Bearer $VIBE_ACCESS_TOKEN" \
  -H "X-Vibe-Revision: 2026-05"
```
  You should see one or more accounts. Grab an account_id — you'll use it to scope the next call.

Step 3 — Create your first advertiser

curl -X POST https://api.vibe.co/advertisers \
  -H "Authorization: Bearer $VIBE_ACCESS_TOKEN" \
  -H "X-Vibe-Revision: 2026-05" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Co.",
    "url": "https://acme.example.com",
    "industry": "retail"
  }'

A 201 Created response returns the new advertiser, including the advertiser_id UUID. You'll use that ID on every campaign, strategy, creative, and audience you create under this advertiser.

Where to go next

OAuth — full OAuth2 reference, scope table, and revision policy.
- Required headers and scopes — shared request headers, OAuth scopes, and authorization error responses.
  - Create a campaign — once you have an advertiser, this is the next call most partners make.