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 Business API

The Business API from Pinterest — 13 operation(s) for business.

Pinterest Business 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 Business. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 22 operations across 13 paths, and defines 55 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.

22 operations 13 paths 55 schemas 6 DELETE9 GET4 PATCH3 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 Business 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 22

Across 13 paths, the API surfaces 22 operations — 6 DELETE, 9 GET, 4 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Business 22
GET
/businesses/{business_id}/assets/{asset_id}/members
Get members with access to asset
business_asset_members/get 5 params → 200default
GET
/businesses/{business_id}/assets/{asset_id}/partners
Get partners with access to asset
business_asset_partners/get 5 params → 200default
POST
/businesses/{business_id}/invites/assets/access
Update invite/request with an asset permission
create_asset_invites 1 param body → 200default
POST
/businesses/{business_id}/requests/assets/access
Create a request to access an existing partner's assets.
asset_access_requests/create 1 param body → 200default
GET
/businesses/{business_id}/members
Get business members
get/business_members 7 params → 200default
PATCH
/businesses/{business_id}/members
Update member's business role
update/business_memberships 1 param body → 200default
DELETE
/businesses/{business_id}/members
Terminate business memberships
delete_business_membership 1 param body → 200default
GET
/businesses/{business_id}/assets
List business assets
business_assets/get 6 params → 200default
GET
/businesses/{business_id}/members/{member_id}/assets
Get assets assigned to a member
business_member_assets/get 6 params → 200default
PATCH
/businesses/{business_id}/members/assets/access
Assign/Update member asset permissions
business_members_asset_access/update 1 param body → 200default
DELETE
/businesses/{business_id}/members/assets/access
Delete member access to asset
business_members_asset_access/delete 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
PATCH
/businesses/{business_id}/partners/assets
Assign/Update partner asset permissions
update_partner_asset_access_handler_impl 1 param body → 200default
DELETE
/businesses/{business_id}/partners/assets
Delete partner access to asset
delete_partner_asset_access_handler_impl 1 param body → 200default
GET
/businesses/{business_id}/partners/{partner_id}/assets
Get assets assigned to a partner or assets assigned by a partner
business_partner_asset_access/get 7 params → 200default
GET
/businesses/{business_id}/partners
Get business partners
get/business_partners 7 params → 200default
DELETE
/businesses/{business_id}/partners
Terminate business partnerships
delete_business_partners 1 param body → 200404default
GET
/integrations/commerce/{external_business_id}
Get commerce integration
integrations_commerce/get 1 param → 200404409default
PATCH
/integrations/commerce/{external_business_id}
Update commerce integration
integrations_commerce/patch 1 param body → 200404409default
DELETE
/integrations/commerce/{external_business_id}
Delete commerce integration
integrations_commerce/del 1 param → 204default

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are IntegrationMetadata (14 properties), IntegrationRequestPatch (12 properties), UserBusinessRoleBinding (8 properties), InviteResponse (5 properties). Each schema is shown below with its type and property counts.

CreateAssetAccessRequestResponse
object
2 properties
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…
CreateAssetInvitesRequestItem
object
Object declaring an asset role update to an invite.
3 properties 3 required
UpdateInvitesResultsResponseArray
object
1 property
PermissionsWithOwner
string
AssetTypeResponse
string
Type of asset. Currently we only support ADACCOUNT and PROFILE.
UpdateMemberResult
object
2 properties
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
UpdateMemberResultsResponseArray
object
1 property
IntegrationMetadata
object
Integration metadata
14 properties
UserSingleAssetBinding
object
An object containing the permissions a business member/partner has on the asset.
2 properties
CreateInvitesResultsResponseArray
object
1 property
DeletedMembersResponse
object
An object with a list of members that were deleted.
1 property
Paginated
object
2 properties 1 required
CreateAssetAccessRequestBody
object
An object containing a list of all the asset access requests
1 property 1 required
CreateAssetInvitesRequest
object
Request body for updating asset roles for existing invites.
1 property 1 required
IntegrationRequestPatch
object
Schema used for updating the integration metadata.
12 properties
DeletePartnersResponse
object
An object with a list of partners that were deleted.
1 property
UserBusinessRoleBinding
object
8 properties
UpdatePartnerAssetAccessBody
object
1 property 1 required
BusinessMemberAssetsSummary
objectnull
Ad accounts and profiles the business member/partner has access to.
2 properties
DeletePartnerAssetAccessBody
object
1 property 1 required
CreateAssetAccessRequestErrorMessage
arraynull
A list of errors associated with the asset access requests. Will be returned if there is an error.
UpdatePartnerAssetsResultsResponseArray
object
1 property
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
UpdateMemberAssetsResultsResponseArray
object
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
UpdatePartnerAssetsResult
object
An object containing the permissions a business partner has on the asset.
4 properties
GetPartnerAssetsResponse
object
An object containing the permissions a you/your business partner has on the asset.
3 properties
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…
DeleteMemberAccessResultsResponseArray
object
1 property
BusinessRoleCheckMode
string
Specifies if the partner is internal or external.
UpdateMemberBusinessRoleBody
object
Single instance of a business member to have its role updated
2 properties 2 required
InviteResponse
object
5 properties
DeletePartnersRequest
object
2 properties 1 required
Error
object
2 properties 2 required
DeletePartnerAssetsResult
object
The terminated asset access.
5 properties
GetBusinessAssetsResponse
object
An object containing the permissions a business has on the asset.
2 properties
UsersForIndividualAssetResponse
object
An object containing the permissions a business member has on the asset.
3 properties
MemberBusinessRole
string
The access level a member/partner has to the business. Values are case-sensitive. - EMPLOYEE: Can only view and access ad accounts you assign to them. They can…
DeleteMemberAccessResult
object
The terminated asset access.
2 properties
PermissionsResponse
array
Permission levels member or partner has on an asset.
CreateMembershipOrPartnershipInvitesBody
object
Body to be used on path to send Members or Partners Invite or Request
4 properties 2 required
BusinessRoleForMembers
string
The access level a member has to the business. Values are case-sensitive. - EMPLOYEE: Can only view and access assets you assign to them. They cannot see detai…
PartnerType
string
DeletePartnerAssetsResultsResponseArray
object
1 property
MembersToDeleteBody
object
1 property 1 required
UpdateMemberAssetAccessBody
object
An object with a list of all the new accesses.
1 property 1 required
BusinessAccessUserSummary
object
Metadata of the member/partner that has access to the asset.
3 properties
AssetIdPermissions
object
An object containing the permissions a business member has on the asset.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pinterest-business-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 Business 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.