Publer API

https://publer.com/docs
Admin
Publer API is a RESTful JSON interface for automating social media workflows including scheduling,...
Tokens:121,241
Snippets:832
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET Request Example with Query Parameters

Source: https://publer.com/docs/api-reference/introduction.md

Use query parameters for filtering and pagination in GET requests.

```http
GET /posts?state=scheduled&from=2025-04-20
```

--------------------------------

### API Query Example for Documentation

Source: https://publer.com/docs/posting/create-posts/content-types/platform-specific-formats/twitter-x-community-posts.md

When information is not directly on the page, use this GET request format with 'ask' and optional 'goal' parameters to query the documentation dynamically.

```http
GET https://publer.com/docs/posting/create-posts/content-types/platform-specific-formats/twitter-x-community-posts.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://publer.com/docs/posting/create-posts/content-types/post-with-location.md

Use this method to ask questions about the documentation dynamically. Include the 'ask' parameter for your specific question and optionally the 'goal' parameter to guide the response.

```http
GET https://publer.com/docs/posting/create-posts/content-types/post-with-location.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Full Post Callback Example

Source: https://publer.com/docs/posting/create-posts/content-types/post-callbacks.md

This JSON object demonstrates a comprehensive example of scheduling a post with various callback configurations, including auto-sharing, follow-up comments, and auto-deletion with specific conditions.

```json
{
  "bulk": {
    "state": "scheduled",
    "posts": [
      {
        "networks": {
          "facebook": {
            "type": "status",
            "text": "Post with callbacks"
          }
        },
        "accounts": [
          {
            "id": "63c675b54e299e9cf2b667ea",
            "scheduled_at": "2025-10-31T10:23+01:00",
            "share": {
              "account_ids": [
                "63c675b54e299e9cf2b667e8"
              ],
              "conditions": {
                "relation": "AND",
                "clauses": {
                  "age": {
                    "duration": 10,
                    "unit": "Minute"
                  },
                  "engagements": {
                    "comparison": "gt",
                    "value": 10
                  },
                  "reach": {
                    "comparison": "gt",
                    "value": 100
                  }
                }
              },
              "text": "AUTO SHARE"
            },
            "comments": [
              {
                "text": "FOLLOW UP COMMENT",
                "conditions": {
                  "relation": "AND",
                  "clauses": {
                    "age": {
                      "duration": 10,
                      "unit": "Minute"
                    },
                    "engagements": {
                      "comparison": "gt",
                      "value": 10
                    },
                    "reach": {
                      "comparison": "gt",
                      "value": 100
                    }
                  }
                }
              },
              {
                "text": "OTHER COMMENT",
                "conditions": {
                  "relation": "AND",
                  "clauses": {
                    "age": {
                      "duration": 10,
                      "unit": "Minute"
                    }
                  }
                }
              }
            ],
            "delete": {
              "conditions": {
                "clauses": {
                  "age": {
                    "duration": 1,
                    "unit": "Hour"
                  }
                }
              },
              "hide": false
            }
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Query Documentation with GET Request

Source: https://publer.com/docs/posting/update-posts.md

Perform an HTTP GET request to query documentation dynamically. Use the `ask` parameter for specific questions and the optional `goal` parameter for broader context.

```http
GET https://publer.com/docs/posting/update-posts.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://publer.com/docs/posting/create-posts/content-types/platform-specific-formats/linkedin-pdf-carousels.md

Perform an HTTP GET request to query the documentation dynamically. Include the 'ask' parameter for your question and optionally the 'goal' parameter for broader context. The response will contain a direct answer and relevant excerpts.

```http
GET https://publer.com/docs/posting/create-posts/content-types/platform-specific-formats/linkedin-pdf-carousels.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://publer.com/docs/posting/create-posts/content-types/platform-specific-formats/twitter-x-long-form-posts.md

Perform an HTTP GET request to query the documentation. Use the 'ask' parameter for specific questions and the optional 'goal' parameter for broader context.

```http
GET https://publer.com/docs/posting/create-posts/content-types/platform-specific-formats/twitter-x-long-form-posts.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://publer.com/docs/analytics/members.md

