GET
https://www.app.ocoya.com/api/_public/v1/social-profiles
List all connected social profiles
curl --request GET \
  --url https://www.app.ocoya.com/api/_public/v1/social-profiles \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "clh49poxf008x8kov4ncbjty9",
    "provider": "instagram",
    "name": "Ocoya",
    "profileBoards": []
  }
]

Authorizations

X-API-Keystringheaderrequired

Your API key. Create one in Ocoya. Authorization: Bearer <key> works too.

Query Parameters

brandIdstringrequired

Ocoya brand ID. Get one from GET /brands.

Example:"cmayvq3hk00017apshay5qezu"

Response

application/json

Success

object[]
idstring

Social profile ID. Pass it in socialProfileIds when creating or updating posts.

Example:"clh49poxf008x8kov4ncbjty9"
providerstring

Network the profile belongs to.

Example:"instagram"
namestring | null

Profile name as shown on the network.

Example:"Ocoya"
profileBoardsobject[]

Boards the profile can post to, for networks that have them (Pinterest). Empty for the rest.

Example:[]