Skip to main content
GET
Connect an ad platform

Request contract

  • Method and path: GET /apis/v1/ads/connect/{platform}
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/ads/connect/{platform}
  • platform: path; required
  • profileId: query; optional
  • redirectUrl: query; optional
  • socialAccountId: query; optional
  • adAccountIds: query; optional
  • force: query; optional
  • Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

platform
string
required

Query Parameters

profileId
string

Your social profile (prf_...); the default profile when omitted.

redirectUrl
string<uri>

Where the browser goes when the flow ends; it must be on your redirect allowlist.

socialAccountId
string

One of your social accounts (acc_...) on the profile. Required for X; on Meta, LinkedIn and Pinterest it picks the login the ads authorization reuses.

adAccountIds
string

Comma-separated platform ad account IDs to limit the connection to.

force
boolean

Always start a new authorization.

Response

Success

alreadyConnected
boolean | null
authUrl
string | null
connectSessionId
string | null
connection
object | null
expiresAt
string<date-time> | null