PostSyncer

https://docs.postsyncer.com
Admin
PostSyncer is a REST API that automates social media posting across 10+ platforms including Twitter,...
Tokens:70,686
Snippets:469
Trust Score:8.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example API Request with cURL

Source: https://docs.postsyncer.com/essentials/authentication

This example demonstrates how to make a GET request to retrieve workspaces, including the necessary Authorization and Content-Type headers.

```bash
curl -X GET "https://postsyncer.com/api/v1/workspaces" \
  -H "Authorization: Bearer 11|HzNfjB..." \
  -H "Content-Type: application/json"
```

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

### Example API Request with JavaScript

Source: https://docs.postsyncer.com/essentials/authentication

This example shows how to make a GET request to retrieve workspaces using the `fetch` API in JavaScript, including the Authorization and Content-Type headers.

```javascript
const response = await fetch('https://postsyncer.com/api/v1/workspaces', {
  headers: {
    'Authorization': 'Bearer 11|HzNfjB...',
    'Content-Type': 'application/json'
  }
});
```

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

### Example API Request with Python

Source: https://docs.postsyncer.com/essentials/authentication

This example demonstrates how to make a GET request to retrieve workspaces using the `requests` library in Python, including the Authorization and Content-Type headers.

```python
import requests

headers = {
    'Authorization': 'Bearer 11|HzNfjB...',
    'Content-Type': 'application/json'
}

response = requests.get('https://postsyncer.com/api/v1/workspaces', headers=headers)
```

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

### List Workspaces (Node.js)

Source: https://docs.postsyncer.com/api-reference/workspaces/list

This Node.js example uses the axios library to fetch workspaces. It logs the workspaces or any errors encountered. Make sure to install axios: `npm install axios`.

```javascript
const axios = require('axios');

const getWorkspaces = async () => {
  try {
    const response = await axios.get('https://postsyncer.com/api/v1/workspaces', {
      headers: {
        'Authorization': 'Bearer YOUR_API_TOKEN'
      }
    });
    
    console.log('Workspaces:', response.data);
    return response.data;
  } catch (error) {
    console.error('Error fetching workspaces:', error.response?.data || error.message);
  }
};

getWorkspaces();
```

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

### Example API Request with PHP

Source: https://docs.postsyncer.com/essentials/authentication

This example shows how to make a GET request to retrieve workspaces using cURL in PHP, including the Authorization and Content-Type headers. It also includes basic error handling.

```php
$headers = [
    'Authorization: Bearer 11|HzNfjB...',
    'Content-Type: application/json',
];

$ch = curl_init('https://postsyncer.com/api/v1/workspaces');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error: ' . curl_error($ch);
} else {
    $data = json_decode($response, true);
    print_r($data);
}

curl_close($ch);
```

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

### Create Post Request Example

Source: https://docs.postsyncer.com/api-reference/posts/create

This example demonstrates how to structure a request to create a post, including scheduling, content, and account-specific settings.

```json
{
    "workspace_id": 12,
    "labels": [
        5
    ],
    "content": [
        {
            "text": "Post Once. Publissh everywhere",
            "media": [
                "https://postsyncer.com/images/og/banner.png?v2"
            ]
        }
    ],
    "schedule_type": "schedule",
    "schedule_for": {
        "date": "2025-07-05",
        "time": "23:00",
        "timezone": "Africa/Addis_Ababa"
    },
    "accounts": [
        {
            "id": 136,
            "settings": {
                "for_super_followers_only": false,
                "reply_settings": "everyone",
                "quote_tweet_id": null,
                "reply": {
                    "in_reply_to_tweet_id": null
                },
                "community_id": null,
                "share_with_followers": true,
                "text": null
            }
        }
    ]
}
```

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

### Response Example for Get Posts

Source: https://docs.postsyncer.com/api-reference/posts/get

This example shows the structure of a successful response when retrieving posts. It includes post details, poll status, and analytics.

```json
{
    "poll": {
        "enabled": false
    }
},
"analytics": {
    "comments": 8,
    "likes": 42,
    "shares": 8,
    "impressions": 1250,
    "quotes": 2,
    "saves": 12,
    "engagement_rate": 4.4
}
}
],
"auto_plug": null,
"comments": []
}
```

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

### Fetch a Post with Comments using Node.js (Axios)

Source: https://docs.postsyncer.com/api-reference/posts/get

This Node.js example uses the Axios library to fetch a post. Ensure you have Axios installed (`npm install axios`). Replace `YOUR_API_TOKEN` with your actual token and `123` with the desired post ID.

