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
OAuth 2.0
OAuth Access Token Authenticate using your Pinterest OAuth access token. The token can be obtained through Pinterest’s OAuth 2.0 flow. Required Credentials Field Description Required Format Access Token Your Pinterest OAuth access token Yes -
OAuth 2.0 Authenticate using Pinterest OAuth 2.0 for full API access with token refresh capabilities. Required Credentials Field Description Required Format App ID Your Pinterest App ID from the developer portal Yes -App Secret Your Pinterest App Secret from the developer portal Yes -
OAuth Configuration
Authorization URL : https://www.pinterest.com/oauth/
Token URL : https://api.pinterest.com/v5/oauth/token
Scopes : boards:read, boards:write, pins:read, pins:write, user_accounts:read
Available Actions
list_boards — List all Pinterest boards for the authenticated user
Parameters Number of boards per page (max 250) (Default: 25)
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"
}
get_board_sections — Get sections of a Pinterest board to organize pins
Parameters The ID of the board to get sections from
Number of sections per page (max 250) (Default: 25)
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"
}
create_pin — Create a new pin on a Pinterest board with an image URL
Parameters The ID of the board to pin to
Source link/URL for the pin
Alt text for accessibility
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"
}
list_pins — List pins from a Pinterest board or board section
Parameters The ID of the board to list pins from
ID of the board section (optional)
Number of pins per page (max 250) (Default: 25)
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.
Links