OmniSocialsOmniSocials
DocumentationAPI reference
Help centerSupport
  • Documentation
  • API reference
Developers
  • Quickstart
  • API reference
  • SDKs
  • MCP server
  • CLI
For AI agents
  • Docs for AI agents
  • llms.txt
  • OpenAPI spec
  • Postman collection
Product
  • OmniSocials
  • Pricing
  • Changelog
  • Help center
Company
  • Support
  • Privacy policy
  • Terms of service

© 2026 OmniSocials

OmniSocials on GitHubOmniSocials on XOmniSocials on LinkedIn
Information
Posts
    List postsgetList live platform postsgetGet a postgetDelete a postdeleteUpdate a postpatchCreate a postpostCreate and publish postpostPublish a post nowpostRetry failed postpostApprove a postpostReject a postpostGet approval reviewget
Media
    List mediagetGet a media itemgetDelete a media itemdeleteRename or move mediapatchUpload a filepostUpload from base64postUpload from a URLpostCreate an upload URLpostSplit a PDF into pagespostCheck media limitspostUpload with a tokenpost
Folders
    List foldersgetCreate a folderpostDelete a folderdeleteRename or move a folderpatch
Hashtag Sets
    List hashtag setsgetCreate a hashtag setpostGet a hashtag setgetDelete a hashtag setdeleteUpdate a hashtag setpatch
Tags
    List tagsgetCreate a tagpostDelete a tagdeleteUpdate a tagpatchTag posts in bulkpost
Accounts
    List accountsgetGet an accountgetChange how often X statistics are checkedpatch
Analytics
    Get bulk post analyticsgetGet post analyticsgetCompare tagsgetGet analytics overviewgetGet account analyticsgetGet best posting timesgetCheck the X numbers of a post now ("Update now")post
Credits
    Credit balance and X statisticsget
Approvals
    List approval workflowsget
Webhooks
    List webhooksgetCreate a webhookpostGet a webhookgetDelete a webhookdeleteUpdate a webhookpatchRotate webhook secretpost
Locations
    Search locationsgetValidate a locationget
Audio
    Search Instagram audioget
Pinterest
    List product PinsgetCheck a product Pinget
Inbox
    List conversationsgetList messagesgetMark conversation readpostReply to a conversationpostHide or unhide a commentpostLike or unlike a commentpostDelete a commentdeleteGet next conversationget
Automations
    List automationsgetCreate an automationpostGet an automationgetDelete an automationdeleteUpdate an automationpatchList automation eventsget
Feature requests
    List what OmniSocials cannot dogetList your feature requestsgetSend a feature requestpostGet a feature requestget
Schemas
OmniSocials API
OmniSocials API

Pinterest

Download schema

List and check the product Pins of the connected Pinterest account, to tag products on a Pin with pinterest.product_tags.


List product Pins

GET
https://api.omnisocials.com/v1
/pinterest/products

List the product Pins of the connected Pinterest account. Pass a returned pin_id in pinterest.product_tags on POST /posts/create / PATCH /posts/{id} to tag the product on a Pin (max 24 products per Pin).

Pinterest only accepts a product tag when the product Pin is public, belongs to the same Pinterest account, and links to a website that account claimed on Pinterest. Products of other merchants cannot be tagged through the API.

Sources. source=catalog reads the Pinterest catalog (with price, currency, availability, item_id) through a product group; the response carries product_groups so you can pick another group with product_group_id. It needs catalog access on the Pinterest connection: in the OmniSocials composer open the Pinterest options, select Add products, then Connect catalog (one time per workspace). Without catalog access the response is error.code = pinterest_catalog_access_required. source=pins reads the account's own Pins and returns the ones Pinterest marks as product Pins; it works on every connection. One pins call scans up to 250 Pins, so products can be empty while bookmark is set: call again with the bookmark. When source is left out, catalog is used when the connection has catalog access, else pins.

Problems that are not a bad request (no Pinterest account, no catalog access, Pinterest did not answer) come back as HTTP 200 with an error object instead of products.

List product Pins › query Parameters

source
​string · enum

Where to read product Pins from. Default: catalog when the connection has catalog access, else pins.

Enum values:
catalog
pins
product_group_id
​string

Catalog source only. A product group id from product_groups. Default: the group named "All Products", else the first group.

bookmark
​string

Cursor from the previous response, to get the next page.

page_size
​integer · min: 1 · max: 100

Catalog source only. Products per page.

Default: 25

List product Pins › Responses

Product Pins, or an error object when the list could not be read.

​PinterestProduct[]
bookmark
​string | null

Pass as bookmark to get the next page. null on the last page.

source
​string · enum

The source that was read.

Enum values:
catalog
pins
catalog_access
​boolean

true when the Pinterest connection can read the catalog.

no_catalog
​boolean

true when the connection has catalog access but the Pinterest account has no catalog yet (Pinterest answers HTTP 409 to the product group request). products and product_groups are then empty. Products are added at https://www.pinterest.com/business/catalogs/.

​object[]

Catalog source only. The product groups of the account.

product_group_id
​string | null

Catalog source only. The group these products come from.

error
​object | null

Present instead of products when the list could not be read.

GET/pinterest/products
curl "https://api.omnisocials.com/v1/pinterest/products" \ -H "Authorization: Bearer $OMNISOCIALS_API_KEY"
Example Responses
{ "products": [ { "pin_id": "813744226420795884", "title": "Blue ribbed top", "description": null, "link": "https://shop.example.com/products/blue-ribbed-top", "image_url": "https://i.pinimg.com/400x300/aa/bb/cc/example.jpg", "price": 24.99, "currency": "EUR", "availability": "IN_STOCK", "item_id": "TOP-BLUE-M" } ], "bookmark": null, "source": "catalog", "catalog_access": true, "product_groups": [ { "id": "443727193917", "name": "All Products" } ], "product_group_id": "443727193917" }
json
application/json

Check a product Pin

GET
https://api.omnisocials.com/v1
/pinterest/products/validate

Check whether a Pin can be used in pinterest.product_tags before you create the post. Pass a Pin ID or a Pin link (https://www.pinterest.com/pin/<id>/; pin.it short links do not work). Returns { valid: true, pin_id, title, link, image_url } for a product Pin of the connected account, and { valid: false, reason } for a Pin that is not a product Pin, belongs to another account or does not exist. When the check cannot run (no Pinterest account, Pinterest did not answer, or Pinterest did not say if the Pin is a product Pin) it returns { valid: false, unverified: true }: the publish step is then the final check. The check does not look at the claimed-website rule; Pinterest applies that one at publish.

Check a product Pin › query Parameters

id
​string · required

Pin ID or Pin link of the product Pin.

Check a product Pin › Responses

200

Check result

valid
​boolean
pin_id
​string | null

The Pin ID read from id (null when id is not a Pin ID or link).

title
​string | null
link
​string | null
image_url
​string | null
unverified
​boolean

The check could not run; the publish step will check.

reason
​string | null

Why the Pin is not valid or could not be checked.

GET/pinterest/products/validate
curl "https://api.omnisocials.com/v1/pinterest/products/validate?id=813744226420795884" \ -H "Authorization: Bearer $OMNISOCIALS_API_KEY"
Example Responses
{ "valid": true, "pin_id": "pin_id", "title": "title", "link": "link", "image_url": "image_url", "unverified": true, "reason": "reason" }
json
application/json

AudioInbox