```javascript
const axios = require('axios');

const getPost = async (postId) => {
  try {
    const response = await axios.get(`https://postsyncer.com/api/v1/posts/${postId}`, {
      headers: {
        'Authorization': 'Bearer YOUR_API_TOKEN'
      }
    });
    
    console.log('Post:', response.data);
    return response.data;
  } catch (error) {
    console.error('Error fetching post:', error.response?.data || error.message);
  }
};

getPost(123);
```

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

### Fetch a Post with Comments using Python

Source: https://docs.postsyncer.com/api-reference/posts/get

This Python example uses the `requests` library to retrieve a post. It constructs the request URL, sets the `Authorization` header, and sends a GET request. The response is checked for a 200 status code, and post details are printed.

```python
import requests

post_id = 123
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.get(
    f'https://postsyncer.com/api/v1/posts/{post_id}',
    headers=headers
)

if response.status_code == 200:
    post = response.json()
    print(f"Post {post['id']}: {post['content'][0]['text']}")
    print(f"Status: {post['status']}")
    print(f"Platforms: {len(post['platforms'])}")
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

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

### List Labels (Node.js)

Source: https://docs.postsyncer.com/api-reference/labels/list

Fetch all labels using Node.js with the axios library. This example demonstrates making a GET request and handling the response or errors.

```javascript
const axios = require('axios');

const getLabels = async () => {
  try {
    const response = await axios.get('https://postsyncer.com/api/v1/labels', {
      headers: {
        'Authorization': 'Bearer YOUR_API_TOKEN'
      }
    });
    
    console.log('Labels:', response.data);
    return response.data;
  } catch (error) {
    console.error('Error fetching labels:', error.response?.data || error.message);
  }
};

getLabels();
```

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

### List Labels (Python)

Source: https://docs.postsyncer.com/api-reference/labels/list

Get all labels using Python with the requests library. This example makes a GET request, checks the status code, and prints the label details or error information.

```python
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.get(
    'https://postsyncer.com/api/v1/labels',
    headers=headers
)

if response.status_code == 200:
    labels = response.json()
    print(f"Found {len(labels['data'])} labels")
    for label in labels['data']:
        print(f"Label {label['id']}: {label['name']} ({label['color']})")
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

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

### Update Post Example

Source: https://docs.postsyncer.com/api-reference/posts/update

This example demonstrates how to update a post using a PUT request to the Postsyncer API. It includes setting up the request data, headers, and handling the response.

```APIDOC
## PUT /api/v1/posts/{post_id}

### Description
Updates an existing post.

### Method
PUT

### Endpoint
`/api/v1/posts/{post_id}`

### Parameters
#### Path Parameters
- **post_id** (string) - Required - The ID of the post to update.

#### Request Body
- **quote_tweet_id** (string) - Optional - The ID of a tweet to quote.
- **reply** (object) - Optional - Reply settings.
  - **in_reply_to_tweet_id** (string) - Optional - The ID of the tweet this post is a reply to.
- **community_id** (string) - Optional - The ID of the community to associate the post with.
- **share_with_followers** (boolean) - Optional - Whether to share the post with followers.
- **text** (string) - Optional - The content of the post.

### Request Example
```json
{
  "quote_tweet_id": null,
  "reply": {
    "in_reply_to_tweet_id": null
  },
  "community_id": null,
  "share_with_followers": true,
  "text": null
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the updated post information.
  - **id** (string) - The ID of the updated post.

#### Response Example
```json
{
  "data": {
    "id": "updated_post_id"
  }
}
```
```

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

### List Accounts (Python)

Source: https://docs.postsyncer.com/api-reference/accounts/list

Get all social media accounts using Python with the requests library. Ensure you have the requests library installed (`pip install requests`). Replace YOUR_API_TOKEN with your actual API token.

```python
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.get(
    'https://postsyncer.com/api/v1/accounts',
    headers=headers
)

if response.status_code == 200:
    accounts = response.json()
    print(f"Found {len(accounts['data'])} accounts")
    for account in accounts['data']:
        print(f"Account {account['id']}: {account['platform']} - {account['username']}")
        print(f"  Active: {account['is_active']}")
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

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

### List Accounts (Node.js)

Source: https://docs.postsyncer.com/api-reference/accounts/list

Fetch all social media accounts using Node.js with the axios library. Ensure you have axios installed (`npm install axios`). Replace YOUR_API_TOKEN with your actual API token.

```javascript
const axios = require('axios');

const getAccounts = async () => {
  try {
    const response = await axios.get('https://postsyncer.com/api/v1/accounts', {
      headers: {
        'Authorization': 'Bearer YOUR_API_TOKEN'
      }
    });
    
    console.log('Accounts:', response.data);
    return response.data;
  } catch (error) {
    console.error('Error fetching accounts:', error.response?.data || error.message);
  }
};

