Posts

Last updated on Feb 05, 2025

List posts

Method: GET

URLhttps://app.allpost.co/in/api/<workspaceUuid>/posts?page=1

AuthorizationBearer <token>

Response: 200

{
  "data": [
    {
      "id": 3,
      "uuid": "8eb4e98d-2b93-44bd-a664-7a6438eff67b",
      "status": "draft",
      "accounts": [],
      "versions": [
        {
          "account_id": 0,
          "is_original": true,
          "content": [
            {
              "body": "",
              "media": [],
              "url": ""
            }
          ],
          "options": {
            "tiktok": {
              "privacy_level": {
                "account-0": null
              },
              "allow_comments": {
                "account-0": false
              },
              "allow_duet": {
                "account-0": false
              },
              "allow_stitch": {
                "account-0": false
              },
              "content_disclosure": {
                "account-0": false
              },
              "brand_organic_toggle": {
                "account-0": false
              },
              "brand_content_toggle": {
                "account-0": false
              }
            },
            "youtube": {
              "title": null,
              "status": "public"
            },
            "linkedin": {
              "visibility": "PUBLIC"
            },
            "mastodon": {
              "sensitive": false
            },
            "instagram": {
              "type": "post"
            },
            "pinterest": {
              "title": null,
              "link": null,
              "boards": {
                "account-0": null
              }
            },
            "facebook_page": {
              "type": "post"
            }
          }
        }
      ],
      "tags": [
        {
          "id": 2,
          "uuid": "f9288040-0d50-4e40-83d6-10ef6dd31d9d",
          "name": "release",
          "hex_color": "#111827"
        },
        {
          "id": 3,
          "uuid": "a09367a5-dfc1-43d7-9557-70eb93e01e01",
          "name": "news",
          "hex_color": "#38bdf8"
        }
      ],
      "user": {
        "name": "Test User"
      },
      "scheduled_at": null,
      "published_at": null,
      "created_at": "2024-03-29 15:26:06",
      "trashed": false
    },
    {
      "id": 2,
      "uuid": "69288ffd-d4ef-4666-9320-4b9e120694fc",
      "status": "published",
      "accounts": [
        {
          "id": 3,
          "uuid": "ed1d7f93-ebca-4217-957c-a25fbb2c1075",
          "name": "Oluwatobi Owolabi",
          "username": "tobsowo",
          "image": "https://example.com/avatar/tobi.jpg",
          "provider": "twitter",
          "data": null,
          "authorized": true,
          "created_at": "2024-03-29 09:55:31",
          "external_url": "https://twitter.com/tobsowo/status/23424241115453465",
          "errors": []
        }
      ],
      "versions": [
        {
          "account_id": 0,
          "is_original": true,
          "content": [
            {
              "body": "<div>Manage your social media easily with AllPost! 💻✨</div>",
              "media": [
                {
                  "id": "1",
                  "name": "blue.png",
                  "mime_type": "image/png",
                  "type": "image",
                  "url": "https://your-domain.com/storage/2576cb55-ab0f-3708-9388-6d03290fcb3f/uploads/03-2024/HsqEvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi.png",
                  "thumb_url": "https://your-domain.com/storage/2576cb55-ab0f-3708-9388-6d03290fcb3f/uploads/03-2024/HsqEvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi-thumb.png",
                  "is_video": false,
                  "created_at": "2024-03-29 15:33:23"
                }
              ],
              "url": ""
            }
          ],
          "options": {
            "tiktok": {
              "privacy_level": {
                "account-0": null
              },
              "allow_comments": {
                "account-0": false
              },
              "allow_duet": {
                "account-0": false
              },
              "allow_stitch": {
                "account-0": false
              },
              "content_disclosure": {
                "account-0": false
              },
              "brand_organic_toggle": {
                "account-0": false
              },
              "brand_content_toggle": {
                "account-0": false
              }
            },
            "youtube": {
              "title": null,
              "status": "public"
            },
            "linkedin": {
              "visibility": "PUBLIC"
            },
            "mastodon": {
              "sensitive": false
            },
            "instagram": {
              "type": "post"
            },
            "pinterest": {
              "title": null,
              "link": null,
              "boards": {
                "account-0": null
              }
            },
            "facebook_page": {
              "type": "post"
            }
          }
        }
      ],
      "tags": [],
      "user": {
        "name": "Oluwatobi Owolabi"
      },
      "scheduled_at": "2024-03-29 09:55:57",
      "published_at": "2024-03-29 09:56:03",
      "created_at": "2024-03-29 09:55:34",
      "trashed": false
    },
    {
      "id": 1,
      "uuid": "b1b06706-ef95-42b7-8ac8-d648dc9a9d65",
      "status": "published",
      "accounts": [
        {
          "id": 2,
          "uuid": "cfbdc3eb-22cb-4d15-b2a0-63d5fcd5bd92",
          "name": "Oluwatobi Owolabi",
          "username": "tobsowo",
          "image": null,
          "provider": "linkedin",
          "data": null,
          "authorized": true,
          "created_at": "2024-03-29 09:49:22",
          "external_url": "https://linkedin.com/feed/update/urn:li:share:43536647554322",
          "errors": []
        },
        {
          "id": 1,
          "uuid": "85347d5e-9724-4cb6-b91c-82d6d6d4e992",
          "name": "AllPost",
          "username": "useallpost",
          "image": "https://example.com/avatar/allpost.jpg",
          "provider": "facebook_page",
          "data": {
            "suffix": {
              "value": "Page",
              "edited": false
            }
          },
          "authorized": true,
          "created_at": "2024-03-27 11:30:45",
          "external_url": "https://facebook.com/3432042343434323/7179414779038416896",
          "errors": []
        }
      ],
      "versions": [
        {
          "account_id": 0,
          "is_original": true,
          "content": [
            {
              "body": "<div>Optimize your team's social media strategy with AllPost or launch a whitelabel for your organization.</div>",
              "media": [
                {
                  "id": "2",
                  "name": "tea-reduced-file-size.mp4",
                  "mime_type": "video/mp4",
                  "type": "video",
                  "url": "https://your-domain.com/storage/2576cb55-ab0f-3708-9388-6d03290fcb3f/uploads/03-2024/9LD3AR2JF6MHl79rG7qWxGdEiqzneaOxMcnuw1M7.mp4",
                  "thumb_url": "https://your-domain.com/storage/2576cb55-ab0f-3708-9388-6d03290fcb3f/uploads/03-2024/9LD3AR2JF6MHl79rG7qWxGdEiqzneaOxMcnuw1M7-thumb.jpg",
                  "is_video": true,
                  "created_at": "2024-03-29 15:33:32"
                }
              ],
              "url": ""
            }
          ],
          "options": {
            "tiktok": {
              "privacy_level": {
                "account-0": null
              },
              "allow_comments": {
                "account-0": false
              },
              "allow_duet": {
                "account-0": false
              },
              "allow_stitch": {
                "account-0": false
              },
              "content_disclosure": {
                "account-0": false
              },
              "brand_organic_toggle": {
                "account-0": false
              },
              "brand_content_toggle": {
                "account-0": false
              }
            },
            "youtube": {
              "title": null,
              "status": "public"
            },
            "linkedin": {
              "visibility": "PUBLIC"
            },
            "mastodon": {
              "sensitive": false
            },
            "instagram": {
              "type": "post"
            },
            "pinterest": {
              "title": null,
              "link": null,
              "boards": {
                "account-0": null
              }
            },
            "facebook_page": {
              "type": "post"
            }
          }
        }
      ],
      "tags": [
        {
          "id": 1,
          "uuid": "2323e1eb-b3a6-4183-990d-4d5afea04835",
          "name": "motivation",
          "hex_color": "#60a5fa"
        }
      ],
      "user": {
        "name": "Oluwatobi Owolabi"
      },
      "scheduled_at": "2024-03-29 09:50:56",
      "published_at": "2024-03-29 09:51:10",
      "created_at": "2024-03-29 09:50:46",
      "trashed": false
    }
  ],
  "links": {
    "first": "https://your-domain.com/your-core-path/api/2576cb55-ab0f-3708-9388-6d03290fcb3f/posts?page=1",
    "last": "https://your-domain.com/your-core-path/api/2576cb55-ab0f-3708-9388-6d03290fcb3f/posts?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://your-domain.com/your-core-path/api/2576cb55-ab0f-3708-9388-6d03290fcb3f/posts?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "https://your-domain.com/your-core-path/api/2576cb55-ab0f-3708-9388-6d03290fcb3f/posts",
    "per_page": 20,
    "to": 3,
    "total": 3
  }
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}