Perform an HTTP GET request to query documentation dynamically. Use the 'ask' parameter for specific questions and the optional 'goal' parameter for broader context. The response includes an answer and relevant sources.

```http
GET https://publer.com/docs/analytics/members.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://publer.com/docs/api-reference/workspaces.md

Perform an HTTP GET request to query documentation dynamically. Use the 'ask' parameter for specific questions and the optional 'goal' parameter to tailor the response to a broader objective. This is useful when information is not explicitly present on the current page.

```http
GET https://publer.com/docs/api-reference/workspaces.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://publer.com/docs/posting/create-posts/content-types/post-with-signature.md

Perform an HTTP GET request to query the documentation. Use the 'ask' parameter for specific questions and the optional 'goal' parameter to define the broader objective.

```http
GET https://publer.com/docs/posting/create-posts/content-types/post-with-signature.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://publer.com/docs/posting/create-posts/publishing-methods/manual-scheduling.md

To get additional information not directly on the page, perform an HTTP GET request with `ask` and optional `goal` query parameters.

```http
GET https://publer.com/docs/posting/create-posts/publishing-methods/manual-scheduling.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://publer.com/docs/posting/create-posts/content-types/platform-specific-formats/pinterest-pins-with-a-link-url.md

Use this GET request to query the documentation dynamically when information is not explicitly present on the current page. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://publer.com/docs/posting/create-posts/content-types/platform-specific-formats/pinterest-pins-with-a-link-url.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /docs/getting-started.md

Source: https://publer.com/docs/getting-started

Performs a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /docs/getting-started.md

### Description
Performs a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a specific question and optional goal.

### Method
GET

### Endpoint
https://publer.com/docs/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Reading Post Labels

Source: https://publer.com/docs/posting/create-posts/post-labels.md

Example response from the GET /api/v1/posts endpoint showing the labels array for a post.

```json5
{
  "posts": [
    {
      "id": "68176f0e8bee9dc9b0ce3427",
      "state": "scheduled",
      "type": "status",
      "text": "Check out our latest product!",
      "account_id": "66db83154e299efa19a2d8eb",
      "scheduled_at": "2025-05-15T14:30:00.000+02:00",
      "labels": [
        {
          "id": "6937e35e9823a2eeecfa378f",
          "name": "Product Launch",
          "color": "#84FFBF"
        },
        {
          "id": "69f327eb912f8d1e7e0bc7f0",
          "name": "Q2 Campaign",
          "color": "#87C7F6"
        }
      ]
    }
  ],
  "total": 1
}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://publer.com/docs/posting/create-posts/networks.md

Perform an HTTP GET request to query the documentation. Use the `ask` parameter for specific questions and the optional `goal` parameter to guide the AI towards a broader objective.

```http
GET https://publer.com/docs/posting/create-posts/networks.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with Parameters

Source: https://publer.com/docs/posting/create-posts/media-handling.md

Use this GET request to query the documentation dynamically. Include your question in the 'ask' parameter and optionally specify your broader goal in the 'goal' parameter.

```http
GET https://publer.com/docs/posting/create-posts/media-handling.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Recycling with Expiration Date Example

Source: https://publer.com/docs/posting/create-posts/publishing-methods/recycling-posts.md

Schedule a post to be recycled monthly starting from a specific date until a defined expiration date. This is useful for time-bound campaigns.

```json
{
  "bulk": {
    "state": "scheduled",
    "posts": [{
      "networks": {
        "default": { "type": "status", "text": "Monthly promotion reminder!" }
      },
      "accounts": [{ "id": "66f509f7db2797026a37ba76" }],
      "recycling": {
        "gap": 1,
        "gap_freq": "Month",
        "start_date": "2025-06-01",
        "expire_date": "2025-12-31"
      }
    }]
  }
}
```

--------------------------------

### Error Response Example

Source: https://publer.com/docs/api-reference/introduction.md

Example of an error response body.

```APIDOC
{
  "errors": ["Detailed error message"]
}
```

--------------------------------

### Querying Documentation Dynamically

Source: https://publer.com/docs/api-reference/introduction.md

Use this GET request with 'ask' and optional 'goal' parameters to query the documentation dynamically.

```http
GET https://publer.com/docs/api-reference/introduction.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Date & Time Example

