Business Entity Services Guide

10.3

Back Next

Standard Query Parameters

The business entity services REST APIs use standard query parameters to filter, paginate, and expand the results.

Use a question mark (?) to separate the query parameters from the other parameters. Query parameters are key-value pairs separated by the equal sign. Use an ampersand (&) to separate a sequence of query parameters.

The following REST request URL shows how to use query parameters:

/Person/123/Phone/SFA:456/PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING

Use the following standard query parameters:

Parameter	Description
recordsToReturn	Specifies the number of rows to return. Default is 10.
firstRecord	Specifies the first row in the result. Default is 1. Used in subsequent calls to read more pages.
searchToken	Specifies the search token returned with previous request. You can use the search token to fetch subsequent pages of search results. For example, the following query lists the first page: /Person/123/Phone The following query returns the second page: /Person/123/Phone?searchToken=SVR1.AZAM5&firstRecord=10
returnTotal	If set to true, returns the number of records in the result. Default is false.
depth	Specifies the number of child levels to include in the result.

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

Standard Query Parameters

Standard Query Parameters