Get Pinterest Boards
This endpoint is crucial for uploads, as it provides you with the necessary ID
to specify which Pinterest Board you want to send your content to.
Get Pinterest Boards
This endpoint allows you to get a list of all boards (public and secret) from a connected Pinterest account. You will need a board ID
to post a Pin to it.
-
Method:
GET
-
Endpoint:
/api/uploadposts/pinterest/boards
-
Authentication:
- API Key in the
Authorization
header.Authorization: Api-Key <YOUR_API_KEY>
- API Key in the
-
Query Parameters:
Parameter | Type | Description | Required |
---|---|---|---|
profile | string | Optional. The profile's username . If provided, the API will return only the boards from the Pinterest account linked to that specific profile. | No |
- Successful Response (
200 OK
)
The response will include a list of objects, where each object represents a Pinterest board.
{
"success": true,
"boards": [
{
"id": "987654321098765432",
"name": "Summer Recipes"
},
{
"id": "876543210987654321",
"name": "Design Inspiration"
}
],
"pinterest_account_used": "pinterest_username"
}
- Additional Notes:
- To post a Pin, you must pass the board
id
in thepinterest_board_id
parameter of the upload endpoint (/api/upload
or/api/upload_photos
). - If a
profile
is not specified, the API will use the first Pinterest account it finds connected to the user. The response will tell you which account was used in thepinterest_account_used
field.
- To post a Pin, you must pass the board