Get a site's Instagram connection

Whether the site's Instagram account is connected, when its posts were last read, and the posts kept for its Instagram posts sections (newest first, pictures stored on the site).

GET/api/v1/sites/{site_id}/instagram

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the sites:read scope — read sites, pages and sections.

sites:readRead onlyMCP tool: get_instagram

Parameters

Named placeholders go in the path; the rest in the query string.

site_idstringPath · required: The site's id.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl

curl -X GET 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/instagram' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{
  "site_id": "SITE_ID"
}

Response schema

{
  "type": "object",
  "properties": {
    "available": {
      "type": "boolean",
      "description": "Instagram can be connected on this service (Workflow Corp's Instagram app keys are set). false = the section shows only its Follow button."
    },
    "connected": {
      "type": "boolean"
    },
    "username": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "is_sample": {
      "type": "boolean"
    },
    "read_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "When the posts were last read from Instagram (they are read again every hour)."
    },
    "problem": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Plain words for the last failed read; the last posts read stay on the site."
    },
    "posts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "permalink": {
            "type": "string",
            "description": "The post on Instagram."
          },
          "caption": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "description": "IMAGE, VIDEO (its cover picture is shown) or CAROUSEL_ALBUM."
          },
          "image_url": {
            "type": "string",
            "description": "The picture as stored on the site (never loaded from Instagram)."
          },
          "posted_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "permalink",
          "caption",
          "kind",
          "image_url",
          "posted_at"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "available",
    "connected",
    "username",
    "is_sample",
    "read_at",
    "problem",
    "posts"
  ],
  "additionalProperties": false
}