v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB

Criteria Type

Search Criteria Types

Search Criteria Types given a query.

get/progressions/criteria-types/search

Query parameters

sortstring

Specifies the order in which the list will be returned. Default order is ascending. Default sort attribute is Id. Specify desc_ to sort descending format: "sort=desc_snake_cased_attribute_name" OR "sort=snake_cased_attribute_name" ex. sort=desc_updated_on

pageinteger

Specifies the page of records to be returned. Defaults to 1.

page_sizeinteger

Number of records to return per page. Maximum and default are 100 records.

qstring required

Search query. See the Search section for guidance on how to build a query.

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Response

list of Criteria Types data

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user.

Example response

{
  "criteria_types": [
    {
      "id": 1234567891234567
    }
  ]
}