Accounts & connections · Connect

Check an OAuth app's keys

Checks an OAuth app's keys without changing anything.

POSThttps://api.pozy.ai/v1/connect/oauth-apps/{appId}/test

testOAuthApp

Request

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

Path parameters

Name	Type	Notes
`appId`required	string

Example

curl -X POST "https://api.pozy.ai/v1/connect/oauth-apps/66eb857ad97c1a6630d19dc6/test" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/connect/oauth-apps/66eb857ad97c1a6630d19dc6/test", {
  method: "POST",
  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.post(
    "https://api.pozy.ai/v1/connect/oauth-apps/66eb857ad97c1a6630d19dc6/test",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

appobjectrequired
15 child fields
- idstringrequired
- platformstringrequired
- labelstringrequired
- clientIdstringrequired
- scopeAreasarray of stringrequired
  Each item: one of posting, analytics, comments, messaging.
- statusstringrequired
  One of ok, unchecked, invalid.
- lastCheckedAtstring (date-time)
  Can be null.
- lastErrorstring
  Can be null.
- accountCountintegerrequired
- redirectUristring (URL)required
- webhookobject
  Can be null.
  4 child fields
  callbackUrlstring (URL)required
  verifyTokenstringrequired
  objectstringrequired
  One of page, instagram.
  fieldsarray of stringrequired
- sharedWebhookUrlstring (URL)
  Can be null.
- hasSlackSigningSecretboolean
- slackEventsobject
  Can be null.
  2 child fields
  requestUrlstring (URL)required
  botEventsarray of stringrequired
- createdAtstring (date-time)required

200 response

{
  "app": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "label": "string",
    "clientId": "6676c044a482bcb231679047",
    "scopeAreas": [
      "posting"
    ],
    "status": "ok",
    "lastCheckedAt": "2026-10-02T09:00:00.000Z",
    "lastError": "string",
    "accountCount": 42,
    "redirectUri": "https://pozy.ai/media/example-1.jpg",
    "webhook": {
      "callbackUrl": "https://pozy.ai/media/example-1.jpg",
      "verifyToken": "string",
      "object": "page",
      "fields": [
        "string"
      ]
    },
    "sharedWebhookUrl": "https://pozy.ai/media/example-1.jpg",
    "hasSlackSigningSecret": true,
    "slackEvents": {
      "requestUrl": "https://pozy.ai/media/example-1.jpg",
      "botEvents": [
        "string"
      ]
    },
    "createdAt": "2026-10-02T09:00:00.000Z"
  }
}

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 read-only, 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.

More in Connect

GETGet OAuth connect URL POSTComplete OAuth callback GETConnect ads for a platform GETGet Shopify OAuth connect URL POSTConnect a Shopify store with a custom-app Admin token GETGet Google Analytics OAuth connect URL GETList Google Analytics properties for a pending connect POSTConnect the chosen Google Analytics property GETGet HubSpot OAuth connect URL GETGet WordPress.com OAuth connect URL GETGet Wix site install URL GETGet Webflow OAuth URL POSTConnect Webflow with a site API token POSTConnect self-hosted WordPress with an application password PATCHSet TikTok brand identity GETList Facebook pages POSTSelect Facebook page GETList Pages with a linked Instagram account POSTSelect the Page whose Instagram account to connect GETList Google Business Profile locations POSTSelect Google Business Profile location GETGet a phone handoff GETGet the saved welcome screen PUTSave the welcome screen GETList your OAuth apps POSTAdd an OAuth app GETGet an OAuth app PATCHUpdate an OAuth app DELRemove an OAuth app GETGet pending OAuth data GETList LinkedIn orgs POSTSelect LinkedIn org GETList Pinterest boards POSTSelect Pinterest board GETList Snapchat profiles POSTSelect Snapchat profile POSTConnect Bluesky account POSTConnect an OpenAI Ads account POSTConnect a Whop account POSTConnect WhatsApp via credentials GETList numbers for selection POSTComplete number selection POSTConnect WhatsApp from Embedded Signup GETGet Embedded Signup SDK config POSTConnect a Discord channel GETList Slack channels for the channel picker POSTConnect a Slack channel GETGenerate Telegram code POSTConnect Telegram directly PATCHCheck Telegram status GETRead a Facebook Page's webhook subscription POSTRe-subscribe a Facebook Page to Pozy's webhooks GETList Facebook pages PUTUpdate Facebook page GETList LinkedIn orgs PUTSwitch LinkedIn account type GETList Pinterest boards POSTCreate Pinterest board PUTSet default Pinterest board GETGet a YouTube video transcript GETList YouTube playlists POSTCreate YouTube playlist PUTSet default YouTube playlist GETList Google Business Profile locations PUTUpdate Google Business Profile location POSTAssign Google Business Profile location to another profile GETList Reddit subreddits PUTSet default subreddit GETGet subreddit rules POSTVote on a Reddit post or comment GETList subreddit flairs POSTSet Reddit post flair GETAdmin-consent link for a Microsoft tenant