Sign in
boards

List boards

Get a list of the boards owned by the "operation user_account" + group boards where this account is a collaborator Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". Optional: Specify a privacy type (public, protected, or secret) to indicate which boards to return.

  • If no privacy is specified, all boards that can be returned (based on the scopes of the token and ad_account role if applicable) will be returned.
get/boards

Query parameters

ad_account_idstring

Unique identifier of an ad account.

privacy'ALL' | 'PUBLIC' | 'PROTECTED' | 'SECRET' | 'PUBLIC_AND_SECRET'

The privacy level of the board

bookmarkstring

Cursor used to fetch the next page of items

page_sizeinteger

Maximum number of items to include in a single page. See documentation on Pagination for more information.

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "collaborator_count": 17,
      "description": "My favorite summer recipes",
      "follower_count": 13,
      "id": "549755885175",
      "is_ads_only": true,
      "media": {
        "image_cover_url": "https://i.pinimg.com/400x300/fd/cd/d5/fdcdd5a6d8a80824add0d054125cd957.jpg",
        "pin_thumbnail_urls": [
          "https://i.pinimg.com/150x150/b4/57/10/b45710f1ede96af55230f4b43935c4af.jpg",
          "https://i.pinimg.com/150x150/dd/ff/46/ddff4616e39c1935cd05738794fa860e.jpg",
          "https://i.pinimg.com/150x150/84/ac/59/84ac59b670ccb5b903dace480a98930c.jpg",
          "https://i.pinimg.com/150x150/4c/54/6f/4c546f521be85e30838fb742bfff6936.jpg"
        ]
      },
      "name": "Summer recipes",
      "pin_count": 5
    }
  ]
}

Changes

Changed in 8 of the 29 revisions of this API.320

  • v514c297539b6418See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      removed Paginated subschema #2 from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the optional property bookmark to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property items to the response with the 200 status

      response-required-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v543134ca41f181See the full diff
    • ○

      added the optional property allOf[subschema #2]/items/items/is_ads_only to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v589c27ed39cfd1See the full diff
    • ○

      the endpoint scheme security client_credentials was added to the API

      api-security-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5f9321315766f1See the full diff
    • ▲

      the allOf[subschema #2]/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v57529b464d5cb2See the full diff
    • ○

      added the new enum value ALL to the query request parameter privacy

      request-parameter-enum-value-added

    • ○

      added the new enum value PUBLIC_AND_SECRET to the query request parameter privacy

      request-parameter-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5689b4b2676397See the full diff
    • ○

      added the new optional query request parameter ad_account_id

      new-optional-request-parameter

    • ○

      added the optional property allOf[subschema #2]/items/items/board_pins_modified_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/items/items/collaborator_count to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/items/items/created_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/items/items/follower_count to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/items/items/media to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/items/items/pin_count to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5e041d7b0cef01See the full diff
    • ○

      for the query request parameter page_size, the max was increased from 100.00 to 250.00

      request-parameter-max-increased

  • v58583f6373a801See the full diff
    • ▲

      the allOf[subschema #2]/items/items/owner response's property type/format changed from / to object/ for status 200

      response-property-type-changed