Get a post

Method: GET

URLhttps://app.allpost.co/in/api/<workspaceUuid>/posts/<postUuid>

AuthorizationBearer <token>

Response: 200

{
  "id": 1,
  "uuid": "b1b06706-ef95-42b7-8ac8-d648dc9a9d65",
  "status": "published",
  "accounts": [
    {
      "id": 2,
      "uuid": "cfbdc3eb-22cb-4d15-b2a0-63d5fcd5bd92",
      "name": "Oluwatobi Owolabi",
      "username": "tobsowo",
      "image": null,
      "provider": "linkedin",
      "data": null,
      "authorized": true,
      "created_at": "2024-03-29 09:49:22",
      "external_url": "https://linkedin.com/feed/update/urn:li:share:43536647554322",
      "errors": []
    },
    {
      "id": 1,
      "uuid": "85347d5e-9724-4cb6-b91c-82d6d6d4e992",
      "name": "AllPost",
      "username": "useallpost",
      "image": "https://example.com/avatar/allpost.jpg",
      "provider": "facebook_page",
      "data": {
        "suffix": {
          "value": "Page",
          "edited": false
        }
      },
      "authorized": true,
      "created_at": "2024-03-27 11:30:45",
      "external_url": "https://facebook.com/3432042343434323/7179414779038416896",
      "errors": []
    }
  ],
  "versions": [
    {
      "account_id": 0,
      "is_original": true,
      "content": [
        {
          "body": "<div>Optimize your team's social media strategy with AllPost or launch your SaaS quickly and start generating revenue effortlessly.</div>",
          "media": [
            {
              "id": "2",
              "name": "tea-reduced-file-size.mp4",
              "mime_type": "video/mp4",
              "type": "video",
              "url": "https://your-domain.com/storage/2576cb55-ab0f-3708-9388-6d03290fcb3f/uploads/03-2024/9LD3AR2JF6MHl79rG7qWxGdEiqzneaOxMcnuw1M7.mp4",
              "thumb_url": "https://your-domain.com/storage/2576cb55-ab0f-3708-9388-6d03290fcb3f/uploads/03-2024/9LD3AR2JF6MHl79rG7qWxGdEiqzneaOxMcnuw1M7-thumb.jpg",
              "is_video": true,
              "created_at": "2024-03-29 15:33:32"
            }
          ],
          "url": ""
        }
      ],
      "options": {
        "tiktok": {
          "privacy_level": {
            "account-0": null
          },
          "allow_comments": {
            "account-0": false
          },
          "allow_duet": {
            "account-0": false
          },
          "allow_stitch": {
            "account-0": false
          },
          "content_disclosure": {
            "account-0": false
          },
          "brand_organic_toggle": {
            "account-0": false
          },
          "brand_content_toggle": {
            "account-0": false
          }
        },
        "youtube": {
          "title": null,
          "status": "public"
        },
        "linkedin": {
          "visibility": "PUBLIC"
        },
        "mastodon": {
          "sensitive": false
        },
        "instagram": {
          "type": "post"
        },
        "pinterest": {
          "title": null,
          "link": null,
          "boards": {
            "account-0": null
          }
        },
        "facebook_page": {
          "type": "post"
        }
      }
    }
  ],
  "tags": [
    {
      "id": 1,
      "uuid": "2323e1eb-b3a6-4183-990d-4d5afea04835",
      "name": "motivation",
      "hex_color": "#60a5fa"
    }
  ],
  "user": {
    "name": "Oluwatobi Owolabi"
  },
  "scheduled_at": "2024-03-29 09:50:56",
  "published_at": "2024-03-29 09:51:10",
  "created_at": "2024-03-29 09:50:46",
  "trashed": false
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}
{
  "message": "Post not found."
}

