SMsmileapi
Providers

List Providers

Changed on

Get a list of employment data providers from the Smile Network.

get/providers

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/providers
  • Auth
    HTTP basic

Query parameters

cursorstring

Uses the filter values of the previous page to determine the next set of items.

sizeinteger
Example:50

The number of objects you want returned in a collection.

typestring

Filter results to certain type of providers.

subTypestring

Filter results to certain subset of a certain subtype of providers

activeboolean

Filter results to active or inactive providers.

enabledboolean

Filter results to enabled or disabled providers.

accountConnectionboolean

Filter results to providers with real-time account connections.

namestring

Filter results by provider name

idsstring[]

Filter results by provider ids, each id will be matched exactly, please following this format 'ids=id1,id2,id3'.

topIdsstring[]

Show these providers on the top of the list, please following this format 'ids=id1,id2,id3'.

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": {
    "nextCursor": "1259723474",
    "items": [
      {
        "id": "upwork",
        "name": "Upwork",
        "logoUrl": "https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png",
        "type": "GIG",
        "typeLabel": "Gig Platform",
        "subTypeLabel": "Professional Services",
        "supported": [
          "IDENTITIES"
        ]
      }
    ]
  }
}

Changes

  • v14f4b86b82632Revision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

  • v119cd0da04e27Revision changes
    • warning

      added the new INSIGHTS enum value to the //// response property for the response status

    • info

      added the required property /// to the response with the status