Vista Social API

The Vista Social API lets you read and write Vista Social data from your own systems. Pull profile and post analytics into a BI tool, push drafts in from the place your team already plans content, run community management from a custom console, or wire Vista Social into an internal workflow.

The full reference, with every endpoint, every field, and copy-paste examples, lives at vistasocial.com/api-docs.

Availability: The API is included with Enterprise plans and with the API add-on. If your plan doesn't include it, talk to your Customer Success Manager and we'll get it switched on.

This API replaces Vista Social API 1.0. API 2.0 is the current, documented REST API. If you still call API 1.0, switch now. All remaining 1.0 usage must move to 2.0 by November 1, 2026. The previous docs host at apidocs.vistasocial.com now redirects here.

The short version

• Base URL: https://api.vistasocial.com
• Every endpoint is a POST with a JSON body. There are no path parameters and no query strings to build.
• Authenticate with your workspace API key in the x-api-key header.
• 76 endpoints covering publishing, analytics, inbox, tasks, trends, team management, and Vista Pages.
• Every response uses the same envelope, so error handling is written once.

Get your API key

1. Go to Settings → Integrations in Vista Social.
2. Find the Vista Social API card and generate a key.
3. Copy it somewhere safe. Generating a new key deactivates the old one.

Only account managers can generate an API key. The key is scoped to your whole workspace, so it can see and change everything the workspace can. Treat it like a password: keep it server side, never ship it in a mobile app or browser bundle.

Your first call

POST /v2/me confirms which account a key belongs to. It's the quickest way to prove your setup works.

curl -X POST https://api.vistasocial.com/v2/me \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "ok": true,
  "data": {
    "name": "Jordan Reyes",
    "email": "jordan@example.com"
  }
}

From there, POST /v2/profiles/search gives you the profile IDs that most other endpoints take as input.

What you can do

Reading data

Analytics endpoints return the same numbers you see in the Social Media Performance Report and the Post Performance Report, so a custom dashboard and the in-app report always agree.

POST /v2/reports/profile-metrics is the workhorse. Give it profile IDs and a date range and it returns daily followers, reach, impressions, and engagement:

curl -X POST https://api.vistasocial.com/v2/reports/profile-metrics \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "profile_ids": [12345], "from_date": "2026-06-01", "to_date": "2026-06-30" }'

Rows come back in a columnar shape (a columns array plus a rows array) with a summary block of totals, which keeps large date ranges small enough to move quickly.

Writing data

POST /v2/posts/save drafts, schedules, or edits a post across one or more profiles. POST /v2/media/create uploads images, video, and GIFs into your library. POST /v2/ideas/save and POST /v2/calendar/notes/create cover the planning side. Inbox actions, task updates, and teammate management are all writable too.

How responses are shaped

Success:

{ "ok": true, "data": { } }

Failure:

{ "ok": false, "error": { "code": "unauthorized", "message": "Invalid API key" } }

Check ok before reading data. A failed call still returns HTTP-level status codes, so you can branch on either.

Rate limits

The API allows 60 requests per minute per integration. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset so you always know where you stand, and a 429 comes back with Retry-After.

Enterprise workspaces can have the cap raised. See Understanding Vista Social API rate limits for the full picture.

Connecting an AI assistant? Use MCP instead

If your goal is to let Claude, ChatGPT, or Cursor work inside Vista Social, you probably don't need to write REST code at all. Our MCP server exposes these same capabilities as tools the assistant discovers and calls on its own.

See Connect your AI assistant to Vista Social.

For no-code automation, the Zapier, Make, and n8n integrations cover common triggers and actions without any API work.

Ideas to steal

• Backstage dashboards. A music festival pulls engagement for artist posts every few minutes and puts it on screens for the crew.
• On-brand reporting. An agency collects profile and post data and renders it into their own report template instead of ours.
• Custom KPIs. A fitness chain blends shares, comments, and clicks into one "community engagement" score to review team performance.
• Content handoff. A marketing team drafts in their project tool and pushes drafts into Vista Social for approval and scheduling.
• Benchmark alerting. A brand pulls industry benchmarks weekly and pings Slack when its engagement percentile drops.

What the API doesn't cover

• Paid ads reporting. You can list boost configurations for a profile, but ad spend and ad performance aren't exposed.
• Competitor analysis reports.
• Billing, subscription, and plan management.
• X (Twitter) content data beyond what X's API terms permit.

Common questions

Is there a sandbox?

No. Calls hit your live workspace. Test writes against a profile group you don't publish from, or use draft status on posts.

Can I scope a key to one profile group?

Not today. Keys carry full workspace access. If you need narrower access, run your integration through a Vista Social user account whose own permissions are limited.

How do I page through large result sets?

There's no single cursor convention. Most list and search endpoints take a limit in the body, and some also take an offset. The reference shows exactly which fields each one accepts. Where a response includes a meta block, read the totals from there rather than counting the rows you got back, because the page returned is often smaller than the full match count.

In practice, filters do more work than paging. Narrowing by profile, date range, or status is usually faster than walking a big result set.

What happened to API 1.0?

API 2.0 completely replaces API 1.0. 1.0 is still reachable for existing integrations, but it is no longer published or documented, and we are not adding to it. Switch to the endpoints in this article. Every workspace must be on API 2.0 by November 1, 2026. After that date, 1.0 will no longer be supported.

Bookmarks to apidocs.vistasocial.com now redirect to vistasocial.com/api-docs.

Is the reference always current?

Yes. The spec at vistasocial.com/api-docs is generated from the live platform catalog on every release, so it can't drift from what the API actually does. The raw OpenAPI document is at vistasocial.com/openapi.json if you want to generate a client.

Need further help?

If you have any questions or need additional help, feel free to contact our awesome support team. We are here to assist you! 💙