SMsmileapi
Employers

Query Employer

Changed on
get/alpha/employers/query

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/alpha/employers/query
  • Auth
    HTTP basic

Query parameters

businessNamestring
Example:ABC Inc.

Business name of the employer. Exact query, please provide a minimum of 3 characters. Return only one record. If not found, an empty array will be returned.

Response

OK

code'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED'

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": [
    {
      "registrations": [
        {
          "date": "2000-01-21"
        }
      ],
      "businessAddress": {
        "country": "PH",
        "tags": [
          "Primary",
          "Home"
        ]
      },
      "licenses": [
        {
          "licenseIssuedDate": "2000-01-21"
        }
      ]
    }
  ]
}

Changes