Accounts & connections · Accounts

List partner businesses of the Page

Returns partner businesses of the Page. Works with Facebook and Instagram accounts.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/business-partners

Facebook and InstagramlistBusinessPartners

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`accountId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-partners" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-partners", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-partners",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

pageobject
- idstring
- namestring
- businessobject
  Can be null.
  2 child fields
  - idstring
  - namestring
- instagramBusinessAccountobject
  Can be null.
  2 child fields
  - idstring
  - usernamestring
partnersarray of object
- businessIdstring
- namestring
- permittedTasksarray of string

200 response

{
  "page": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "business": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "name": "Acme"
    },
    "instagramBusinessAccount": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "username": "acme"
    }
  },
  "partners": [
    {
      "businessId": "68520dbeeafb126eab3873f6",
      "name": "Acme",
      "permittedTasks": [
        "string"
      ]
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

Request

Path parameters

Example

Response

Errors

More in Accounts