Get scheduled posts calendar view

POST 
/social-media-posting/category/queues/list/calendar

Returns scheduled posts from active queues within a date range. Supports filtering by categories and accounts.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

startDatestringrequired

Start Date in ISO format

endDatestringrequired

End Date in ISO format

categoryIdsstring[]

Category Id

accountIdsstring[]

Filter by Account IDs. If not provided or empty, returns all posts.

Example (auto)

{
  "locationId": "609e126a1c4ae1001291e1b5",
  "startDate": "2023-10-01T00:00:00.000Z",
  "endDate": "2023-10-31T23:59:59.999Z",
  "categoryIds": [
    "64e431dcaf507c4b26dbdf8b"
  ],
  "accountIds": [
    "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496"
  ]
}

application/json

Calendar list fetched successfully.

application/json

Schema

Schema

successbooleanrequired

Success or Failure

statusCodenumberrequired

Status Code

resultsobjectrequired

Response payload

traceIdstring

Trace ID for debugging

Example (auto)

{
  "success": true,
  "statusCode": 201,
  "results": {
    "message": "Calendar list fetched successfully",
    "scheduledPosts": [
      {
        "_id": "60af88475f1b2c001f5d5f4b",
        "order": 1000,
        "variations": [
          {
            "_id": "60af88475f1b2c001f5d5f4c",
            "content": "Check out our latest blog post! #marketing #socialmedia",
            "mentions": [
              {
                "platform": "instagram",
                "username": "example_user",
                "offset": 10,
                "length": 12
              }
            ],
            "ogTags": {
              "metaLink": "https://example.com",
              "metaImage": "https://example.com/image.png",
              "ogTitle": "Example Title"
            }
          }
        ],
        "primaryImage": "https://example.com/images/post-image.png",
        "postId": "60af88475f1b2c001f5d5f4d",
        "post": {
          "_id": "60af88475f1b2c001f5d5f4d",
          "summary": "Scheduled queue post",
          "media": [],
          "type": "post"
        },
        "errors": [],
        "scheduledDateTime": "2023-10-15T10:00:00.000Z",
        "scheduledVariationIndex": 0,
        "isSkipped": false,
        "category": {
          "_id": "6756f381be2553245b08d30c",
          "name": "Category Name",
          "primaryColor": "#FFFFFF",
          "secondaryColor": "#000000",
          "deleted": false,
          "locationId": "fvg1TXIiVxGcdOaL0riG",
          "createdBy": "SQ6d63Va2PUbWEZ9k0TD",
          "createdAt": "2024-12-09T13:41:21.385Z",
          "updatedAt": "2024-12-09T13:41:21.385Z"
        },
        "timezone": "America/New_York"
      }
    ],
    "total": 25,
    "timezone": "America/New_York"
  },
  "traceId": "TRACE-abc123-def456"
}