Campaign search
GET {{baseUrl}}/marketing/v3/campaigns/?sort=<string>&after=<string>&limit=<integer>&name=<string>&properties=<string>&properties=<string>
This endpoint allows users to search for and return a page of campaigns based on various query parameters. Users can filter by name, sort, and paginate through the campaigns, as well as control which properties are returned in the response.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
sort | string | The field by which to sort the results. Allowed values are hs_name, createdAt, updatedAt. An optional '-' before the property name can denote descending order | |
| Default: hs_name | |||
after | string | A cursor for pagination. If provided, the results will start after the given cursor. | |
| Example: NTI1Cg%3D%3D | |||
limit | string | The maximum number of results to return. Allowed values range from 1 to 100 | |
| Default: 50 | |||
name | string | A filter to return campaigns whose names contain the specified substring. This allows partial matching of campaign names, returning all campaigns that include the given substring in their name. If this parameter is not provided, the search will return all campaigns | |
properties | string | A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map | |
properties | string | A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"results":[{"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"mollit_a54":"\u003cstring\u003e"},"updatedAt":"\u003cdateTime\u003e"},{"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"Lorem_9":"\u003cstring\u003e","exercitation_e4":"\u003cstring\u003e","ipsume":"\u003cstring\u003e"},"updatedAt":"\u003cdateTime\u003e"}],"total":"\u003cinteger\u003e","paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"}}}