Named Query API
When you create a Named Query API, it’s available as a REST API call. The name of the Named Query API defines the endpoint, while parameters appear as URI query parameters.
| User Permissions Needed | |
|---|---|
| To execute a Named Query API: | View Setup and Configuration |
URI: /services/data/vXX.X/named/query/NQ_API_NAME?param_name=param_value
Formats: JSON
HTTP Method: GET
Authentication: Authorization: Bearer token
Parameters
| Parameter | Description |
|---|---|
NQ_API_NAME | The name of the Named Query API you want to call. |
param_name=param_value | A Named Query API parameter and its value. If the Named Query API has multiple parameters, you must include all of them as URI parameters by using the format param_name1=param_value1¶m_name2=param_value2. Only these literal types are supported for parameter values in a Named Query API request. |
Supported literal types for Named Query API parameter values:
- String (example:
name=Acme) - Date (example:
closedate=2025-10-14) - Time (example:
endtime=17:30:00-07:00) - Datetime (example:
date=2025-10-14T09:00:00-07:00) - Date Formula (Fixed) (example:
createddate=TODAY) - Date Formula (Variable) (example:
createddate=LAST_N_DAYS:10) - Integer (example:
quantity=36) - Decimal (example:
amount=10.99) - Boolean (
doNotCall=false) - Multi-Currency (
amount=USD20000)
Example Request
This request references the Named Query API GetAccountDetailsFromName. The query parameter name is defined on the Named Query API that generates this sample code.
Example Response Body