Skip to main content

Get provider templates with optional filters and pagination​

Flexible query endpoint for provider templates. dealerUuid is required; all other filters are optional. Defaults to isActive=true, isValid=true (showing only current active templates). Common usage patterns:

  • List all active templates for a dealer: ?dealerUuid=<uuid> (defaults handle the rest)
  • Look up the active version of a specific template: ?dealerUuid=<uuid>&templateName=<name>&language=en&channel=WHATSAPP — returns at most 1 result since templateName+dealerUuid+language+channel uniquely identifies the active template
  • Look up by contentSid: ?dealerUuid=<uuid>&contentSid=<sid> — contentSid is globally unique, so this always returns 0 or 1 result; pagination is not meaningful
  • Look up by meta display name: ?dealerUuid=<uuid>&metaDisplayName=<displayName> — metaDisplayName+dealerUuid is unique among valid rows, so returns 0 or 1 result
  • Browse all versions (including inactive): ?dealerUuid=<uuid>&templateName=<name>&isActive= (pass isActive without a value or omit the default to see all versions)
  • Filter by approval status: ?dealerUuid=<uuid>&approvalStatus=PENDING
  • Filter by category: ?dealerUuid=<uuid>&category=MARKETING

Pagination (page/size) is useful when listing all templates for a dealer. Max page size is 100.
ApiScope: manage.providertemplate.read
API Scope Level: DealerScope

Path Parameters
    dealerUUID string required

    Dealer UUID (required). Scopes all queries to a single dealer.

Query Parameters
    providerTemplateUuid string

    Provider template UUID. Returns at most 1 result.

    templateName string

    myKaarma's stable template identifier. Combined with dealerUuid+language+channel, uniquely identifies the active template.

    metaDisplayName string

    Meta/Facebook display name for the template. Unique per dealerUuid among valid rows.

    category string

    Template category. Values: MARKETING, UTILITY, AUTHENTICATION

    language string

    Language code (e.g. 'en', 'es')

    channel string

    Messaging channel. Default: WHATSAPP. Future: RCS

    approvalStatus string

    Approval status filter. Values: UNAPPROVED, PENDING, APPROVED, REJECTED, PAUSED, DISABLED, UNRESPONSIVE

    type string

    Template type (e.g. TWILIO_TEXT)

    isActive string

    Default value: true

    Filter by active flag. Values: true (only active, default), false (only inactive), all (both active and inactive).

    isValid boolean

    Default value: true

    Filter by valid flag. Defaults to true (excludes soft-deleted). Set to false to see deleted templates.

    isManual boolean

    Filter by manual flag. true = manually created, false = auto-created

    contentSid string

    Content SID from the provider. Globally unique — returns at most 1 result.

    page int32

    Page number (0-indexed). Default: 0

    size int32

    Default value: 20

    Page size. Default: 20, max: 100. Not meaningful when querying by unique keys (contentSid, name+dealerUuid, templateName+dealerUuid+language+channel).

Responses

OK

Schema
    errors object[]
  • Array [
    • errorCode int32
    errorTitle string
    errorMessage string
  • ]
    • warnings object[]
  • Array [
    • warningCode int32
    warningTitle string
    warningMessage string
  • ]
    • apiRequestId string
    links object
    property name* string
    providerTemplates object[]
  • Array [
    • uuid string
    dealerUuid string
    templateName string
    friendlyName string
    metaDisplayName string
    category string
    contentSid string
    language string
    body string
    approvalStatus string
    type string
    channel string
    isValid boolean
    rejectionReason string
    isManual boolean
    isActive boolean
    dateCreated string
    dateUpdated string
    insertTs string
    updateTs string
  • ]
    • totalPages int32
    totalElements int64
    currentPage int32
    pageSize int32
Loading...