PIpinterest
user_account

Get user account

Changed on

Get account information for the "operation user_account"

  • By default, the "operation user_account" is the token user_account.

If using Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". See Understanding Business Access for more information.

get/user_account

Request

  • Base URL
    https://api.pinterest.com/v5
  • Auth
    • OAuth 2
      Authorization codehttps://www.pinterest.com/oauth/
      Token URLhttps://api.pinterest.com/v5/oauth/token
      Scopesuser_accounts:read
    • or OAuth 2
      Client credentials
      Token URLhttps://api.pinterest.com/v3/oauth/access_token/
      Scopesuser_accounts:read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Response

The request has succeeded.

aboutstring

Profile about description.

account_type'PINNER' | 'BUSINESS'
board_countinteger nullable

User account board count. Note: Board count on user account level may differ from counts found elsewhere due to attribution of collaborative Boards.

business_namestring nullable
follower_countinteger nullable

User account follower count.

following_countinteger nullable

User account following count.

idstring

User account ID.

monthly_viewsinteger nullable

User account monthly views.

pin_countinteger nullable

User account pin count. This includes both created and saved pins.

profile_imagestring
usernamestring
website_urlstring

Example response

{
  "board_count": 14,
  "follower_count": 10,
  "following_count": 347,
  "id": "2783136121146311751",
  "monthly_views": 163,
  "pin_count": 339
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      the response's property type changed from string to no type for status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added to the response property allOf list for the response status

    • info

      removed the BUSINESS enum value from the response property for the response status

    • info

      removed the PINNER enum value from the response property for the response status

  • v589c27ed39cfdRevision changes
    • info

      the endpoint scheme security client_credentials was added to the API