Source: https://publer.com/docs/api-reference/introduction.md

An example of a timestamp in the required ISO 8601 format.

```text
2025-05-04T14:58:35+00:00
```

--------------------------------

### Dynamic Documentation Query

Source: https://publer.com/docs/posting/create-posts/content-types/polls.md

Use this GET request to query the documentation dynamically. Include your specific question in the `ask` parameter and an optional broader goal in the `goal` parameter to tailor the response.

```http
GET https://publer.com/docs/posting/create-posts/content-types/polls.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Job Status Response Example

Source: https://publer.com/docs/api-reference/introduction.md

This is an example of a completed job status response.

```json
{
  "status": "completed",
  "payload": { "failures": {} }
}
```

--------------------------------

### Auto-Scheduling Request Example

Source: https://publer.com/docs/posting/create-posts/publishing-methods.md

A JSON request body example for enabling auto-scheduling on a post.

```json
{
  "bulk": {
    "state": "scheduled",
    "posts": [
      {
        "networks": {
          "facebook": {
            "type": "status",
            "text": "Autoschedule post"
          }
        },
        "accounts": [
          {
            "id": "66f509f7db2797026a37ba76"
          }
        ],
        "share_next": false,
        "range": {
          "start_date": "2025-05-23T07:45:00.000Z",
          "end_date": "2025-05-31T07:45:00.000Z"
        },
        "auto": true
      }
    ]
  }
}
```

--------------------------------

### Recurring Parameter Examples

Source: https://publer.com/docs/posting/create-posts/publishing-methods/recurring-posts.md

Examples of specific parameter values used in the recurring configuration.

```text
2025-06-05T13:29+02:00
```

```text
2025-07-21T13:29+02:00
```

```text
"weekly"
```

```text
6
```

```text
[0,4]
```

--------------------------------

### Query Documentation Dynamically

Source: https://publer.com/docs/api-reference/accounts.md

Perform an HTTP GET request to query the documentation. Use the 'ask' parameter for your specific question and optionally the 'goal' parameter to tailor the response.

```http
GET https://publer.com/docs/api-reference/accounts.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://publer.com/docs/api-reference/posts.md

Perform an HTTP GET request to query the documentation. Use the 'ask' parameter for your specific question and optionally the 'goal' parameter to tailor the response.

```http
GET https://publer.com/docs/api-reference/posts.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Recycling Content Request Example

Source: https://publer.com/docs/posting/create-posts/publishing-methods.md

A JSON request body example for configuring content recycling parameters.

```json
{
  "bulk": {
    "state": "scheduled",
    "posts": [
      {
        "networks": {
          "default": {
            "type": "status",
            "text": "This content will be recycled multiple times"
          }
        },
        "accounts": [
          {
            "id": "66f509f7db2797026a37ba76",
            "labels": [""]
          }
        ],
        "range": {
          "start_date": "2025-05-23T07:45:00.000Z",
          "end_date": null
        },
        "recycling": {
          "solo": true,
          "gap": 2,
          "gap_freq": "Week",
          "start_date": "2025-06-01",
          "expire_count": "3",
          "expire_date": "2025-07-15"
        }
      }
    ]
  }
}
```

--------------------------------

### Query Documentation Index via HTTP GET

Source: https://publer.com/docs/llms.txt

Use this method to ask specific questions about the documentation. The `ask` parameter is required for your query, and the optional `goal` parameter helps tailor the response. The response includes direct answers, excerpts, and sources.

```http
GET https://publer.com/docs/analytics/best-times-to-post.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Get Current User Endpoint

