Skip to content

List board lists

GET
/v1/accounts/{accountId}/board-lists

List all board lists (collections of boards) for an account.

Authorizations

Parameters

Path Parameters

accountId
required
string

Pinterest account ID

Responses

200

List of board lists

object
data
object
boardLists
Array<object>
object
id

Board list ID

integer
name

Board list name

string
nullable
accountId

Account ID

string
boards
Array<object>
object
id

Board ID

string
order

Order in the list

integer
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"
}
}