Skip to content

List boards

GET
/v1/accounts/{accountId}/boards

List all Pinterest boards for an account.

Authorizations

Parameters

Path Parameters

accountId
required
string

Pinterest account ID

Responses

200

List of boards

object
data
object
boards
Array<object>
object
id

Board ID

string
name

Board name

string
isCollaborator

Whether the user is a collaborator

boolean
isSecret

Whether the board is secret

boolean
meta
object
requestId

Unique request ID for debugging

string

401

Authentication required or invalid API key

object
error
object
code

Error code

string
message

Error message

string
meta
object
requestId

Unique request ID for debugging

string
Example
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
},
"meta": {
"requestId": "abc123"
}
}

404

Resource not found

object
error
object
code

Error code

string
message

Error message

string
meta
object
requestId

Unique request ID for debugging

string
Example
{
"error": {
"code": "NOT_FOUND",
"message": "Account not found"
},
"meta": {
"requestId": "abc123"
}
}