LinkListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/getsmileapi/json-schema/getsmileapi-link-list-response-schema.json",
  "title": "LinkListResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/getsmileapi-links-api-openapi.yml#/components/schemas/LinkListResponse",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/$defs/CommonResponse"
    },
    {
      "properties": {
        "data": {
          "$ref": "#/$defs/LinkListData"
        }
      }
    }
  ],
  "$defs": {
    "CommonResponse": {
      "title": "CommonResponse",
      "type": "object",
      "required": [
        "code",
        "requestId"
      ],
      "properties": {
        "code": {
          "$ref": "#/$defs/ObjectMetadataRefCode"
        },
        "message": {
          "$ref": "#/$defs/ObjectMetadataRefMessage"
        },
        "requestId": {
          "$ref": "#/$defs/ObjectMetadataRefRequestID"
        }
      },
      "description": ""
    },
    "Link": {
      "type": "object",
      "required": [
        "id",
        "endDate",
        "metadata"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/LinkPayload"
        },
        {
          "properties": {
            "metadata": {
              "$ref": "#/$defs/ObjectReferenceMetadata"
            }
          }
        }
      ]
    },
    "LinkListData": {
      "type": "object",
      "properties": {
        "nextCursor": {
          "$ref": "#/$defs/ObjectNextCursor"
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Link"
          }
        }
      }
    },
    "LinkPayload": {
      "type": "object",
      "required": [
        "id",
        "endDate"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Link request ID"
        },
        "startDate": {
          "$ref": "#/$defs/RefDateTime"
        },
        "endDate": {
          "$ref": "#/$defs/RefDateTime"
        },
        "records": {
          "type": "array",
          "description": "Link records",
          "default": [],
          "items": {
            "type": "object",
            "title": "LinkRecord",
            "required": [
              "count"
            ],
            "properties": {
              "count": {
                "type": "integer",
                "description": "The number of times the user has linked at least one account with other participating organizations"
              },
              "linkedAt": {
                "type": "array",
                "default": [],
                "description": "The latest link time of each application",
                "items": {
                  "$ref": "#/$defs/RefDateTime"
                }
              }
            }
          }
        }
      }
    },
    "ObjectMetadataRefCode": {
      "type": "string",
      "title": "ObjectMetadataRefCode",
      "description": "Request status code",
      "enum": [
        "OK",
        "CREATED",
        "INVALID_CREDENTIALS",
        "INVALID_PARAMETERS",
        "INVALID_TOKEN",
        "UNAUTHORIZED_ACCESS",
        "MISSING_RESOURCE",
        "REQUEST_LIMIT_EXCEEDED",
        "SERVER_ERROR",
        "UNSUPPORTED_METHOD",
        "SERVER_UNAVAILABLE",
        "TIME_LIMIT_EXCEEDED"
      ],
      "x-internal": false
    },
    "ObjectMetadataRefMessage": {
      "type": "string",
      "title": "ObjectMetadataRefMessage",
      "description": "Message response to the request",
      "x-internal": false
    },
    "ObjectMetadataRefRequestID": {
      "type": "string",
      "title": "ObjectMetadataRefRequestID",
      "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.",
      "x-internal": false
    },
    "ObjectNextCursor": {
      "title": "ObjectNextCursor",
      "type": "string",
      "description": "The next cursor value that can be used in the following query.",
      "x-internal": false
    },
    "ObjectReferenceMetadata": {
      "title": "Reference Metadata",
      "type": "object",
      "description": "Metadata related to account-specific data",
      "properties": {
        "itemCreatedAt": {
          "$ref": "#/$defs/RefDateTime"
        },
        "createdAt": {
          "$ref": "#/$defs/RefDateTime"
        },
        "accountId": {
          "type": "string",
          "deprecated": true,
          "description": "The accountId of this object"
        },
        "sourceId": {
          "type": "string",
          "description": "The ACCOUNT or ARCHIVE ID associated with this object"
        },
        "sourceType": {
          "$ref": "#/$defs/RefSourceType"
        },
        "userId": {
          "type": "string",
          "description": "The user ID associated with this object"
        },
        "providerId": {
          "type": "string",
          "description": "The provider ID associated with this object"
        }
      },
      "required": [
        "createdAt",
        "itemCreatedAt",
        "sourceId",
        "sourceType",
        "userId",
        "providerId"
      ]
    },
    "RefDateTime": {
      "type": "string",
      "title": "Date and Time string",
      "format": "date-time",
      "description": "Date and time"
    },
    "RefSourceType": {
      "type": [
        "string",
        "null"
      ],
      "title": "Ref-Source-Type",
      "enum": [
        "ACCOUNT",
        "UPLOAD",
        "ARCHIVE",
        "SOCIAL_SECURITY"
      ],
      "description": "Source Type"
    }
  }
}