Source: https://publer.com/docs/api-reference/users.md

The HTTP GET request to retrieve information about the currently authenticated user.

```http
GET /api/v1/users/me
```

--------------------------------

### Query Documentation Dynamically

Source: https://publer.com/docs/getting-started/rate-limits.md

Perform an HTTP GET request to the current page URL with the `ask` query parameter for specific questions and an optional `goal` parameter for broader objectives. The response includes a direct answer, relevant excerpts, and sources.

```http
GET https://publer.com/docs/getting-started/rate-limits.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://publer.com/docs/api-reference

To get information not directly on a page, make a GET request to the page URL with the `ask` parameter for your question and an optional `goal` parameter for the end objective. The response includes an answer and relevant documentation excerpts.

```http
GET https://publer.com/docs/api-reference.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Sample cURL Request for Immediate Publishing

Source: https://publer.com/docs/posting/create-posts/publishing-methods/immediate-publishing.md

This sample demonstrates how to make a cURL request to publish a post immediately. Replace placeholders with your actual API key, workspace ID, and account ID.

```bash
curl -X POST https://app.publer.com/api/v1/posts/schedule/publish \
  -H "Authorization: Bearer-API YOUR_API_KEY" \
  -H "Publer-Workspace-Id: YOUR_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "bulk": {
      "state": "scheduled",
      "posts": [
        {
          "networks": {
            "facebook": {
              "type": "status",
              "text": "Just published this update via the Publer API! #RealTimePosting"
            }
          },
          "accounts": [
            { "id": "66db83154e299efa19a2d8eb" }
          ]
        }
      ]
    }
  }'
```

--------------------------------

### Job Status Response Example

Source: https://publer.com/docs/posting/create-posts.md

Provides an example of the JSON response when polling for job status, indicating the current state and payload.

```json
{
  "status": "working|completed|failed",
  "payload": { /* results or errors */ }
}
```

--------------------------------

### Query Documentation with GET Request

Source: https://publer.com/docs/analytics

Use this endpoint to ask questions about the documentation dynamically. Include your question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://publer.com/docs/analytics.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Threads Location Object Example

Source: https://publer.com/docs/posting/create-posts/content-types/post-with-location.md

This is an example of a Threads location object that can be returned from the search endpoint. Note that 'verified' might be present.

```json
{
  "id": "308281375929281",
  "name": "Tirana",
  "info": "Tirana, Albania ⋅ 590 follow this",
  "verified": true
}
```

--------------------------------

### TikTok Video Post Example

Source: https://publer.com/docs/posting/create-posts/networks.md

Example for posting a video to TikTok. Requires a business account and a video ID. Captions are limited to 2,200 characters.

```json
{
  "tiktok": {
    "type": "video",
    "text": "Caption with #hashtags #fyp",
    "media": [{"id": "video_id", "type": "video"}]
  }
}
```

--------------------------------

### Pinterest Pin Example

Source: https://publer.com/docs/posting/create-posts/networks.md

Example for creating a photo pin on Pinterest. Requires a board ID and media object. Descriptions are limited to 500 characters.

```json
{
  "pinterest": {
    "type": "photo",
    "text": "Pin description with #hashtags",
    "board_id": "board_id_here",
    "media": [{"id": "media_id", "type": "image"}]
  }
}
```

--------------------------------

### Twitter/X Status Post Example

Source: https://publer.com/docs/posting/create-posts/networks.md

Example of a concise Twitter/X status update. Hashtags and @mentions count towards the character limit, and media attachments do not.

```json
{
  "twitter": {
    "type": "status",
    "text": "Concise Twitter post with #hashtags and @mentions"
  }
}
```
Tokens:
Raw