GET /v2/theme

Servers

Query parameters

Name Type Required Description
order_criteria String No

Possible values:

  • "name"
  • "created_at"
  • "updated_at"
page_number Number No

A filter query in RSQL format to retrieve customers based on page number. If not selected then a default pageNumber is 1.

search String No

RSQl Query is composed of one or more expressions, combined to each other with following logical operators:

A filter query in RSQL format to retrieve themes. The returned themes are limited to those that can be retrieved by the user.

CriteriaDescriptionOperator Used
namestring==, !=, =in=, =out=, =regex=, =contains=
created_atdate==, !=, =in=, =out=, =gt=, =ge=, =lt=, =le=
updated_atdate==, !=, =in=, =out=, =gt=, =ge=, =lt=, =le=
entity_idstring==, !=, =in=, =out=, =regex=
is_defaultboolean==, !=

Note:

OperatorDescription
==equal
!=not equal
=lt=less than
=le=less than and equal to
=gt=greater than
=ge=greater than and equal to
=regex=pattern matching
=contains=case insensitive substring matching
=in=multiple arguments search
=out=exclude
;Logical AND
,Logical OR

Note: Parenthesis can be used to determine the precedence of the operator.

Example for list theme:

  • /v2/theme?search=
    name==ThemeName&
    order_by=ASC&
    order_criteria=name&
    page_size=1&
    page_number=2

  • /v2/theme?search=
    name==ThemeName&
    order_by=DESC&
    order_criteria=created_at&
    page_size=10&
    page_number=1

page_size Number No

A filter query in RSQL format to retrieve customers based on page size. If not selected then a default pageSize is 50

order_by String No

The ordering sequence of the selected customers If not selected then Descending order is the default order.

Possible values:

  • "DESC"
  • "ASC"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.