{
"opencollection": "1.0.0",
"info": {
"name": "Pinterest Board API",
"version": "5.13.0"
},
"items": [
{
"info": {
"name": "Board",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get board",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/boards/:board_id",
"params": [
{
"name": "board_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board."
},
{
"name": "ad_account_id",
"value": "",
"type": "query",
"description": "Unique identifier of an ad account."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get a board owned by the operation user_account - or a group board that has been shared with this account.\n- Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account."
},
{
"info": {
"name": "Update board",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pinterest.com/v5/boards/:board_id",
"params": [
{
"name": "board_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board."
},
{
"name": "ad_account_id",
"value": "",
"type": "query",
"description": "Unique identifier of an ad account."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update a board owned by the \"operating user_account\".\n- Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account."
},
{
"info": {
"name": "Delete board",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pinterest.com/v5/boards/:board_id",
"params": [
{
"name": "board_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board."
},
{
"name": "ad_account_id",
"value": "",
"type": "query",
"description": "Unique identifier of an ad account."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Delete a board owned by the \"operation user_account\".\n- Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account."
},
{
"info": {
"name": "List Pins on board",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/boards/:board_id/pins",
"params": [
{
"name": "board_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board."
},
{
"name": "bookmark",
"value": "",
"type": "query",
"description": "Cursor used to fetch the next page of items"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information."
},
{
"name": "creative_types",
"value": "",
"type": "query",
"description": "Pin creative types filter. Note: SHOP_THE_PIN has been deprecated. Please use COLLECTION instead."
},
{
"name": "ad_account_id",
"value": "",
"type": "query",
"description": "Unique identifier of an ad account."
},
{
"name": "pin_metrics",
"value": "",
"type": "query",
"description": "Specify whether to return 90d and lifetime Pin metrics. Total comments and total reactions are only available with lifetime Pin metrics. If Pin was created before 2023-03-20 lifetime metrics will only be available for Video and Idea Pin formats. Lifetime metrics are available for all Pin formats since then."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get a list of the Pins on a board owned by the \"operation user_account\" - or on a group board that has been shared with this account.\n- Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account."
},
{
"info": {
"name": "List board sections",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/boards/:board_id/sections",
"params": [
{
"name": "board_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board."
},
{
"name": "ad_account_id",
"value": "",
"type": "query",
"description": "Unique identifier of an ad account."
},
{
"name": "bookmark",
"value": "",
"type": "query",
"description": "Cursor used to fetch the next page of items"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get a list of all board sections from a board owned by the \"operation user_account\" - or a group board that has been shared with this account.\nOptional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account."
},
{
"info": {
"name": "Create board section",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pinterest.com/v5/boards/:board_id/sections",
"params": [
{
"name": "board_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board."
},
{
"name": "ad_account_id",
"value": "",
"type": "query",
"description": "Unique identifier of an ad account."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Create a board section on a board owned by the \"operation user_account\" - or on a group board that has been shared with this account.\nOptional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account."
},
{
"info": {
"name": "Update board section",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.pinterest.com/v5/boards/:board_id/sections/:section_id",
"params": [
{
"name": "board_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board."
},
{
"name": "section_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board section."
},
{
"name": "ad_account_id",
"value": "",
"type": "query",
"description": "Unique identifier of an ad account."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update a board section on a board owned by the \"operation user_account\" - or on a group board that has been shared with this account.\nOptional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account."
},
{
"info": {
"name": "Delete board section",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pinterest.com/v5/boards/:board_id/sections/:section_id",
"params": [
{
"name": "board_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board."
},
{
"name": "section_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board section."
},
{
"name": "ad_account_id",
"value": "",
"type": "query",
"description": "Unique identifier of an ad account."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Delete a board section on a board owned by the \"operation user_account\" - or on a group board that has been shared with this account.\nOptional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account."
},
{
"info": {
"name": "List Pins on board section",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pinterest.com/v5/boards/:board_id/sections/:section_id/pins",
"params": [
{
"name": "board_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board."
},
{
"name": "section_id",
"value": "",
"type": "path",
"description": "Unique identifier of a board section."
},
{
"name": "ad_account_id",
"value": "",
"type": "query",
"description": "Unique identifier of an ad account."
},
{
"name": "bookmark",
"value": "",
"type": "query",
"description": "Cursor used to fetch the next page of items"
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://www.pinterest.com/oauth/",
"accessTokenUrl": "https://api.pinterest.com/v5/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get a list of the Pins on a board section of a board owned by the \"operation user_account\" - or on a group board that has been shared with this account.\nOptional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the \"operation user_account\".\n- By default, the \"operation user_account\" is the token user_account."
}
]
}
],
"bundled": true
}