Query Parameters

Query parameters define how to filter and organize the query results from GET endpoints that return an array of values. Query parameters are specific to each endpoint and they are listed in the Request section of the API reference documentation under Query Parameters.

Query Parameters in API Reference Documentation

Query Parameters in API Reference Documentation

To filter query results, add one or more query parameters at the end of the request URI after a question mark (?). Query parameters and their values are name-value pairs, which are separated with an equals sign (=). Each name-value pair is separated by an ampersand (&).

Copy

Example Request URI with Query Parameters

https://example-gotransverse.com/billing/2/charge-categories?return=FULL&page_number=4&page_size=25&omit_total_count=false

The following query parameters are commonly available for most GET endpoints:

Common Query Parameters
Name Description Data Type Notes

filter

Use Gotransverse API Query Language to filter the query results using the available query parameters.

string

Refer to Filter Query Parameter.

sort

Sort query results in ascending or descending order using the available sortable query parameters for the endpoint.

string

Default is to sort results by the ID in ascending order.

Refer to Sort Query Parameter.

return

Specifies if the API response returns all expandable entities as expanded or not expanded.

  • SIMPLE

  • FULL

string

Default value is FULL.

page_number

The quantity of pages of results to return. Value must be >0.

  • 1 — Returns one page with all results.

  • >2 — Returns multiple pages of results with the page_ size value defining how many results are listed on each page.

integer

Default value is 1.

page_size

The quantity of results returned per page when the page_number query parameter value is >2.

Value must be 1 - 50.

integer

Default value is 50.

omit_total_count

Specifies whether the total number of results are returned in the API response. Available values are:

  • TRUE — X-total-count and X-total-pages are not returned in the response header. This may improve the response time when querying a large data sets.

  • FALSE — X-total-count and X-total-pages are returned in the response header.

boolean

Default value is FALSE.

Refer to the following topics for more information: