antworkDOCS

Getting an account

One connected account, the settings a post to it takes, and on Pinterest its boards.

GEThttps://antwork.io/api/v1/accounts/{id}Scoperead

Request

curl https://antwork.io/api/v1/accounts/acc_pinterest \
  -H "Authorization: Bearer $ANTWORK_API_KEY"

The account as GET /api/v1/accounts lists it, plus settings, the per-post fields its platform takes. Needs the read scope.

Response

200 OK
{
  "object": "account",
  "id": "acc_pinterest",
  "workspaceId": "ws_...",
  "platform": "pinterest",
  "name": "Antwork",
  "handle": "antwork",
  "accountType": "business",
  "active": true,
  "tokenHealth": "healthy",
  "connectedAt": "2026-01-05T09:00:00.000Z",
  "settings": [
    {
      "key": "pinTitle",
      "label": "Pin title",
      "type": "text",
      "maxLength": 100,
      "placeholder": "Optional"
    },
    {
      "key": "link",
      "label": "Destination link",
      "type": "url",
      "maxLength": 2048,
      "placeholder": "https://…"
    }
  ],
  "boards": [
    { "id": "1234567890", "name": "Product updates" }
  ]
}

On Pinterest, boards is the account's live board list. A pin goes to a board, and this is where its id comes from. If Pinterest refuses the lookup, boards is null and boardsError says why; reconnect: true means the account needs reconnecting in Antwork.

An account that does not exist or is not yours answers 404 with account_not_found.