Message templates

Find all message templates.

Changed on

Find the message templates of a project that are visible to the calling agent (public templates plus templates shared with them), ordered by lexorank.

get/message-templates

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/message-templates
  • Auth
    HTTP bearer

Query parameters

limitnumber double
  • Maximum number of templates to return; unlimited when omitted (with searchTerm: default 25, max 50).
skipnumber double
  • Number of templates to skip.
searchTermstring
  • Matches the template title first, then body text. Search results are capped (default 25, max 50) and include matchedIn and matchSnippet.
visibilitystring
  • public for public templates only, private for non-public templates shared with the caller; omit for both.
withCountboolean
  • Return { data, totalCount } instead of a plain array.
forUsageboolean
  • Apply usage restrictions: exclude templates limited to teams the caller is not a member of. Sent by the template pickers; the settings pages omit it so restricted templates stay manageable.
ticketTypestring
  • Exclude templates limited to other ticket types.
tagstring
  • Only templates carrying this tag.

Headers

projectstring required

Response

Ok

OR

Changes

  • 9e2491ede559Revision changes
    • info

      added the new optional query request parameter forUsage

    • info

      added the new optional query request parameter tag

    • info

      added the new optional query request parameter ticketType

  • 9a01f65f3445Revision changes
    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status