Introduction to Query Parameters

When you query records from Zuora objects, the following query parameters enable you to flexibly customize the returned results:

  • cursor : A cursor for use in pagination. cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects ending with next_page=W3sib3JkZXJ= , your subsequent call can include cursor=W3sib3JkZXJ= in order to fetch the next page of the list.
  • page_size : The maximum number of results to return in a single page. If the specified page_size is less than 1 or greater than 50, Zuora will return a 400 error.
  • expand[] : With this query parameter specified, you can expect to reduce the number of requests you make to the Zuora API by expanding objects in responses. See Expand responses for more information.
  • filter[] : The filter query string. See Filter lists for more information.
  • sort[] : A case-sensitive query parameter that specifies the sort order of the listed results in the response. The value should be in the {field}.{ASC|DESC} format, which can be either ascending (for example, account_number.ASC ) or descending (for example, account_number.DESC ). You cannot sort on properties in arrays. If the array-type properties are specified for the sort[] parameter, they are ignored.
  • <object>.fields[] : Allows you to specify which fields to be returned in the response. For the detailed instructions, see List Specific Fields in Response .