Crm Search Api Search Response Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/crm-search-api-search-response-structure.json",
  "name": "SearchResponse",
  "description": "The response from a CRM search operation.",
  "type": "object",
  "properties": {
    "total": {
      "type": "int32",
      "description": "The total number of records matching the search criteria.",
      "example": 10
    },
    "results": {
      "type": "array",
      "description": "The matching CRM records for the current page.",
      "items": {
        "type": "object",
        "description": "A CRM object record returned from a search.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the CRM record.",
            "example": "500123"
          },
          "properties": {
            "type": "object",
            "description": "The CRM record's properties as key-value pairs.",
            "additionalProperties": {
              "type": "string"
            },
            "example": {
              "key": "value"
            }
          },
          "createdAt": {
            "type": "datetime",
            "description": "The date and time the record was created.",
            "example": "2025-03-15T14:30:00Z"
          },
          "updatedAt": {
            "type": "datetime",
            "description": "The date and time the record was last updated.",
            "example": "2025-03-15T14:30:00Z"
          },
          "archived": {
            "type": "boolean",
            "description": "Whether the record has been archived.",
            "example": true
          }
        }
      },
      "example": [
        {
          "id": "500123",
          "properties": {
            "key": "value"
          },
          "createdAt": "2025-03-15T14:30:00Z",
          "updatedAt": "2025-03-15T14:30:00Z",
          "archived": true
        }
      ]
    },
    "paging": {
      "type": "object",
      "description": "Pagination information for the response.",
      "properties": {
        "next": {
          "type": "object",
          "description": "Information for retrieving the next page of results.",
          "properties": {
            "after": {
              "type": "string",
              "description": "The cursor token to use in the after parameter for the next page."
            },
            "link": {
              "type": "string",
              "description": "A URL link to the next page of results."
            }
          },
          "example": {
            "after": "example-value",
            "link": "https://app.hubspot.com/contacts/12345"
          }
        }
      }
    }
  }
}