Browse all guides
All guides
REST API

REST API overview

Learn when to use the Tartol REST API, how access works, and where to find the complete reference.

4 min readUpdated August 27, 2026

Quick visual guide

Create a scoped key in Settings, then follow the REST quickstart.

  1. 1

    Open Integrations

    Go to Settings > Integrations and find Integration API keys.

    Settings Integrations API key sectionAPI keys
  2. 2

    Create a key

    Choose Create API key. Name it, choose its workspace and expiration, and grant only needed permissions.

    Create API key dialogSet key access
  3. 3

    Use the quickstart

    Open View API docs and copy the request pattern from REST API reference.

    REST API reference quickstartQuickstart

Red labels show the exact control to use.

Detailed referenceOpen this for definitions, limits, examples, and troubleshooting.

What the REST API is for

Use the REST API to read Tartol data and run supported workflows from a backend, scheduled job, data pipeline, or custom application. It uses standard HTTPS requests and JSON responses.

Use caseExamples
ResearchSearch, filter, and retrieve ads, brands, products, and saved items.
Workspace automationManage supported records, collections, media, and workspace workflows.
Creative generationStart image or copy generation and poll for the result.

Access requirements

  • An active Pro or Agency workspace for REST API access.
  • A workspace-bound API key for REST requests.
  • Permission to access the requested workspace data or action.

Production endpoint

Base URL
https://tartol.com/api/v1

Continue with the API guides

REST API referenceUse endpoints, examples, errors, and the OpenAPI document.Create an API keyCreate a scoped credential for a server-side integration.

Keep learning

Tartol REST API referenceRead guide Create and use an integration API keyRead guide Connect an AI client with MCPRead guide

Still need help?

Tell us what you were trying to do and what happened.

Contact support
Last updated August 27, 2026