getAccounts();
```

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

### Get Post Response Example

Source: https://docs.postsyncer.com/api-reference/posts/get

This JSON object represents the detailed response when retrieving a post. It includes the post's ID, content with media, status, posting and scheduling times, repeat settings, workspace information, labels, and platform-specific details.

```json
{
    "id": 743,
    "content": [
        {
            "text": "",
            "media": [
                {
                    "id": 1594,
                    "name": "file_example_MP4_1920_18MG.mp4",
                    "url": "https://postsyncer-local.c6c56f7fb91dd557ca29aa14c4e7d980.r2.cloudflarestorage.com/media/12/5ee789eb-c88c-4af2-8449-54c6c0561f31.mp4?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=a4bcd089276d5d5b77253aa9b13fe59c%2F20250705%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20250705T131116Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=0ef23b86009e4cac6e160863a4b91f15b78270e5524f328fb764a9f22bdaffe3",
                    "type": "video/mp4",
                    "size": 17839845
                }
            ]
        }
    ],
    "status": "PUBLISHED",
    "posted_on": [
        "2025-07-05 12:36"
    ],
    "scheduled_at": "2025-07-05 16:00",
    "repeatable": false,
    "repeatable_times": null,
    "repeatable_gap": null,
    "repeatable_gap_unit": null,
    "remaining_posts": null,
    "created_at": "2025-07-05 12:34",
    "updated_at": "2025-07-05 12:36",
    "workspace": {
        "id": 12,
        "name": "abdulmejidshemsuawel",
        "slug": "abdulmejidshemsuawel",
        "type": "PERSONAL",
        "logo": null,
        "timezone": "Africa/Addis_Ababa",
        "language": "en"
    },
    "labels": [],
    "platforms": [
        {
            "platform": "twitter",
            "posted_on": [
                "2025-07-05 12:36"
            ],
            "status": "PUBLISHED",
            "settings": {
                "for_super_followers_only": false,
                "reply_settings": "everyone",
                "quote_tweet_id": null,
                "reply": {
                    "in_reply_to_tweet_id": null
                },
                "community_id": null,
                "share_with_followers": true,
                "text": null

```

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

### Media overview

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

List, get, delete, upload files, or import URLs into your workspace library, then attach media by id or URL when creating posts.

```APIDOC
## Media overview

### Description
List, get, delete, upload files, or import URLs into your workspace library, then attach media by id or URL when creating posts.

### Method
GET

### Endpoint
/media/overview

### Response
#### Success Response (200)
Provides an overview of media library management capabilities.
```

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

### Create Post

Source: https://docs.postsyncer.com/api-reference/posts/create

This example demonstrates how to create a new post using the Posts API. It includes the necessary request body structure and headers for authentication.

```APIDOC
## POST /api/v1/posts

### Description
Creates a new post with the provided content and settings.

### Method
POST

### Endpoint
/api/v1/posts

### Request Body
- **text** (string) - Required - The main content of the post.
- **community_id** (string) - Optional - The ID of the community to post to.
- **share_with_followers** (boolean) - Optional - Whether to share the post with followers (defaults to true).

### Request Example
```json
{
  "data": {
    "community_id": null,
    "share_with_followers": true,
    "text": "This is a sample post content."
  }
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier of the created post.

#### Response Example
```json
{
  "id": "post_12345abcde"
}
```
```

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

### Authentication Header Example

Source: https://docs.postsyncer.com/api-reference/introduction

All requests to the PostSyncer API require a Bearer token. Ensure your token is valid and has the necessary scopes for the requested operations.

```APIDOC
## Authentication

### Description
Every request needs a **Bearer** token from [Settings → API integrations](https://app.postsyncer.com/dashboard?action=settings&section=api-integrations). Scopes must match what you call (e.g. `posts` for posts and analytics).

### Request Header
```bash
Authorization: Bearer YOUR_API_TOKEN
```
```

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

### List Posts with Python (Requests)

Source: https://docs.postsyncer.com/api-reference/posts/list

Use the Python requests library to fetch posts. This snippet shows how to set headers and parameters for the GET request.

```python
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

params = {
    'page': 1,
    'per_page': 20
}

response = requests.get(
    'https://postsyncer.com/api/v1/posts',
    headers=headers,
    params=params
)

if response.status_code == 200:
    posts = response.json()
    print(f"Found {posts['total']} posts")
    for post in posts['data']:
        print(f"Post {post['id']}: {post['content'][0]['text'][:50]}...")
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

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

### Create a Post using cURL

Source: https://docs.postsyncer.com/quickstart

This example demonstrates how to create a simple text post with an image across your connected accounts. You need to provide your workspace ID, content, and account details.

```bash
curl -X POST "https://postsyncer.com/api/v1/posts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_id": 12,
    "labels": [5],
    "content": [
      {
        "text": "Post Once. Publish everywhere",
        "media": [
          "https://postsyncer.com/images/og/banner.png?v2"
        ]
      }
    ],
    "schedule_type": "schedule",
    "schedule_for": {
      "date": "2025-07-04",
      "time": "23:00",
      "timezone": "Africa/Addis_Ababa"
    }, 
    "accounts": [
      {
        "id": 136,
        "settings": {
          "for_super_followers_only": false,
          "reply_settings": "everyone",
          "quote_tweet_id": 1940147562003963969,
          "reply": {
            "in_reply_to_tweet_id": null
          },
          "community_id": null,
          "share_with_followers": true,
          "text": null
        }
      },
      {
        "id": 95,
        "settings": {
          "board_id": 871517034080685367
        }
      }
    ]
  }'
```

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

### Authentication Header Example

Source: https://docs.postsyncer.com/api-reference/introduction

Include this header in every request to authenticate your API calls. Replace 'YOUR_API_TOKEN' with your actual token obtained from the PostSyncer integration settings.

```bash
Authorization: Bearer YOUR_API_TOKEN
```

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

### Create Post using Node.js (Axios)

Source: https://docs.postsyncer.com/api-reference/posts/create

This Node.js example demonstrates how to create a post using the Axios library. Replace YOUR_API_TOKEN with your valid API token.

```javascript
const axios = require('axios');

const createPost = async () => {
  try {
    const response = await axios.post('https://postsyncer.com/api/v1/posts', {
      workspace_id: 12,
      labels: [
        5
      ],
      content: [
        {
          text: 'Post Once. Publissh everywhere',
          media: [
            'https://postsyncer.com/images/og/banner.png?v2'
          ]
        }
      ],
      schedule_type: 'schedule',
      schedule_for: {
        date: '2025-07-05',
        time: '23:00',
        timezone: 'Africa/Addis_Ababa'
      },
      accounts: [
        {
          id: 136,
          settings: {
            for_super_followers_only: false,
            reply_settings: 'everyone',
            quote_tweet_id: null,
            reply: {
              in_reply_to_tweet_id: null
            },
            community_id: null,
            share_with_followers: true,
            text: null
          }
        }
      ]
    }, {
      headers: {
        'Authorization': 'Bearer YOUR_API_TOKEN',
        'Content-Type': 'application/json'
      }
    });
    
    console.log('Post created:', response.data);
  } catch (error) {
    console.error('Error creating post:', error.response?.data || error.message);
  }
};

createPost();
```

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

### Create folder

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

Create a media library folder (optional parent, color).

```APIDOC
## Create folder

### Description
Create a media library folder (optional parent, color).

### Method
POST

### Endpoint
/folders

### Parameters
#### Request Body
- **name** (string) - Required - The name of the folder.
- **parentId** (string) - Optional - The ID of the parent folder.
- **color** (string) - Optional - The color of the folder (e.g., hex code).

### Request Example
```json
{
  "name": "Vacation Photos",
  "parentId": "folder_xyz",
  "color": "#FF5733"
}
```

### Response
#### Success Response (201)
- **folderId** (string) - The ID of the newly created folder.
- **name** (string) - The name of the folder.
- **createdAt** (string) - The timestamp when the folder was created.
```

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

### Create Post using Python (Requests)

Source: https://docs.postsyncer.com/api-reference/posts/create

This Python example uses the Requests library to create a post. Ensure you replace YOUR_API_TOKEN with your actual API token.

```python
import requests
import json

data = {
    'workspace_id': 12,
    'labels': [
        5
    ],
    'content': [
        {
            'text': 'Post Once. Publissh everywhere',
            'media': [
                'https://postsyncer.com/images/og/banner.png?v2'
            ]
        }
    ],
    'schedule_type': 'schedule',
    'schedule_for': {
        'date': '2025-07-05',
        'time': '23:00',
        'timezone': 'Africa/Addis_Ababa'
    },
    'accounts': [
        {
            'id': 136,
            'settings': {
                'for_super_followers_only': False,
                'reply_settings': 'everyone',
                'quote_tweet_id': None,
                'reply': {
                    'in_reply_to_tweet_id': None

```

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

### Get Label using PHP

Source: https://docs.postsyncer.com/api-reference/labels/get

Retrieve label information with PHP using cURL. This example demonstrates setting the URL, HTTP method, headers, and handling the response.

```php
<?php

$labelId = 123;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://postsyncer.com/api/v1/labels/{$labelId}");
curl_setopt($ch, CURLOPT_HTTPGET, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
    $label = json_decode($response, true);
    echo "Label {$label['id']}: {$label['name']} ({$label['color']})";
} else {
    echo "Error: " . $response;
}
?>
```

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

### Get Post Analytics (Node.js)

Source: https://docs.postsyncer.com/api-reference/analytics/post

This Node.js function uses the axios library to retrieve analytics for a given post ID. Ensure you have axios installed and replace YOUR_API_TOKEN with your actual API token.

```javascript
const axios = require('axios');

const getPostAnalytics = async (postId) => {
  const { data } = await axios.get(
    `https://postsyncer.com/api/v1/analytics/posts/${postId}`,
    { headers: { Authorization: 'Bearer YOUR_API_TOKEN' } }
  );
  return data;
};

```

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

### List Workspaces (Python)

Source: https://docs.postsyncer.com/api-reference/workspaces/list

This Python example utilizes the requests library to fetch workspaces. It prints the number of workspaces found and their names, or an error message if the request fails.

```python
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.get(
    'https://postsyncer.com/api/v1/workspaces',
    headers=headers
)

if response.status_code == 200:
    workspaces = response.json()
    print(f"Found {len(workspaces['data'])} workspaces")
    for workspace in workspaces['data']:
        print(f"Workspace {workspace['id']}: {workspace['name']}")
        print(f"  Accounts: {len(workspace['accounts'])}")
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

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

### Update Label Node.js Example

Source: https://docs.postsyncer.com/api-reference/labels/update

Example of how to update a label using Node.js with the axios library. Replace YOUR_API_TOKEN and the label ID as needed.

```javascript
const axios = require('axios');

const updateLabel = async (labelId) => {
  try {
    const response = await axios.put(`https://postsyncer.com/api/v1/labels/${labelId}`, {
      name: 'Updated Product Launch',
      color: '#00ff00'
    }, {
      headers: {
        'Authorization': 'Bearer YOUR_API_TOKEN',
        'Content-Type': 'application/json'
      }
    });
    
    console.log('Label updated:', response.data);
  } catch (error) {
    console.error('Error updating label:', error.response?.data || error.message);
  }
};

updateLabel(123);
```

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

### Common Error Examples

Source: https://docs.postsyncer.com/essentials/error-handling

Examples of common error responses, including authentication, validation, and rate limit errors, to help you identify and resolve issues.

```APIDOC
## Common Error Codes

### Authentication Errors

```json
{
  "message": "Unauthenticated"
}
```

### Validation Errors

```json
{
    "message": "The workspace id field is required.",
    "errors": {
        "workspace_id": [
            "The workspace id field is required."
        ]
    }
}
```

### Rate Limit Errors

```json
{
  "message": "Too Many Attempts."
}
```
```

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

### List Workspaces

Source: https://docs.postsyncer.com/quickstart

Verify your API key by listing your workspaces. This is a good first step to ensure your authentication is set up correctly.

```APIDOC
## GET /api/v1/workspaces

### Description
Retrieves a list of all workspaces associated with your account.

### Method
GET

### Endpoint
/api/v1/workspaces

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET "https://postsyncer.com/api/v1/workspaces" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the workspace.
- **name** (string) - The name of the workspace.
- **slug** (string) - A URL-friendly version of the workspace name.
- **type** (string) - The type of workspace (e.g., PERSONAL).
- **logo** (string or null) - URL to the workspace logo, if available.
- **timezone** (string) - The timezone configured for the workspace.
- **language** (string) - The default language for the workspace.
- **accounts** (array) - A list of connected accounts within the workspace.
  - **id** (integer) - The unique identifier for the account.
  - **platform** (string) - The social media platform (e.g., twitter).
  - **username** (string) - The username on the platform.
  - **name** (string) - The display name on the platform.
  - **avatar** (string) - URL to the user's avatar on the platform.

#### Response Example
```json
{
  "id": 12,
  "name": "abdulmejidshemsuawel",
  "slug": "abdulmejidshemsuawel",
  "type": "PERSONAL",
  "logo": null,
  "timezone": "Africa/Addis_Ababa",
  "language": "en",
  "accounts": [
    {
        "id": 136,
        "platform": "twitter",
        "username": "heyabdulmejid",
        "name": "Abdul",
        "avatar": "https://pbs.twimg.com/profile_images/1878383928995684352/3Xw5HTsk_400x400.jpg"
    }
  ]
}
```
```

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

### Update Label cURL Example

Source: https://docs.postsyncer.com/api-reference/labels/update

Example of how to update a label using cURL. Ensure you replace YOUR_API_TOKEN with your actual token and 123 with the label ID.

```bash
curl -X PUT "https://postsyncer.com/api/v1/labels/123" \
    -H "Authorization: Bearer YOUR_API_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Updated Product Launch",
      "color": "#00ff00"
    }'
```

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

### Get Label using Python

Source: https://docs.postsyncer.com/api-reference/labels/get

Make a GET request to fetch label data using the requests library in Python. The response is parsed as JSON.

```python
import requests

label_id = 123
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.get(
    f'https://postsyncer.com/api/v1/labels/{label_id}',
    headers=headers
)

if response.status_code == 200:
    label = response.json()
    print(f"Label {label['id']}: {label['name']} ({label['color']})")
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

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

### Create a Post with Python

Source: https://docs.postsyncer.com/quickstart

This Python script demonstrates how to send a request to create a scheduled post. Ensure your API key and base URL are set correctly.

```python
import requests
import json
from datetime import datetime, timedelta

api_key = 'YOUR_API_KEY'
base_url = 'https://postsyncer.com/api/v1'

headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json'
}

# Create a post
def create_post():
    data = {
        'workspace_id': 12,
        'labels': [5],
        'content': [
            {
                'text': 'Hello from Python!',
                'media': []
            }
        ],
        'schedule_type': 'schedule',
        'schedule_for': {
            'date': '2025-07-04',
            'time': '23:00',
            'timezone': 'Africa/Addis_Ababa'
        }, 
        'accounts': [
            {
                'id': 136,
                'settings': {
                    'for_super_followers_only': False,
                    'reply_settings': 'everyone',
                    'quote_tweet_id': None,
                    'reply': {
                        'in_reply_to_tweet_id': None
                    },
                    'community_id': None,
                    'share_with_followers': true,
                    'text': None
                }
            }
        ]
    }
    
    response = requests.post(f'{base_url}/posts', headers=headers, json=data)
    print('Post created:', response.json())

create_post()
```

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

### Update Label PHP Example

Source: https://docs.postsyncer.com/api-reference/labels/update

Example of how to update a label using PHP. This script sends a PUT request with the updated label data. Remember to replace YOUR_API_TOKEN and the label ID.

```php
<?php

$labelId = 123;
$data = [
    'name' => 'Updated Product Launch',
    'color' => '#00ff00'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://postsyncer.com/api/v1/labels/{$labelId}");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
    $label = json_decode($response, true);
    echo "Label updated: " . $label['id'];
} else {
    echo "Error: " . $response;
}
?>
```

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

### List Media with Workspace and Pagination

Source: https://docs.postsyncer.com/api-reference/media/list

Use this endpoint to retrieve media items, filtering by a specific workspace and controlling the number of items per page. Ensure you include your API token for authorization.

```bash
curl -X GET "https://postsyncer.com/api/v1/media?workspace_id=12&per_page=25" \
    -H "Authorization: Bearer YOUR_API_TOKEN"
```

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

### Update Label Python Example

Source: https://docs.postsyncer.com/api-reference/labels/update

Example of how to update a label using Python with the requests library. This snippet demonstrates sending a PUT request with JSON data. Replace YOUR_API_TOKEN and the label ID.

```python
import requests
import json

label_id = 123
data = {
    'name': 'Updated Product Launch',
    'color': '#00ff00'
}

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
}

response = requests.put(
    f'https://postsyncer.com/api/v1/labels/{label_id}',
    json=data,
    headers=headers
)

if response.status_code == 200:
    label = response.json()
    print(f"Label updated: {label['id']}")
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

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

### List Workspaces using cURL

Source: https://docs.postsyncer.com/quickstart

Use this command to verify your API key is working by listing your workspaces. Ensure you replace YOUR_API_KEY with your actual key.

```bash
curl -X GET "https://postsyncer.com/api/v1/workspaces" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

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

### Get Media by ID using cURL

Source: https://docs.postsyncer.com/api-reference/media/get

Use this cURL command to make a GET request to retrieve a specific media item. Replace `99` with the actual media ID and `YOUR_API_TOKEN` with your authentication token.

```bash
curl -X GET "https://postsyncer.com/api/v1/media/99" \
    -H "Authorization: Bearer YOUR_API_TOKEN"
```

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

### Create Folder

Source: https://docs.postsyncer.com/

Creates a new folder.

```APIDOC
## POST /folders

### Description
Create folder

### Method
POST

### Endpoint
/folders
```

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

### Get Post by Platform Post ID using cURL

Source: https://docs.postsyncer.com/api-reference/posts/get-by-platform-post-id

Use this cURL command to make a GET request to retrieve a post by its platform-specific ID. Include your API token for authentication and optionally specify `include_comments`.

```bash
curl -X GET "https://postsyncer.com/api/v1/posts/by-platform-post-id/1234567890?include_comments=false" \
    -H "Authorization: Bearer YOUR_API_TOKEN"
```

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

### Get Label

Source: https://docs.postsyncer.com/

Retrieves a specific label.

```APIDOC
## GET /labels/{label_id}

### Description
Get Label

### Method
GET

### Endpoint
/labels/{label_id}
```

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

### Import media from URL

Source: https://docs.postsyncer.com/api-reference/media/upload-url

Send `application/json` with a list of URLs. The API downloads or resolves each URL and creates media library rows in the given workspace. Response is `200` with `media` (array of created items) and `count_stored`. URLs that fail validation or fetch may be skipped.

```APIDOC
## POST /api/v1/media/upload/url

### Description
Stores remote images/videos into the workspace library from a list of URLs.

### Method
POST

### Endpoint
/api/v1/media/upload/url

### Parameters
#### Request Body
- **workspace_id** (integer) - Required - Workspace that will own the imported files
- **urls** (string[]) - Required - List of URLs to import (each must be a valid URL, max 2048 characters)
- **folder_id** (integer) - Optional - Media library folder id belonging to `workspace_id`

### Request Example
```bash
curl -X POST "https://postsyncer.com/api/v1/media/upload/url" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d 
    {
      "workspace_id": 12,
      "urls": [
        "https://example.com/assets/hero.png"
      ]
    }
```

### Response
#### Success Response (200)
- **media** (array) - Created library items; each includes `id` for use in `POST /posts` … `content[].media`
- **count_stored** (integer) - Number of items in `media`

#### Response Example
```json
{
  "media": [
    {
      "id": 915,
      "name": "hero.png",
      "url": "https://…",
      "mime_type": "image/png",
      "size": 98234,
      "is_processing": false,
      "type": "image",
      "ai_generated_id": null,
      "is_reference": false,
      "progress": 100,
      "alt": null
    }
  ],
  "count_stored": 1
}
```
```

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

### Get Comment

Source: https://docs.postsyncer.com/

Retrieves a specific comment.

```APIDOC
## GET /comments/{comment_id}

### Description
Get comment

### Method
GET

### Endpoint
/comments/{comment_id}
```

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

### Claude Desktop MCP Server Configuration (macOS)

Source: https://docs.postsyncer.com/mcp/integrating-clients

Add PostSyncer as an MCP server in Claude Desktop's configuration on macOS. Ensure `npx` is available in your system's PATH.

```json
{
  "mcpServers": {
    "postsyncer": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://postsyncer.com/mcp",
        "--header",
        "Authorization: Bearer YOUR_TOKEN_HERE"
      ]
    }
  }
}
```

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

### Get Folder

Source: https://docs.postsyncer.com/

Retrieves a specific folder.

```APIDOC
## GET /folders/{folder_id}

### Description
Get folder

### Method
GET

### Endpoint
/folders/{folder_id}
```

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

### Configure Cursor MCP Server

Source: https://docs.postsyncer.com/mcp/integrating-clients

Add a new server configuration for PostSyncer in Cursor's MCP settings. Use environment variables for secure token management.

```json
{
  "mcpServers": {
    "postsyncer": {
      "url": "https://postsyncer.com/mcp",
      "headers": {
        "Authorization": "Bearer ${env:POSTSYNCER_TOKEN}",
        "Accept": "application/json"
      }
    }
  }
}
```

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

### Get Post

Source: https://docs.postsyncer.com/

Retrieves a specific post.

```APIDOC
## GET /posts/{post_id}

### Description
Get Post

### Method
GET

### Endpoint
/posts/{post_id}
```

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

### List Comments Request Example

Source: https://docs.postsyncer.com/api-reference/comments/list

Demonstrates how to make a curl request to list comments for a given post. Includes parameters for post ID, items per page, and whether to include replies. Ensure to replace YOUR_API_TOKEN with your actual authentication token.

```bash
curl -G "https://postsyncer.com/api/v1/comments" \
    --data-urlencode "post_id=123" \
    --data-urlencode "per_page=20" \
    --data-urlencode "include_replies=true" \
    -H "Authorization: Bearer YOUR_API_TOKEN"
```

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

### List Posts with PHP (cURL)

Source: https://docs.postsyncer.com/api-reference/posts/list

Retrieve posts using PHP's cURL extension. This example demonstrates setting up the request with URL parameters and headers.

```php
<?php

  $page = 1;
  $perPage = 20;

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, "https://postsyncer.com/api/v1/posts?page={$page}&per_page={$perPage}");
  curl_setopt($ch, CURLOPT_HTTPGET, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'Authorization: Bearer YOUR_API_TOKEN'
  ]);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

  $response = curl_exec($ch);
  $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  curl_close($ch);

  if ($httpCode === 200) {
      $posts = json_decode($response, true);
      echo "Found " . $posts['total'] . " posts";
  } else {
      echo "Error: " . $response;
  }
  ?>
```

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

### Get Label

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

Retrieve a specific label by ID.

```APIDOC
## Get Label

### Description
Retrieve a specific label by ID.

### Method
GET

### Endpoint
/labels/{labelId}

### Parameters
#### Path Parameters
- **labelId** (string) - Required - The ID of the label to retrieve.

### Response
#### Success Response (200)
- **label** (object) - The label object with its details.
```

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

### Get Media

Source: https://docs.postsyncer.com/

Retrieves a specific media item.

```APIDOC
## GET /media/{media_id}

### Description
Get media

### Method
GET

### Endpoint
/media/{media_id}
```

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

### Create Post Response Example

Source: https://docs.postsyncer.com/api-reference/posts/create

This JSON object represents a successful response when creating a post. It includes details about the post's content, status, scheduling, and associated workspace information.

```json
{
    "id": 749,
    "content": [
        {
            "text": "Post Once. Publissh everywhere",
            "media": [
                {
                    "id": 1672,
                    "name": "banner.png",
                    "url": "https://postsyncer.com/images/og/banner.png?v2",
                    "type": "image/png",
                    "size": 210537
                }
            ]
        }
    ],
    "status": "SCHEDULED",
    "posted_on": [],
    "scheduled_at": "2025-07-05 23:00 PM",
    "repeatable": null,
    "repeatable_times": null,
    "repeatable_gap": null,
    "repeatable_gap_unit": null,
    "remaining_posts": null,
    "created_at": "2025-07-05 17:04 PM",
    "updated_at": "2025-07-05 17:04 PM",
    "workspace": {
        "id": 12,
        "name": "abdulmejidshemsuawel",
        "slug": "abdulmejidshemsuawel",
        "type": "PERSONAL",
        "logo": null,
        "timezone": "Africa/Addis_Ababa",
        "language": "en"
    },
    "labels": [
        {
            "id": 5,
            "name": "ol pasdm",
            "color": "#bf3434"
        }
    ],
    "platforms": [
        {
            "platform": "twitter",
            "posted_on": [],
            "status": "PENDING",
            "settings": {
                "for_super_followers_only": false,
                "reply_settings": "everyone",
                "quote_tweet_id": null,
                "reply": {
                    "in_reply_to_tweet_id": null
                },
                "community_id": null,
                "share_with_followers": true,
                "text": "",
                "poll": {
                    "enabled": false,
                    "duration_minutes": null,
                    "reply_settings": "everyone",
                    "options": null
                }
            }
        }
    ],
    "auto_plug": null 
  }
```

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

### Create a Post with JavaScript/Node.js

Source: https://docs.postsyncer.com/quickstart

Use this snippet to create a scheduled post with media and specific account settings. Ensure your API key and base URL are correctly configured.

```javascript
const axios = require('axios');

const apiKey = 'YOUR_API_KEY';
const baseURL = 'https://postsyncer.com/api/v1';

const api = axios.create({
  baseURL,
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  }
});

// Create a post
const createPost = async () => {
  try {
    const response = await api.post('/posts', {
      workspace_id: 12,
      labels: [5],
      content: [
        {
          text: 'Hello from Node.js!',
          media: []
        }
      ],
      schedule_type: 'schedule',
      schedule_for: {
        date: '2025-07-04',
        time: '23:00',
        timezone: 'Africa/Addis_Ababa'
      },
      repeatable: true,
      repeatable_times: 2,
      repeatable_gap: 2,
      repeatable_gap_unit: 'days',
      accounts: [
        {
          id: 136,
          settings: {
            for_super_followers_only: false,
            reply_settings: 'everyone',
            quote_tweet_id: null,
            reply: {
              in_reply_to_tweet_id: null
            },
            community_id: null,
            share_with_followers: true,
            text: null
          }
        }
      ]
    });
    console.log('Post created:', response.data);
  } catch (error) {
    console.error('Error:', error.response.data);
  }
};

createPost();
```

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

### Get folder

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

Retrieve one media folder by id.

```APIDOC
## Get folder

### Description
Retrieve one media folder by id.

### Method
GET

### Endpoint
/folders/{folderId}

### Parameters
#### Path Parameters
- **folderId** (string) - Required - The ID of the folder to retrieve.

### Response
#### Success Response (200)
- **folder** (object) - The folder object with its details.
```
Tokens:
Raw