Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Text Snippets

Return all text snippets

Outlines the parameters, optional and required, used when requesting the data for all TextSnippets

get/settings/text_snippets.json

Query parameters

created_sincestring date-time

Filter TextSnippet records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter TextSnippet records to those having the specified unique identifiers.

limitinteger

A limit on the number of TextSnippet records to be returned. Limit can range between 1 and 200. Default: 200.

order'id(asc)' | 'id(desc)' | 'snippet(asc)' | 'snippet(desc)' | 'phrase(asc)' | 'phrase(desc)' | 'whole_word(asc)' | 'whole_word(desc)'

Orders the TextSnippet records by the given field. Default: id(asc).

page_tokenstring

A token specifying which page to return.

querystring

Wildcard search for snippet or phrase matching a given string.

updated_sincestring date-time

Filter TextSnippet records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok