Get all campaigns
Get a list of all campaigns in the CareCloud platform. A campaign is a planned sequence of activities that promotes a product or service. Campaigns group related campaign products and messages, and can target customers across multiple communication channels. Use the name filter for name-based lookup and external_id to retrieve campaigns linked to external systems. See Campaigns for details.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
Search record by name or a part of the name.
The ID from other system than CareCloud. It is usually used for the synchronization or identification of the record in between CareCloud and other system. The ID doesn't need to be necessary unique. Usage of other parameter could be required to return more specific results.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"campaigns": [
{
"idcampaign": "8bed991c68a470e7aaeffbf048",
"campaign_id": "8bed991c68a470e7aaeffbf048",
"external_id": "CAMP-EXT-001",
"name": "Standard campaign",
"last_change": "2021-04-16 18:22:35.052987",
"state": 1
}
],
"total_items": 1
}
}