Companies API

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

Search for companies

Search for companies

get

Search for companies by name. Note: The WeChat or WhatsApp or SMS or SMS Direct or LINE onboarding applications do not enforce consistency for company names.

Authorizations

sfsAuthentication

AuthorizationstringRequired

HTTP header

Query parameters

querystring · min: 3Required

Start of the company's name to match

Example: sym

Responses

200

List of found companies

application/json

401

Unauthorized

application/json

403

Operation forbidden

application/json

get

/api/v1/customer/companies/search

HTTPcURLJavaScriptPython

GET /api/v1/customer/companies/search?query=sym HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "companies": [
    {
      "companyName": "symphony"
    }
  ]
}