API REFERENCE

Get Post

On this page

GET/api/posts/{id}

Availability: pending. This endpoint is specified ahead of implementation and is not yet live on the hosted API; it ships through recoupable/app#2241. Do not rely on it until this notice is removed.

One post, with its status, live post_url once posted, error_message if it failed, and text_verified once the live text has been re-read. This is the polling target after Create Post.

Authentication

x-api-key in header

bearerAuth bearer

Request

cURL

curl --request GET \
  --url 'https://api.recoupable.dev/api/posts/YOUR_ID' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Try it

Fill in the fields, send the request from your browser, and read the live response. The curl below updates as you type.

API keyx-api-key header

Kept in this browser tab only and cleared when it closes.

idpath · stringrequired

account_idquery · string

cURL for this request

curl --request GET \
  --url 'https://recoup-api.vercel.app/api/posts/{id}'

Parameters

Path parameters

idstringrequired

The post's id, from Create Post.

Query parameters

account_idstring

Optional. Act on behalf of another account you can access. Defaults to the calling account.

Responses

200The post.

application/json

statusstring · enum

Status of the request

Values: "success"

postobject

One post to one account.

Properties

idstring

The post's id.

format: uuid

account_idstring

The account whose connection posts.

format: uuid

platformstring · enum

Target platform. The account must have this platform connected.

Values: "instagram", "x", "linkedin", "youtube"

sub_account_idstring | null

LinkedIn organization URN when posting as a Page, else null.

statusstring · enum

Lifecycle phase. scheduled until publish_at, publishing while the platform upload runs, then posted or failed. cancelled only from scheduled.

Values: "scheduled", "publishing", "posted", "failed", "cancelled"

video_urlstring

The video that is or was published.

cover_urlstring | null

The cover or thumbnail image, if any.

titlestring | null

Submitted title.

descriptionstring | null

Submitted body text.

privacystring | null

Submitted YouTube visibility.

tagsarray | null

Submitted YouTube tags.

Properties

string

publish_atstring | null

Requested publish time. Null when published on creation.

format: date-time

post_urlstring | null

Live URL on the platform. Null until posted.

error_messagestring | null

Why publishing failed, as returned by the platform (e.g. a daily upload quota). Null unless status is failed.

text_verifiedboolean | null

Whether the live text, re-read from the platform after posting, equals the submitted title/description. Null until checked.

created_atstring

When the post was created.

format: date-time

updated_atstring

When the post last changed.

format: date-time

400id is not a valid uuid.

application/json

statusstring · enumrequired

Always error

Values: "error"

missing_fieldsarray<one of>

JSON path segments to the first field that failed validation, e.g. ["description"]

Item properties

oneOf · string 1

string

oneOf · integer 2

integer

errorstringrequired

Human-readable error message

401Unauthorized.

application/json

statusstring · enumrequired

Always error

Values: "error"

missing_fieldsarray<one of>

JSON path segments to the first field that failed validation, e.g. ["description"]

Item properties

oneOf · string 1

string

oneOf · integer 2

integer

errorstringrequired

Human-readable error message

403Access denied to this post's account.

application/json

statusstring · enumrequired

Always error

Values: "error"

missing_fieldsarray<one of>

JSON path segments to the first field that failed validation, e.g. ["description"]

Item properties

oneOf · string 1

string

oneOf · integer 2

integer

errorstringrequired

Human-readable error message

404No post with that id.

application/json

statusstring · enumrequired

Always error

Values: "error"

missing_fieldsarray<one of>

JSON path segments to the first field that failed validation, e.g. ["description"]

Item properties

oneOf · string 1

string

oneOf · integer 2

integer

errorstringrequired

Human-readable error message

500Internal server error.

application/json

statusstring · enumrequired

Always error

Values: "error"

missing_fieldsarray<one of>

JSON path segments to the first field that failed validation, e.g. ["description"]

Item properties

oneOf · string 1

string

oneOf · integer 2

integer

errorstringrequired

Human-readable error message

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download social.json

View operation source

json

{
  "summary": "Get post",
  "description": "**Availability: pending.** This endpoint is specified ahead of implementation and is not yet live on the hosted API; it ships through recoupable/app#2241. Do not rely on it until this notice is removed.\n\nOne post, with its status, live `post_url` once posted, `error_message` if it failed, and `text_verified` once the live text has been re-read. This is the polling target after [Create Post](/api-reference/publishing/create).",
  "security": [
    {
      "apiKeyAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "The post's id, from [Create Post](/api-reference/publishing/create)."
    },
    {
      "name": "account_id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Optional. Act on behalf of another account you can access. Defaults to the calling account."
    }
  ],
  "responses": {
    "200": {
      "description": "The post.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PostDetailResponse"
          }
        }
      }
    },
    "400": {
      "description": "`id` is not a valid uuid.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PostErrorResponse"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PostErrorResponse"
          }
        }
      }
    },
    "403": {
      "description": "Access denied to this post's account.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PostErrorResponse"
          }
        }
      }
    },
    "404": {
      "description": "No post with that id.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PostErrorResponse"
          }
        }
      }
    },
    "500": {
      "description": "Internal server error.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PostErrorResponse"
          }
        }
      }
    }
  },
  "x-recoup-availability": "pending"
}

Get started with Recoup.

Try Our Platform

Build Your Platform

Get Post

Authentication

Request

Try it

Parameters

Path parameters

Query parameters

Responses

Full specification