How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pinterest Invites API

The Invites API from Pinterest — 3 operation(s) for invites.

Pinterest Invites API is one of 117 APIs that Pinterest publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Invites. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 5 operations across 3 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 5.13.0.

Requests are made against a single base URL, https://api.pinterest.com/v5.

5 operations 3 paths 22 schemas 1 DELETE1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.13.0
Base URL
https://api.pinterest.com/v5
Authentication
OAuth 2.0, HTTP Bearer, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 3

Pinterest Invites API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (pinterest_oauth2) using the authorizationCode flow, exposing 18 scopes. It accepts HTTP bearer tokens (conversion_token). It accepts HTTP basic authentication (basic).

  • conversion_token — This security scheme only applies to the conversion events endpoint (POST /adaccounts/{adaccountid}/events). This endpoint requires a bearer token generated vi…

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Invites 5
PATCH
/businesses/invites
Accept or decline an invite/request
respond_business_access_invites body → 200default
POST
/businesses/{business_id}/invites/assets/access
Update invite/request with an asset permission
create_asset_invites 1 param body → 200default
GET
/businesses/{business_id}/invites
Get invites/requests
get/invites 6 params → 200default
POST
/businesses/{business_id}/invites
Create invites or requests
create_membership_or_partnership_invites 1 param body → 200default
DELETE
/businesses/{business_id}/invites
Cancel invites/requests
cancel_invites_or_requests 1 param body → 200default

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are InviteResponse (5 properties), InviteExceptionResponse (4 properties), CreateMembershipOrPartnershipInvitesBody (4 properties), BaseInviteDataResponse (4 properties). Each schema is shown below with its type and property counts.

AssetIdToPermissions
object
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 r…
UpdateInvitesResultsResponseArray
object
1 property
CreateAssetInvitesRequestItem
object
Object declaring an asset role update to an invite.
3 properties 3 required
CreateInvitesResultsResponseArray
object
1 property
Permissions
string
BaseInviteDataResponse
objectnull
4 properties
InviteAssetsSummary
objectnull
Ad accounts and profiles the member/partner will be granted access to with this invite/request.
2 properties
AuthRespondInvitesBody
object
An object with a list of all the invites the user would like to respond to and the action to take.
1 property 1 required
Paginated
object
2 properties 1 required
CreateAssetInvitesRequest
object
Request body for updating asset roles for existing invites.
1 property 1 required
InviteType
string
The type of invite. 'MEMBERINVITE' is to invite a member to access your business assets. 'PARTNER INVITE' is to invite a partner to access your business assets…
DeleteInvitesResultsResponseArray
object
Response to delete invites sent to Members or Partners, if there is an exception, return the exception mapped with the invite id
1 property
InviteBusinessRoleBinding
objectnull
An invite object if the invite/request was successfully updated. Will only be provided if the an invite/request is successfully updated.
3 properties
CancelInvitesBody
object
Request body used to cancel invites
1 property 1 required
InviteExceptionResponse
objectnull
An exception object if there is an error performing the action. Will only be provided if there is an error.
4 properties
BusinessRoleResponse
string
The access level a member/partner has to the business. Values are case-sensitive. - EMPLOYEE: Can only view and access assets you assign to them. They cannot s…
InviteResponse
object
5 properties
Error
object
2 properties 2 required
PermissionsResponse
array
Permission levels member or partner has on an asset.
RespondToInvitesResponseArray
object
1 property
CreateMembershipOrPartnershipInvitesBody
object
Body to be used on path to send Members or Partners Invite or Request
4 properties 2 required
BusinessAccessUserSummary
object
Metadata of the member/partner that has access to the asset.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pinterest-invites-api-openapi.yml Raw ↑

Other APIs Pinterest publishes across the network.

Pinterest Access API
Pinterest Accounts API
Pinterest Ad API
Pinterest Ad_groups API
Pinterest Ads API
Pinterest Analytics API
Pinterest Assets API
Pinterest Audience API
Pinterest Audience_insights API
Pinterest Audiences API
Pinterest Batch API
Pinterest Bid API
Where this information came from

This is an independent, third-party profile of Pinterest Invites API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.