Create a post

Method: POST

URLhttps://app.allpost.co/in/api/<workspaceUuid>/posts

AuthorizationBearer <token>

Body:

{
  "date": "2025-02-23",
  "time": "15:00",
  "timezone": "Africa/Lagos",
  "schedule": true,
  "schedule_now": true,
  "queue": true,
  "accounts": [1,2,3],
  "tags": [1,2],
  "versions": [
    {
      "account_id": 0,
      "is_original": true,
      "content": [
        {
          "body": "This is the content",
          "media": [
            1
          ]
        }
      ],
      "options": {
        "mastodon": {
          "sensitive": false
        }
      }
    }
  ]
}

Response: 200

{
  "id": 3,
  "uuid": "6059e1b3-e102-4be5-951b-82698abd9ee3",
  "name": "Motivation",
  "hex_color": "#000000"
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}

Response: 422

{
  "message": "Validation errors",
  "errors": {}
}

Update a post

Method: PUT

URLhttps://app.allpost.co/in/api/<workspaceUuid>/posts/{postUuid}

AuthorizationBearer <token>

Body:

{
  "date": "2025-02-23",
  "time": "16:00",
  "timezone": "Africa/Lagos",
  "accounts": [1,2,3],
  "tags": [1,2],
  "versions": [
    {
      "account_id": 0,
      "is_original": true,
      "content": [
        {
          "body": "This is the content v2",
          "media": [1]
        }
      ],
      "options": {
        "mastodon": {
          "sensitive": false
        }
      }
    }
  ]
}

