Get started

API integration

Your content data.
In your own tools.

Bring Postomatic’s brand knowledge, content records and search evidence into your own dashboards and workflows. Build around the way your team works.

Open API Keys Explore the API

For workspaces with enabled API access.

API v1 / Build with your data
Postomatic
Brand knowledgeContent recordsSearch evidence
Your dashboardYour view of the work
Your workflowYour code. Your tools.
Brand-scoped access

Explore a resource

A familiar request.
Your content context.

Choose a resource to see its request, required scope and some of the information it makes available.

GET Brand collection

Start with the brands you can access.

List the active brands granted to your credential. Use a returned brand ID when requesting that brand’s content.

brands:read
Includes
nameslugwebsiteUrl
Request
curl --request GET "https://app.postomatic.co/api/v1/brands" \
  --header "Authorization: Bearer YOUR_ONE_TIME_API_KEY"

Use your own credential. Replace YOUR_BRAND_ID with a granted brand ID for brand-specific requests.

Build your own view

Useful data.
More ways to use it.

Keep your own interface and reporting tools connected to the work in Postomatic.

Work with structured records.

Read article titles, addresses, content types and publication metadata. Bring Brand Brain summaries and ranked opportunities into the tools that need them.

Bring the calendar into view.

Use planned titles, local dates, scheduled times and recorded status to build a view that fits your team’s workflow.

Connect your reporting.

Read publishing outcomes alongside available Search Console evidence. Keep publication state and observed performance distinct in your own reporting.

Give each tool the access it needs.

Issue scoped credentials for explicitly granted brands. Rotate or revoke keys from Developer Centre as your integrations change.

Start with a scoped key

A clear first request.
A useful next step.

Use the current v1 contract and give your integration access to the resources it needs.

  1. 01

    Open API Keys.

    An owner or administrator can create a key when the workspace has enabled API access.

  2. 02

    Choose the access.

    Select the scopes and brands. Store the one-time credential securely in your application.

  3. 03

    Read your first resource.

    Send the bearer credential with the request. Use the brand IDs returned by the granted-brands endpoint.

A contract to build against

Versioned.
Scoped. Traceable.

Versioned responses.

Schema information and request IDs give your integration a consistent response contract.

schemaVersion · requestId

Bounded collections.

Use the returned cursor on supported collections to read the next page.

page.nextCursor

Clear request controls.

Handle versioned errors and rate limits, and review recorded integration activity.

error.code · X-Request-Id

Your API questions

Know what
you’re building with.

What information can I access through the API?

The v1 API provides scoped reads for granted brands, Brand Brain summaries, ranked opportunities, calendar entries, article records, publishing outcomes, available performance evidence and integration audit events. The article endpoint returns records and metadata rather than a documented full-body export.

Can I create or publish articles with the API?

The current API does not provide article creation, editing, calendar overrides or content publishing endpoints. Its one bounded mutation replays the saved result of an existing verified connection test without creating another external effect. Normal content production and publishing remain in the product workflow.

How do I get an API key?

An owner or administrator can create a key from Developer Centre’s API Keys tab when the workspace has current plan entitlement and enabled API access. Choose only the scopes and brands your integration needs. The key is shown once and can be rotated or revoked.

How do pagination, limits and errors work?

Supported collections accept a limit and an opaque cursor, and return page.nextCursor when another page is available. Responses include request and rate-limit metadata. Handle 429 responses, respect your workspace allowance and use the versioned error code and request ID when diagnosing a failed request.

How is the API different from MCP?

Use the HTTP API when your own application or script makes requests directly. MCP exposes supported Postomatic tools to a compatible AI client. Both use scoped credentials and brand grants; choose the interface that fits the tool you are building.

Where do I find the full contract or connect a custom website?

Retrieve /api/v1/openapi.json with an authorised credential for the current v1 paths and required scopes. Sending finished articles to a custom website uses a separate publishing connection. The API read examples on this page do not set up that delivery connection.

Build with your context

Your tools.
More connected to your content.

Check API availability and create your scoped key in Developer Centre.

Open API Keys Compare plans