SMsmileapi
Links

View Link

Changed on

View the Account's link result by ID.

get/links/{id}

Request

  • Base URL
    https://sandbox.smileapi.io/v1
  • URL
    https://sandbox.smileapi.io/v1/links/{id}
  • Auth
    HTTP basic

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' required

Request status code

messagestring

Message response to the request

requestIdstring required

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": {
    "id": "link-123456789012345678901234567890",
    "startDate": "2021-04-14T09:30:24Z",
    "endDate": "2021-04-14T09:30:24Z",
    "records": [
      {
        "linkedAt": [
          "2021-04-14T09:30:24Z"
        ]
      }
    ],
    "metadata": {
      "itemCreatedAt": "2021-04-14T09:30:24Z",
      "createdAt": "2021-04-14T09:30:24Z",
      "sourceType": "Account"
    }
  }
}

Changes

  • v12e8500e069bbRevision changes
    • warning

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

  • v14f4b86b82632Revision changes
    • breaking

      the response property //// became nullable for the status