Skip to main content
Pinterest logo

Overview

Add Pinterest to any ModuleX agent or workflow. Manage boards, board sections, and pins via the Pinterest REST API v5.
Categories: Social Media · Marketing & Email · Social Media · Automation · Development · Miscellaneous · Pinterest · Auth: OAuth Access Token, OAuth 2.0 · Actions: 4

Authentication

OAuth Access Token

Authenticate using your Pinterest OAuth access token. The token can be obtained through Pinterest’s OAuth 2.0 flow.

Required Credentials

FieldDescriptionRequiredFormat
Access TokenYour Pinterest OAuth access tokenYes-

Available Actions

Parameters

page_size
integer
Number of boards per page (max 250) (Default: 25)
bookmark
string
Cursor for pagination to get the next page

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "boards": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Boards",
      "type": "array"
    },
    "count": {
      "default": 0,
      "title": "Count",
      "type": "integer"
    },
    "bookmark": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Bookmark"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListBoardsOutput",
  "type": "object"
}

Parameters

board_id
string
required
The ID of the board to get sections from
page_size
integer
Number of sections per page (max 250) (Default: 25)
bookmark
string
Cursor for pagination

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "board_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Board Id"
    },
    "sections": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Sections",
      "type": "array"
    },
    "count": {
      "default": 0,
      "title": "Count",
      "type": "integer"
    },
    "bookmark": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Bookmark"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetBoardSectionsOutput",
  "type": "object"
}

Parameters

board_id
string
required
The ID of the board to pin to
title
string
required
Title of the pin
media_url
string
required
URL of the image to pin
description
string
Description of the pin
Source link/URL for the pin
alt_text
string
Alt text for accessibility
board_section_id
string
ID of the board section

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "title": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Title"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Description"
    },
    "link": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Link"
    },
    "board_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Board Id"
    },
    "board_section_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Board Section Id"
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Created At"
    },
    "pin": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Pin"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreatePinOutput",
  "type": "object"
}

Parameters

board_id
string
required
The ID of the board to list pins from
board_section_id
string
ID of the board section (optional)
page_size
integer
Number of pins per page (max 250) (Default: 25)
bookmark
string
Cursor for pagination

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "board_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Board Id"
    },
    "board_section_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Board Section Id"
    },
    "pins": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Pins",
      "type": "array"
    },
    "count": {
      "default": 0,
      "title": "Count",
      "type": "integer"
    },
    "bookmark": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Bookmark"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListPinsOutput",
  "type": "object"
}

Limits & Quotas

  • page_size is clamped to [1, 250].
  • 401 → auth error; 404 → resource-not-found; 400 on create → likely invalid media_url or board id.

Klaviyo

ServiceNow

Telegram Bot