Modbot Docs

List posts

GET/api/posts

One page of one list on the Marketing tab, with how many posts each list holds. list is scheduled (soonest first), sent and drafts (newest first), failed, or cancelled. A post that went to one site and failed on another is in failed and in whatever else it is. Each destination's shown says what the list shows: its state, or for one waiting on a site that sends nothing now, paused, off or notSetUp. vrChatRoles are the VRChat group's roles as the last group read found them, for choosing who a VRChat post is for.

Needs the ViewPosts permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Query Parameters

list?string
page?integer
Formatint32

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/posts"
{  "list": "string",  "posts": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": null,      "text": "string",      "pictureId": null,      "status": "string",      "lists": [        "string"      ],      "sendAt": null,      "sendAtLocal": null,      "timeZone": "string",      "eventId": null,      "eventTitle": null,      "kind": null,      "version": 0,      "createdBy": null,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "cancelledAt": null,      "destinations": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "network": "string",          "target": "string",          "targetName": null,          "roleId": null,          "roleName": null,          "publish": true,          "state": "string",          "shown": "string",          "link": null,          "externalId": null,          "error": null,          "errorAt": null,          "notPublished": true,          "mayBeSent": true,          "titleOverride": null,          "textOverride": null,          "sentText": null,          "sentAt": null,          "postedAt": null,          "publishedAt": null,          "vrChat": null,          "missingPermission": null,          "bluesky": null        }      ],      "keepUpdated": false,      "listsUpdatedAt": null    }  ],  "counts": {    "scheduled": 0,    "sent": 0,    "drafts": 0,    "failed": 0,    "cancelled": 0  },  "page": 0,  "pageSize": 0,  "total": 0,  "canManage": true,  "sites": {    "paused": true,    "discordOn": true,    "discordSetUp": true,    "vrChatOn": true,    "vrChatSetUp": true,    "vrChatPictures": true,    "blueskyOn": false,    "blueskySetUp": false,    "vrChatPlus": null  },  "now": "2019-08-24T14:15:22Z",  "vrChatRoles": [    {      "id": "string",      "name": "string"    }  ],  "canAddEvents": false}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.