COcontentsnare
Communications schedules

List communications schedules

Returns list of communications schedules<br>Required scopes: <b>read_requests</b>

get/partner_api/v1/communication_templates

Request

  • Base URL
    https://api.contentsnare.com
  • Auth
    • OAuth 2
      Authorization code: /oauth/authorization
      Token URL: /oauth/token scopes: read_requests
    • or HTTP bearer

Query parameters

limitinteger
Example:20

Specifies the maximum number of returned items

offsetinteger

Specifies how many items to skip from the beginning

filter_by[source]'company' | 'built_in' | 'shared'
Example:company

Filters templates by source. Use company to exclude built-in templates from dropdowns. Supported values: company, built_in, shared (shared returns no communication templates for communication template endpoints).<br><b>Examples:</b> filter_by[source]=company

Response

successful

Example response

{
  "pagination": {
    "limit": 200,
    "total_count": 425,
    "filter_by": {
      "source": "company"
    }
  },
  "results": [
    {
      "id": "ctp_R0yJ9VqTGD8j5n",
      "name": "Schedule1",
      "description": "schedule description",
      "source": "company"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.