Skip to content

Get Post API

The Get Post API retrieves a single post by its ID. Use it after creating a post to read back the stored content, its overall status, attached media, and the per-platform publishing details for that exact postId.

Endpoint

The Get Post API retrieves a single post by its ID. Call it with the postId returned when the post was created, then inspect the returned post object to confirm its content, status, scheduling fields, media, and platform-level results. The request uses the GET method shown in the endpoint example below, with the postId placed in the path and an x-access-key header supplying the API key.

Path Parameters

The only path parameter is postId, a string. It is the post ID returned when creating a post, so copy that value exactly into the path segment. Do not substitute a platform post identifier such as platformPostId: that value identifies the published item on a destination platform and appears inside the response, whereas postId identifies the stored post itself. If the identifier does not match a stored post, the documented result is a 404 response meaning Post not found.

Example

The worked example retrieves post_abc123 using the documented request pattern. Replace YOUR_API_KEY with your own key and post_abc123 with the postId you want to read. A successful call returns a JSON body whose success flag is true and whose post object contains the full record described in the response field map below. Check the HTTP status first, then read the post fields; do not assume a post exists merely because the request was well formed.

Response

The top-level response contains success and post. Inside post, postId echoes the requested identifier and content holds the post text. The status field gives the overall state, such as published in the example, while scheduledFor is null when no schedule applies and timezone records the scheduling timezone, shown as UTC in the example. The mediaItems array lists attached media, with each item carrying type, url, filename, size, and mimeType; in the example a single image item has an empty filename and mimeType and a size of 0. The platforms array breaks results down per destination: platform names the destination, status gives that destination's state, platformPostId and platformPostUrl identify and link to the published item, publishedAt records when it was published, and errorMessage is null when there is no error. At the post level, crosspostingEnabled indicates whether crossposting was enabled, and createdAt and updatedAt record creation and last-update timestamps. When reading platform results, use platformPostId together with platformPostUrl to locate the published item, and treat a null errorMessage as the absence of a reported error for that platform entry.

Status Codes

A 200 response means the request succeeded and the post object is present in the body. A 404 response means Post not found, so verify that the postId matches the value returned at creation time and that you are querying the intended account before retrying. Only these two status codes are documented for this endpoint, so handle any other outcome as an unexpected condition rather than mapping it to a documented meaning.

Path parameters
ParameterTypeDescription
postIdstringThe post ID returned when creating a post

Documented path parameter for the Get Post API.

Response field map
FieldTypeNullabilityDescription
successbooleanNot null in exampleWhether the request succeeded; true in the example.
postobjectNot null in exampleThe retrieved post record.
post.postIdstringNot null in exampleThe post ID, matching the requested postId.
post.contentstringNot null in exampleThe post content; "Hello world!" in the example.
post.statusstringNot null in exampleOverall post status; "published" in the example.
post.scheduledForstring or nullNullableScheduled time, or null when not scheduled; null in the example.
post.timezonestringNot null in exampleScheduling timezone; "UTC" in the example.
post.mediaItemsarrayNot null in exampleAttached media items.
post.mediaItems[].typestringNot null in exampleMedia type; "image" in the example.
post.mediaItems[].urlstringNot null in exampleMedia URL.
post.mediaItems[].filenamestringNot null in exampleMedia filename; empty string in the example.
post.mediaItems[].sizenumberNot null in exampleMedia size; 0 in the example.
post.mediaItems[].mimeTypestringNot null in exampleMedia MIME type; empty string in the example.
post.platformsarrayNot null in examplePer-platform publishing results.
post.platforms[].platformstringNot null in exampleDestination platform; "twitter" in the example.
post.platforms[].statusstringNot null in exampleStatus on that platform; "published" in the example.
post.platforms[].platformPostIdstringNot null in exampleIdentifier of the published post on that platform.
post.platforms[].platformPostUrlstringNot null in exampleURL of the published post on that platform.
post.platforms[].publishedAtstringNot null in exampleTimestamp when the post was published on that platform.
post.platforms[].errorMessagestring or nullNullableError message for that platform, or null when there is no error.
post.crosspostingEnabledbooleanNot null in exampleWhether crossposting was enabled; false in the example.
post.createdAtstringNot null in exampleCreation timestamp.
post.updatedAtstringNot null in exampleLast-update timestamp.

Field names, nesting, and null values preserved from the documented example response; types inferred from the example values.

Status codes
CodeMeaning
200Success
404Post not found

Only the documented status codes are listed.

Get Post API endpoint
GET {{API_BASE_URL}}/v1/posts/{postId}
Retrieve a post by ID with cURL
curl "{{API_BASE_URL}}/v1/posts/post_abc123" \
  -H "x-access-key: YOUR_API_KEY"
Example successful response
{
	"success": true,
	"post": {
		"postId": "post_abc123",
		"content": "A short example update.",
		"status": "published",
		"scheduledFor": null,
		"timezone": "UTC",
		"mediaItems": [
			{
				"type": "image",
				"url": "https://example.com/image.png",
				"filename": "",
				"size": 0,
				"mimeType": ""
			}
		],
		"platforms": [
			{
				"platform": "twitter",
				"status": "published",
				"platformPostId": "1234567890",
				"platformPostUrl": "https://twitter.com/you/status/1234567890",
				"publishedAt": "2026-04-15T14:30:00.000Z",
				"errorMessage": null
			}
		],
		"crosspostingEnabled": false,
		"createdAt": "2026-04-15T14:30:00.000Z",
		"updatedAt": "2026-04-15T14:30:01.000Z"
	}
}