The search object representation and fields are described below.
search was introduced in API version V1
search has not been marked for deprecation
Representation of a search and it's results when available
{
"owner" : {
"urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
"url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
},
"order" : "NAME",
"includeScopes" : [ "ENTITY" ]
}{
"urn" : "bdef19c7-7084-4dbe-9cf6-db578d72ed7f",
"url" : "/n/v1/search/bdef19c7-7084-4dbe-9cf6-db578d72ed7f",
"owner" : {
"urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
"url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
},
"createdTimestamp" : "2025-09-22T10:15:00",
"updatedTimestamp" : "2025-09-22T10:15:00",
"status" : "FULL_RESULT",
"order" : "NAME",
"items" : [ {
"urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
"url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
"sortOrder" : 0,
"type" : "ENTITY"
} ],
"includeScopes" : [ "ENTITY" ]
}| Name | Type | Description | Constraints |
|---|---|---|---|
| pagination | pagination | Pagination details including the offset of the current page. If set use the current pagination / url to construct the request for the next page | |
| urn | String representation of a Unique Resource Name. Typically a UUID with 36 characters. | The URN of the search | |
| url | URL represented as a string | The URL to access for results of the search | |
| owner | company | The company owner of this search | Required on create. |
| createdTimestamp | Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone. | The timestamp this search was created | |
| updatedTimestamp | Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone. | The timestamp of the last update | |
| status | String literal | The state of the search | Allowed values:
|
| order | String literal | The requested ordering of search results | Optional. |
| items | searchitem[] | The search result items | Ignored on update. |
| includeScopes | [] | Scopes to include for the search | Ignored on update. Allowed values:
|