Search API

Always use the Copy icon in the example field when copying examples. Manual copy and paste is known to cause data format errors.

List contacts

List contacts (recommended)

get

List contacts, can query by emailAddress, phoneNumber or by contactSymphonyId or by advisorSymphonyId. If the advisor has the admin:list-customers permission, they will be able to retrieve all pod contacts for a given externalNetwork, or to see other advisor's list of contacts.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Query parameters

externalNetworkstring · min: 1Required

The external network: WHATSAPP, SMS, WECHAT, SMS-DIRECT, LINE or WHATSAPP-DIRECT

Example: WHATSAPP

emailAddressstring · emailOptional

Contact's email address

Example: [email protected]

phoneNumberstring · phoneOptional

Contact's phone number

Example: [phone]

symphonyIdstringOptional

Contact's Symphony user ID

Example: 1234567890Pattern: ^\d+$

advisorSymphonyIdstringOptional

The advisor's Symphony ID

Example: 1234567890Pattern: ^\d+$

phoneBlockedstring · enumOptional

Filter only available or blocked contact's phones

Default: allPossible values:

beforestringOptional

The before cursor for pagination

afterstringOptional

The after cursor for pagination

Responses

200

Contact found

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Contact or tenant not found

application/json

get

/api/v2/customer/contacts

HTTPcURLJavaScriptPython

GET /api/v2/customer/contacts?externalNetwork=WHATSAPP HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "contacts": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "companyName": "Company",
      "emailAddress": "[email protected]",
      "phoneNumber": 911234567890,
      "externalNetwork": "WHATSAPP",
      "symphonyId": 12345678912365,
      "advisors": [
        123456789,
        369258147,
        7896564123
      ],
      "status": "PENDING_CONFIRMATION",
      "isColleague": false,
      "preferredLanguage": "CHINESE_CHN, CHINESE_HKG, CHINESE_TAI, JAPANESE (among others, see release note for more)"
    },
    {
      "advisorSymphonyId": "text",
      "reason": "SPAM",
      "comment": "text",
      "requestDate": "2026-02-06T12:37:57.507Z"
    }
  ],
  "pagination": {
    "previous": "?before=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "next": "?after=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "cursors": {
      "before": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
      "after": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9"
    }
  }
}

Get contact

Get contact

get

Get a contact searching by their phone number, their external network and, optionally, their advisor's federation group.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Query parameters

phoneNumberstring · phoneRequired

contact's phone number

externalNetworkstringRequired

contact's external network

federationGroupIdstringOptional

contact's federationGroupId

Responses

200

Contact found

application/json

400

Bad Request

application/json

404

Not found

application/json

get

/api/v2/customer/contact

HTTPcURLJavaScriptPython

GET /api/v2/customer/contact?phoneNumber=text&externalNetwork=text HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "Company",
  "emailAddress": "[email protected]",
  "phoneNumber": 911234567890,
  "externalNetwork": "WHATSAPP",
  "symphonyId": 12345678912365,
  "advisors": [
    123456789,
    369258147,
    7896564123
  ],
  "status": "PENDING_CONFIRMATION",
  "isColleague": false,
  "preferredLanguage": "CHINESE_CHN, CHINESE_HKG, CHINESE_TAI, JAPANESE (among others, see release note for more)"
}

List contact’s advisors

List a contact’s advisors (recommended)

get

Search for the advisors of a provided contact email address for a given external network.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

contactSymphonyIdstring · numberRequired

The Contact's Symphony user ID

Example: 1234567890

Query parameters

beforestringOptional

The before cursor for pagination

afterstringOptional

The after cursor for pagination

Responses

200

List of advisor(s) found

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Contact not found

application/json

get

/api/v2/customer/contacts/{contactSymphonyId}/advisors

HTTPcURLJavaScriptPython

GET /api/v2/customer/contacts/{contactSymphonyId}/advisors HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "advisors": [
    {
      "symphonyId": "14362370637825",
      "firstName": "William",
      "lastName": "Smith",
      "companyName": "Company",
      "displayName": "William Smith",
      "emailAddress": "[email protected]",
      "avatar": "https://YOURDOMAIN.symphony.com/avatars/3gXMhglCCTwLPL9JAprnyHzYn5-PR49-wYDG814n1g8.png",
      "externalNetwork": "WHATSAPP_DIRECT",
      "federationGroupId": "federationGroupId",
      "status": "PRE_ENTITLED",
      "phone": {
        "number": "[phone]",
        "product": "PRE_ALLOCATED_HOSTED",
        "subNetwork": "SECOND-NUMBER",
        "provider": "UMONY"
      },
      "permissions": [
        {
          "permissionName": "create:room",
          "permissionId": "aef488fa-636e-483e-b366-278e07354e57"
        }
      ]
    }
  ],
  "pagination": {
    "previous": "?before=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "next": "?after=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "cursors": {
      "before": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
      "after": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9"
    }
  }
}

List an advisor's contacts

List an advisor's contacts (recommended)

get

Search for the contacts associated with the provided advisor’s Symphony user ID for a given external network.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

externalNetworkstring · min: 1Required

The external network: WHATSAPP, SMS, WECHAT, SMS-DIRECT, LINE or WHATSAPP-DIRECT

Example: WHATSAPP

advisorSymphonyIdstring · numberRequired

Advisor's Symphony user ID

Example: 1234567890

Query parameters

beforestringOptional

The before cursor for pagination

afterstringOptional

The after cursor for pagination

Responses

200

List of contacts(s) found

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

404

Advisor not found

application/json

get

/api/v1/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/contacts

HTTPcURLJavaScriptPython

GET /api/v1/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/contacts HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "contacts": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "companyName": "Company",
      "emailAddress": "[email protected]",
      "phoneNumber": 911234567890,
      "externalNetwork": "WHATSAPP",
      "symphonyId": 12345678912365,
      "status": "PENDING_CONFIRMATION",
      "statusUpdateDate": 1547661232368,
      "preferredLanguage": "CHINESE_CHN, CHINESE_HKG, CHINESE_TAI, JAPANESE (among others, see release note for more)",
      "invitationCode": "AB12DE43",
      "phoneNumberBlockedBy": [
        {
          "advisorSymphonyId": "text",
          "reason": "SPAM",
          "comment": "text",
          "requestDate": "2026-02-06T12:37:57.507Z"
        }
      ]
    }
  ],
  "pagination": {
    "previous": "?before=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "next": "?after=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "cursors": {
      "before": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
      "after": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9"
    }
  }
}

Search for contacts

Search contacts

get

=> Search an advisor's contacts related to a given externalNetwork

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Path parameters

externalNetworkstringRequiredExample: WHATSAPP

Query parameters

querystringRequired

Start search by first name, then last name and then display name

Example: o

Responses

200

List of contacts found

application/json

get

/api/v1/customer/contacts/externalNetwork/{externalNetwork}/search

HTTPcURLJavaScriptPython

GET /api/v1/customer/contacts/externalNetwork/{externalNetwork}/search?query=text HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of contacts found

{
  "contacts": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "companyName": "Company",
      "emailAddress": "[email protected]",
      "phoneNumber": 911234567890,
      "externalNetwork": "WHATSAPP",
      "symphonyId": 12345678912365,
      "status": "PENDING_CONFIRMATION",
      "statusUpdateDate": 1547661232368,
      "ownAdvisorId": 12345678912300,
      "preferredLanguage": "English",
      "invitationCode": "AB12DE43",
      "room": {
        "streamId": "bjHSiY4iz3ar4iIh6-VzCX___peoM7cPdA",
        "roomName": "API room",
        "advisorSymphonyId": 12345678912365,
        "federationGroupId": "federationGroupId",
        "created": 1547661232368,
        "updated": 1547661232370,
        "roomType": "ROOM",
        "membersCount": 1
      },
      "isColleague": false,
      "consent": "PENDING",
      "phoneNumberBlockedBy": [
        {
          "advisorSymphonyId": "text",
          "reason": "SPAM",
          "comment": "text",
          "requestDate": "2026-02-06T12:37:57.507Z"
        }
      ]
    }
  ],
  "pagination": {
    "previous": "?before=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "next": "?after=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "cursors": {
      "before": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
      "after": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9"
    }
  }
}