Introduction
The ParrotPoster GraphQL API lets you automate publishing to social networks, manage posts, and list connected accounts from your scripts, websites, and services.
Overview
The API is built on GraphQL: you request only the fields you need and get them in a single request. The ParrotPoster web app and the WordPress and 1C-Bitrix plugins use the same API.
API endpoint:
https://parrotposter.com/api/graphql
- POST request runs queries (
query) and mutations (mutation). The body is JSON with aqueryfield (andvariablesif needed). This is how you should call the API from code. - GET request opens the interactive GraphiQL environment (playground) in the browser: you can see the full schema and try queries by hand.
What you can do with the API
- list connected accounts and their state;
- create, get, update, and delete posts;
- publish immediately, on a schedule, or save as a draft;
- read publishing results and engagement statistics.
Connecting social accounts and configuring automation is done in the web app: it is not available through the API.
How to start
- In the web app open Settings → API tokens and create a token (details).
- Send the token in the
Authorization: Bearer <token>header. - Make your first request — see Quick start.
Limits
- Publishing and changing posts require an active plan, and the number of posts and accounts is limited by your plan.
- Requests made with an API token are rate limited: by default 600 requests per minute per token. When exceeded, the server responds with HTTP status
429. See Errors.
Compatibility
The API schema is extended with new fields and methods. Deprecated fields are marked with the @deprecated directive in the schema (visible in the playground), so request only the fields you need and do not rely on the order of fields in a response.
Contents
- Quick start — your first request in 5 minutes
- Authentication — API tokens and the
loginmutation - Social accounts —
listSocialAccounts - Posts — overview, Post object, getting and listing, creating, updating, deleting
- Errors — error format, codes, limits
