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 or search for contacts

List contacts (recommended)

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.

GEThttps://CONNECT-DOMAIN/api/v2/customer/contacts

Authorization

sfsAuthentication

Query parameters

Response

200401403404

Contact found

Body

application/json

contactsarray of find-contact-response-v2 (all of)

paginationPagination

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v2/customer/contacts', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "contacts": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "companyName": "Company",
      "emailAddress": "[e-mail]",
      "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)"
    }
  ],
  "pagination": {
    "previous": "?before=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "next": "?after=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "cursors": {
      "before": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
      "after": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9"
    }
  }
}

List contact’s advisors

List a contact’s advisors (recommended)

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

GEThttps://CONNECT-DOMAIN/api/v2/customer/contacts/{contactSymphonyId}/advisors

Authorization

sfsAuthentication

Path parameters

contactSymphonyId*string (number)

The Contact's Symphony user ID

Query parameters

Response

200401403404

List of advisor(s) found

Body

application/json

advisorsarray of entitlement-response (object)

paginationPagination

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v2/customer/contacts/{contactSymphonyId}/advisors', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "advisors": [
    {
      "symphonyId": "14362370637825",
      "firstName": "William",
      "lastName": "Smith",
      "companyName": "Company",
      "displayName": "William Smith",
      "emailAddress": "[e-mail]",
      "avatar": "https://YOURDOMAIN.symphony.com/avatars/3gXMhglCCTwLPL9JAprnyHzYn5-PR49-wYDG814n1g8.png",
      "externalNetwork": "text",
      "federationGroupId": "federationGroupId",
      "phone": {
        "number": "[phone]",
        "product": "PRE_ALLOCATED_HOSTED",
        "subNetwork": "SECOND-NUMBER"
      }
    }
  ],
  "pagination": {
    "previous": "?before=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "next": "?after=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "cursors": {
      "before": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
      "after": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9"
    }
  }
}

List an advisor's contacts

List an advisor's contacts (recommended)

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

GEThttps://CONNECT-DOMAIN/api/v1/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/contacts

Authorization

sfsAuthentication

Path parameters

externalNetwork*string

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

advisorSymphonyId*string (number)

Advisor's Symphony user ID

Query parameters

Response

200401403404

List of contacts(s) found

Body

application/json

contactsarray of add-contact-response (object)

paginationPagination

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v1/customer/advisors/{advisorSymphonyId}/externalNetwork/{externalNetwork}/contacts', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "contacts": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "companyName": "Company",
      "emailAddress": "[e-mail]",
      "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": "2024-05-01T09:33:45.082Z"
        }
      ]
    }
  ],
  "pagination": {
    "previous": "?before=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "next": "?after=ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
    "cursors": {
      "before": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9",
      "after": "ewogICJlbWFpbEFkZHJlc3MiOiB7CiAgICAicyI6ICJtb2NrLnVzZXJAbW9jay5jb20iCiAgfQp9"
    }
  }
}