Fetch items from a queue

POST 
/social-media-posting/category/queues/:queueId/items

Returns paginated queue items. Pass sessionId to get draft items from an edit session instead of live items.

Request

Version stringrequired

API Version

Available optionsv3

queueId stringrequired

Category queue ID

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

sessionIdstring

Edit session ID

skipnumber

Number of items to skip

limitnumber

Maximum number of items to return

errorFilterboolean

To return only queue items with errors

itemIdstring

Item ID to center the response around. When provided, the response will position this item in the center with items above and below based on limit. The skip parameter is ignored when itemId is provided.

Example (auto)

{
  "locationId": "609e126a1c4ae1001291e1b5",
  "sessionId": "60af88475f1b2c001f5d5f4b",
  "skip": 0,
  "limit": 10,
  "errorFilter": true,
  "itemId": "60af88475f1b2c001f5d5f4b"
}

application/json

Queue items 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": "Queue items fetched successfully",
    "items": [
      {
        "_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
      }
    ],
    "meta": {
      "count": "100",
      "skip": 0,
      "limit": 10
    }
  },
  "traceId": "TRACE-abc123-def456"
}