{ "opencollection": "1.0.0", "info": { "name": "Pinterest Business API", "version": "5.13.0" }, "items": [ { "info": { "name": "Business", "type": "folder" }, "items": [ { "info": { "name": "Get members with access to asset", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/businesses/:business_id/assets/:asset_id/members", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." }, { "name": "asset_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of a business asset." }, { "name": "bookmark", "value": "", "type": "query", "description": "Cursor used to fetch the next page of items" }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information." }, { "name": "start_index", "value": "0", "type": "query", "description": "An index to start fetching the results from. Only the results starting from this index will be returned." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all the members the requesting business has granted access to on the given asset." }, { "info": { "name": "Get partners with access to asset", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/businesses/:business_id/assets/:asset_id/partners", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." }, { "name": "asset_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of a business asset." }, { "name": "start_index", "value": "0", "type": "query", "description": "An index to start fetching the results from. Only the results starting from this index will be returned." }, { "name": "bookmark", "value": "", "type": "query", "description": "Cursor used to fetch the next page of items" }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all the partners the requesting business has granted access to on the given asset.\nNote: If the asset has been shared with you, an empty array will be returned. This is because an asset shared with\nyou cannot be shared with a different partner." }, { "info": { "name": "Update invite/request with an asset permission", "type": "http" }, "http": { "method": "POST", "url": "https://api.pinterest.com/v5/businesses/:business_id/invites/assets/access", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Assign asset permissions information to an existing invite/request. Can be used to:\n- Request access to a partner's asset. Note: This is only for when no existing partnership exists. If an existing\n partnership exists, use \"Create a request to access an existing partner's assets\" to request access to your\n partner's assets.\n - invite_type=\"PARTNER_REQUEST\"\n- Invite a partner to access your business assets. Note: This is only for when there is no existing partnership.\n If there is an existi" }, { "info": { "name": "Create a request to access an existing partner's assets.", "type": "http" }, "http": { "method": "POST", "url": "https://api.pinterest.com/v5/businesses/:business_id/requests/assets/access", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a request to access an existing partner's assets with the specified permissions. The request will be sent to the partner for approval. The assets that can be requested are ad accounts and profiles." }, { "info": { "name": "Get business members", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/businesses/:business_id/members", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." }, { "name": "assets_summary", "value": "", "type": "query", "description": "Include assets summary in the response if this is true.\n\nThe assets summary returns a dictionary representing a summary of the assets\nfor the business user ID, with information like the ad accounts and profiles\nthe user has permissions for and what those permissions are" }, { "name": "business_roles", "value": "", "type": "query", "description": "A list of business roles to filter the members by. Only members whose roles are in the specified roles will be returned." }, { "name": "member_ids", "value": "00101010101,2222220101", "type": "query", "description": "A list of business members ids separated by comma." }, { "name": "start_index", "value": "0", "type": "query", "description": "An index to start fetching the results from. Only the results starting from this index will be returned." }, { "name": "bookmark", "value": "", "type": "query", "description": "Cursor used to fetch the next page of items" }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all members of the specified business.\nThe return response will include the member's business_role and assets they have access to if assets_summary=TRUE" }, { "info": { "name": "Update member's business role", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pinterest.com/v5/businesses/:business_id/members", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Business id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a member's business role within the business." }, { "info": { "name": "Terminate business memberships", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pinterest.com/v5/businesses/:business_id/members", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Business id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Terminate memberships between the specified members and your business." }, { "info": { "name": "List business assets", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/businesses/:business_id/assets", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." }, { "name": "permissions", "value": "", "type": "query", "description": "A list of asset permissions used to filter the assets. Only assets where the requesting business has at least one of the specified permissions will be returned." }, { "name": "asset_type", "value": "", "type": "query", "description": "A resource type to filter the assets by. Only assets of the specified type will be returned." }, { "name": "start_index", "value": "0", "type": "query", "description": "An index to start fetching the results from. Only the results starting from this index will be returned." }, { "name": "bookmark", "value": "", "type": "query", "description": "Cursor used to fetch the next page of items" }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all the assets the requesting business has access to. This includes assets the business owns and assets the business has access to through partnerships." }, { "info": { "name": "Get assets assigned to a member", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/businesses/:business_id/members/:member_id/assets", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." }, { "name": "member_id", "value": "729090764583391194", "type": "path", "description": "The member id to fetch assets for." }, { "name": "asset_type", "value": "", "type": "query", "description": "A resource type to filter the assets by. Only assets of the specified type will be returned." }, { "name": "start_index", "value": "0", "type": "query", "description": "An index to start fetching the results from. Only the results starting from this index will be returned." }, { "name": "bookmark", "value": "", "type": "query", "description": "Cursor used to fetch the next page of items" }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get assets on which you assigned asset permissions to the given member. Can be used to:\n- get all assets, regardless of asset type or\n- get assets of one asset type by using the asset_type query.\nThe return response will include the permissions the member has to that asset and the asset type." }, { "info": { "name": "Assign/Update member asset permissions", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pinterest.com/v5/businesses/:business_id/members/assets/access", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Grant multiple members access to assets and/or update multiple member's exisiting permissions to an asset.\nNote: Not all listed permissions are applicable to each asset type. For example, PROFILE_PUBLISHER would not be applicable to an asset of type AD_ACCOUNT. The permission level PROFILE_PUBLISHER is only available to an asset of the type PROFILE.\n" }, { "info": { "name": "Delete member access to asset", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pinterest.com/v5/businesses/:business_id/members/assets/access", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Terminate multiple members' access to an asset." }, { "info": { "name": "Get invites/requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/businesses/:business_id/invites", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." }, { "name": "is_member", "value": "", "type": "query", "description": "A boolean field to indicate whether the invite is to create a partnership or a membership." }, { "name": "invite_status", "value": "", "type": "query", "description": "A list of invite statuses to filter invites by. Only invites whose status is in the provided statuses will be returned." }, { "name": "invite_type", "value": "", "type": "query", "description": "Invite type to filter invites by. Only invites of the specified type will be returned." }, { "name": "bookmark", "value": "", "type": "query", "description": "Cursor used to fetch the next page of items" }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the membership/partnership invites and/or requests for the authorized user." }, { "info": { "name": "Create invites or requests", "type": "http" }, "http": { "method": "POST", "url": "https://api.pinterest.com/v5/businesses/:business_id/invites", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Business id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create batch invites or requests. Can create batch invites or requests as described below.\n- Invite members to join the business. This would required specifying the following:\n - invite_type=\"MEMBER_INVITE\"\n - business_role=\"EMPLOYEE\" OR business_role=\"BIZ_ADMIN\" (To learn more about business roles, visit\n https://help.pinterest.com/en/business/article/profile-permissions-in-business-access.)\n - members\n- Invite partners to access your business assets. This would require specifying t" }, { "info": { "name": "Cancel invites/requests", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pinterest.com/v5/businesses/:business_id/invites", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Business id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Cancel membership/partnership invites and/or requests." }, { "info": { "name": "Assign/Update partner asset permissions", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pinterest.com/v5/businesses/:business_id/partners/assets", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Grant multiple partners access to assets and/or update multiple partner's exisiting permissions to an asset.\nIf your partner already had permissions on the asset, they will be overriden with the new permissions you assign to them.\nTo learn more about permission levels, visit https://help.pinterest.com/en/business/article/business-manager-overview\n\nNote: Not all listed permissions are applicable to each asset type. For example, PROFILE_PUBLISHER would not be\napplicable to an asset of type AD_ACCO" }, { "info": { "name": "Delete partner access to asset", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pinterest.com/v5/businesses/:business_id/partners/assets", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Terminate multiple partners' access to an asset. If\n- partner_type=INTERNAL: You will terminate a partner's asset access to your business assets.\n- partner_type=EXTERNAL: You will terminate your own access to your partner's business assets." }, { "info": { "name": "Get assets assigned to a partner or assets assigned by a partner", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/businesses/:business_id/partners/:partner_id/assets", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." }, { "name": "partner_id", "value": "729090764583391194", "type": "path", "description": "The partner id to be bound to the Business" }, { "name": "partner_type", "value": "INTERNAL", "type": "query", "description": "Specifies whether to fetch internal or external (shared) partners.\nIf partner_type=INTERNAL, the asset being queried is for accesses the partner has to your business assets.
\nIf partner_type=EXTERNAL, the asset being queried is for the accesses you have to the partner's business asset." }, { "name": "asset_type", "value": "", "type": "query", "description": "A resource type to filter the assets by. Only assets of the specified type will be returned." }, { "name": "start_index", "value": "0", "type": "query", "description": "An index to start fetching the results from. Only the results starting from this index will be returned." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information." }, { "name": "bookmark", "value": "", "type": "query", "description": "Cursor used to fetch the next page of items" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Can be used to get the business assets your partner has granted you access to or the business assets you have\ngranted your partner access to. If you specify:\n- partner_type=INTERNAL, you will retrieve your business assets that the partner has access to.\n- partner_type=EXTERNAL, you will retrieve the partner's business assets that the partner has granted you access to." }, { "info": { "name": "Get business partners", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/businesses/:business_id/partners", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." }, { "name": "assets_summary", "value": "", "type": "query", "description": "Include assets summary in the response if this is true.\n\nThe assets summary returns a dictionary representing a summary of the assets\nfor the business user ID, with information like the ad accounts and profiles\nthe user has permissions for and what those permissions are" }, { "name": "partner_type", "value": "INTERNAL", "type": "query", "description": "Specifies whether to fetch internal or external (shared) partners.\nIf partner_type=INTERNAL, the asset being queried is for accesses the partner has to your business assets.
\nIf partner_type=EXTERNAL, the asset being queried is for the accesses you have to the partner's business asset." }, { "name": "partner_ids", "value": "00101010101,2222220101", "type": "query", "description": "A list of business partner ids separated by commas used to filter the results. Only partners with the specified ids will be returned." }, { "name": "start_index", "value": "0", "type": "query", "description": "An index to start fetching the results from. Only the results starting from this index will be returned." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of items to include in a single page of the response. See documentation on Pagination for more information." }, { "name": "bookmark", "value": "", "type": "query", "description": "Cursor used to fetch the next page of items" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all partners of the specified business.\n\nIf the assets_summary=TRUE and:\n- partner_type=INTERNAL, the business assets returned are your business assets the partner has access to.\n- partner_type=EXTERNAL, the business assets returned are your partner's business assets the partner has granted you\n access to." }, { "info": { "name": "Terminate business partnerships", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pinterest.com/v5/businesses/:business_id/partners", "params": [ { "name": "business_id", "value": "729090764583391194", "type": "path", "description": "Unique identifier of the requesting business." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Terminate partnerships between the specified partners and your business.\nNote: You may only batch terminate partners of the same partner type." }, { "info": { "name": "Get commerce integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.pinterest.com/v5/integrations/commerce/:external_business_id", "params": [ { "name": "external_business_id", "value": "", "type": "path", "description": "External business ID for the integration." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get commerce integration metadata associated with the given external business ID.\nNote: If you're interested in joining the beta, please reach out to your Pinterest account manager." }, { "info": { "name": "Update commerce integration", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pinterest.com/v5/integrations/commerce/:external_business_id", "params": [ { "name": "external_business_id", "value": "", "type": "path", "description": "External business ID for the integration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update commerce integration metadata for the given external business ID.\nNote: If you're interested in joining the beta, please reach out to your Pinterest account manager." }, { "info": { "name": "Delete commerce integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pinterest.com/v5/integrations/commerce/:external_business_id", "params": [ { "name": "external_business_id", "value": "", "type": "path", "description": "External business ID for the integration." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://www.pinterest.com/oauth/", "accessTokenUrl": "https://api.pinterest.com/v5/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete commerce integration metadata for the given external business ID.\nNote: If you're interested in joining the beta, please reach out to your Pinterest account manager." } ] } ], "bundled": true }