Header and Parameter Special Values

In paginated API calls the pagination parameters are provided either as query parameters, or (less commonly) as header values. Since these values change with each call to the API, these can be specified in the query parameter or header tables.

This is provided by special properties that have the syntax {{…}}. These special values are as follows:
  • {{record_count}}

    Specifies the value of records per call property.

    For example: The {{record_count}} value provides a mechanism by which the Records per Call property can be easily changed or passed as a flow variable, without changing the value in the parameter or header definition.

  • {{offset}}

    Specifies the next offset value. On each call this will be incremented by the value of the Records per Call property.

  • {{page}}

    Specifies the next page number. On each call this will be incremented.

  • {{pagination_token}}

    Specifies the pagination token from the prior call. On the first call, the query parameter or header will not be set. On subsequent calls, it will be set to the value of the pagination token from the previous call.