HubSpot · Schema
SearchResponse
The response from a CRM search operation.
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| total | integer | The total number of records matching the search criteria. |
| results | array | The matching CRM records for the current page. |
| paging | object | Pagination information for the response. |
JSON Schema
{
"type": "object",
"description": "The response from a CRM search operation.",
"properties": {
"total": {
"type": "integer",
"description": "The total number of records matching the search criteria.",
"example": 10
},
"results": {
"type": "array",
"description": "The matching CRM records for the current page.",
"example": [
{
"id": "500123",
"properties": {
"key": "value"
},
"createdAt": "2025-03-15T14:30:00Z",
"updatedAt": "2025-03-15T14:30:00Z",
"archived": true
}
],
"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.",
"example": {
"key": "value"
}
},
"createdAt": {
"type": "string",
"description": "The date and time the record was created.",
"format": "date-time",
"example": "2025-03-15T14:30:00Z"
},
"updatedAt": {
"type": "string",
"description": "The date and time the record was last updated.",
"format": "date-time",
"example": "2025-03-15T14:30:00Z"
},
"archived": {
"type": "boolean",
"description": "Whether the record has been archived.",
"example": true
}
}
}
},
"paging": {
"type": "object",
"description": "Pagination information for the response.",
"properties": {
"next": {
"type": "object",
"description": "Information for retrieving the next page of results.",
"example": {
"after": "example-value",
"link": "https://app.hubspot.com/contacts/12345"
},
"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."
}
}
}
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "SearchResponse"
}