Pinterest Invites API
The Invites API from Pinterest — 3 operation(s) for invites.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/pinterest-invites-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 5.13.0
title: Pinterest Invites API
description: This is the description of your API.
contact:
name: Pinterest, Inc.
url: https://developers.pinterest.com/
license:
name: MIT
url: https://spdx.org/licenses/MIT
termsOfService: https://developers.pinterest.com/terms/
servers:
- url: https://api.pinterest.com/v5
tags:
- name: Invites
paths:
/businesses/invites:
patch:
summary: Accept or decline an invite/request
description: Accept or decline invites or requests.
operationId: respond_business_access_invites
security:
- pinterest_oauth2:
- biz_access:read
- biz_access:write
x-ratelimit-category: ads_write
x-sandbox: enabled
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthRespondInvitesBody'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RespondToInvitesResponseArray'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
tags:
- Invites
components:
schemas:
RespondToInvitesResponseArray:
type: object
properties:
items:
type: array
description: List of invite/request accept/decline status. If there is an error, an exception object will be returned. If the invite/request was successfully accepted/declined, an invite object will be returned.
items:
type: object
properties:
exception:
$ref: '#/components/schemas/InviteExceptionResponse'
invite:
description: An invite object for the invite/request that was successfully accepted/declined. Will only be provided if the an invite/request is successfully created.
$ref: '#/components/schemas/BaseInviteDataResponse'
BusinessAccessUserSummary:
type: object
description: Metadata of the member/partner that has access to the asset.
properties:
email:
description: Email of the business member/partner.
example: business0101@business.com
type:
- string
- 'null'
id:
description: Unique identifier of the business member/partner.
example: '383791336903426391'
type:
- string
- 'null'
minLength: 1
maxLength: 20
username:
description: Username of the business member/partner.
example: business0101
type:
- string
- 'null'
AuthRespondInvitesBody:
description: An object with a list of all the invites the user would like to respond to and the action to take.
type: object
required:
- invites
properties:
invites:
type: array
minItems: 1
maxItems: 100
items:
properties:
action:
type: object
properties:
accept_invite:
description: Whether the invite/request is accepted.
type: boolean
asset_id_to_permissions:
$ref: '#/components/schemas/AssetIdToPermissions'
required:
- accept_invite
invite_id:
description: Unique identifier of an invite.
pattern: ^\d+$
type: string
minLength: 1
maxLength: 25
required:
- invite_id
- action
type: object
AssetIdToPermissions:
description: 'An object mapping asset ids to lists of business permissions. This can be used to setting/requesting permissions on various assets. If accepting an invite or request, this object would be used to grant asset permissions to the member or partner.
'
type: object
minProperties: 1
additionalProperties:
type: array
minItems: 1
maxItems: 50
items:
$ref: '#/components/schemas/Permissions'
example:
'549760723247':
- ANALYST
'549760723248':
- ANALYST
- ADMIN
'809944451643622187':
- PROFILE_PUBLISHER
Error:
title: Error
type: object
properties:
code:
type: integer
message:
type: string
required:
- code
- message
BaseInviteDataResponse:
type:
- object
- 'null'
properties:
id:
type: string
description: Unique identifier of the invite/request.
example: '383791336903426391'
pattern: ^\d+$
invite_data:
type: object
description: Metadata for the invite/request.
properties:
invite_expiration:
type: integer
description: The date and time when the invite/request will expire. Returned in milliseconds.
example: 1709748104775
invite_status:
type: string
description: The current status of the invite. The invite can be in one of the following states PENDING, ACCEPTED, DECLINED, CANCELLED, EXPIRED.
example: PENDING
invite_type:
type: string
description: The type of invite. <br>'MEMBER_INVITE' is to invite a member to access your business assets. <br>'PARTNER_INVITE' is to invite a partner to access your business assets. <br>'PARTNER_REQUEST' is to request access a partner's business assets.
example: MEMBER_INVITE
last_updated_time:
type: integer
description: The date and time the invite/request was last updated. Returned in milliseconds.
example: 1646767577816
sent_at:
type: integer
description: The date and time the invite/request was sent/created. Returned in milliseconds.
example: 1646767577816
is_received_invite:
type: boolean
description: Indicates whether the invite/request was received.
user:
type: object
description: Metadata for the member/partner that was sent the invite/request.
allOf:
- $ref: '#/components/schemas/BusinessAccessUserSummary'
InviteExceptionResponse:
type:
- object
- 'null'
description: An exception object if there is an error performing the action. Will only be provided if there is an error.
properties:
invite_or_request_id:
type:
- string
- 'null'
description: Unique identifier of the invite/request.
example: '383791336903426391'
pattern: ^\d+$
code:
type: integer
description: Error code associated with the error in performing the action on the invite/request.
example: 403
message:
type: string
description: Error message associated with the error in performing the action on the invite/request.
example: You hit the maximum number of pending invites allowed.
users_or_partner_ids:
type:
- array
- 'null'
description: A list of users' usernames or emails OR a list of partner ids that caused the error.
example:
- businessMember0101
- business+member@business.com
items:
type: string
description: A user's username or email OR a partner id that caused the error.
Permissions:
type: string
enum:
- ADMIN
- ANALYST
- FINANCE_MANAGER
- AUDIENCE_MANAGER
- CAMPAIGN_MANAGER
- CATALOGS_MANAGER
- PROFILE_PUBLISHER
securitySchemes:
pinterest_oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://www.pinterest.com/oauth/
tokenUrl: https://api.pinterest.com/v5/oauth/token
scopes:
ads:read: See all of your advertising data, including ads, ad groups, campaigns etc.
ads:write: Create, update, or delete ads, ad groups, campaigns etc.
billing:read: See all of your billing data, billing profile, etc.
billing:write: Create, update, or delete billing data, billing profiles, etc.
biz_access:read: See business access data
biz_access:write: Create, update, or delete business access data
boards:read: See your public boards, including group boards you join
boards:read_secret: See your secret boards
boards:write: Create, update, or delete your public boards
boards:write_secret: Create, update, or delete your secret boards
catalogs:read: See all of your catalogs data
catalogs:write: Create, update, or delete your catalogs data
pins:read: See your public Pins
pins:read_secret: See your secret Pins
pins:write: Create, update, or delete your public Pins
pins:write_secret: Create, update, or delete your secret Pins
user_accounts:read: See your user accounts and followers
user_accounts:write: Update your user accounts and followers
conversion_token:
type: http
scheme: bearer
description: This security scheme only applies to the conversion events endpoint (POST /ad_accounts/{ad_account_id}/events). This endpoint requires a bearer token generated via Ads Manager (ads.pinterest.com).
basic:
type: http
scheme: basic
x-tagGroups:
- name: Pin and Boards
tags:
- pins
- boards
- media
- aggregated_comments
- aggregated_pin_data
- user_account
- name: Campaign Management
tags:
- ad_accounts
- campaigns
- ad_groups
- ads
- product_group_promotions
- bulk
- name: Targeting
tags:
- audiences
- customer_lists
- keywords
- targeting_template
- audience_insights
- audience_sharing
- name: Ad Formats
tags:
- lead_forms
- lead_ads
- leads_export
- name: Billing
tags:
- billing
- order_lines
- terms_of_service
- name: Business Access
tags:
- business_access_assets
- business_access_invite
- business_access_relationships
- name: Conversions
tags:
- conversion_events
- conversion_tags
- name: Others
tags:
- integrations
- oauth
- resources
- search
- terms
- name: Shopping
tags:
- catalogs
- name: Deprecated
tags:
- product_groups