Response: 200

{
  "success": true,
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}
{
  "message": "Post not found."
}

Response: 422

{
  "message": "Validation errors",
  "errors": {}
}

Delete a post

Method: DELETE

URLhttps://app.allpost.co/in/api/<workspaceUuid>/posts/{postUuid}

AuthorizationBearer <token>

Body:

{
  "trash": false
}

Key: trash

Format: boolean

Required:

Description: Set true to move the item to trash; set false to delete it permanently. Default: false.

Response: 200

Permanently deleted:

{
  "deleted": true
}

Moved to trash:

{
  "to_trash": true
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}

Delete multiple post

Method: DELETE

URLhttps://app.allpost.co/in/api/<workspaceUuid>/posts

AuthorizationBearer <token>

Body:

{
  "posts": ['8eb4e98d-2b93-44bd-a664-7a6438eff67b', 'b1b06706-ef95-42b7-8ac8-d648dc9a9d65'],
  "trash": false
}

KeyFormatRequiredDescriptionpostsarrayrequiredArray of posts Uuidsposts.*stringrequiredPost UuidtrashbooleanSet true to move the item to trash; set false to delete it permanently. Default: false.

Response: 200

Permanently deleted:

{
  "deleted": true
}

Moved to trash:

{
  "to_trash": true
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}

Response: 422

{
  "message": "Validation errors",
  "errors": {}
}

Schedule a post

Method: POST

URLhttps://app.allpost.co/in/api/<workspaceUuid>/posts/schedule/{postUuid}

AuthorizationBearer <token>

Body:

{
  "postNow": true
}

Key: postNow

Format: boolean

Required: required

Description: Set to true to schedule the post now. Set to false to schedule the post at the set post time.

Response: 200

{
  "success": true,
  "scheduled_at": "2024-05-02 08:49:15",
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}
{
  "message": "Post not found."
}

Response: 422

{
  "message": "Validation errors",
  "errors": {}
}

Add a post to Queue

Method: POST

URLhttps://app.allpost.co/in/api/<workspaceUuid>/posts/add-to-queue/{postUuid}

AuthorizationBearer <token>

Response: 200

{
  "success": true,
  "scheduled_at": "2024-05-02 08:49:15",
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}
{
  "message": "Post not found."
}

Response: 422

{
  "message": "Validation errors",
  "errors": {}
}

Approve a post

Method: POST

URLhttps://app.allpost.co/in/api/<workspaceUuid>/posts/approve/{postUuid}

AuthorizationBearer <token>

Response: 200

{
  "success": true,
  "scheduled_at": "2024-05-02 08:49:15",
}

Response: 401

{
  "message": "Unauthenticated."
}

Response: 403

{
  "message": "Access forbidden."
}

Response: 404

{
  "message": "Workspace not found."
}
{
  "message": "Post not found."
}

Response: 422

{
  "message": "Validation errors",
  "errors": {}
}