Skip to main content
GET
List contacts

Request contract

  • Method and path: GET /apis/v1/social/contacts
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/social/contacts
  • profileId: query; optional
  • accountId: query; optional
  • search: query; optional
  • tag: query; optional
  • tags: query; optional
  • platform: query; optional
  • isSubscribed: query; optional
  • limit: query; optional
  • skip: query; optional
  • Runtime facts: 99acb5bddbedc8d3352e7c4fef86c3e6d8852c14772bcd18dbcf415237a642bd
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.

Query Parameters

profileId
string

One of your profiles (prf_...). Defaults to your default profile when neither profileId nor accountId is sent.

Pattern: ^prf_[0-9A-Za-z]{22}$
accountId
string

One of your social accounts (acc_...).

Pattern: ^acc_[0-9A-Za-z]{22}$

Case-insensitive substring match on the contact name, email and company. Phone numbers and other platform identifiers are not matched: they live on the contact channel, not on the contact. To reach a contact from an inbox webhook, use the conversation.contactId it already carries.

tag
string
tags
string

Comma-separated tags, matches contacts carrying any of them

platform
enum<string>
Available options:
instagram,
facebook,
telegram,
twitter,
bluesky,
reddit,
whatsapp,
slack,
sms
isSubscribed
enum<string>
Available options:
true,
false
limit
integer
default:50
Required range: x <= 200
skip
integer
default:0

Response

Contacts list with pagination and filter metadata

contacts
object[]
filters
object
pagination
object
success
boolean