---
schema_version: "1"
id: aacedfa442d06e6cf790b9f80927e75c59c15e74e1244cd9b5a4650b6e544ffb
title: Named Query API
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/platform/api-rest/guides/resources/resources-named-query.md
canonical_url: https://developer.salesforce.com/docs/platform/api-rest/guide/resources-named-query.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: d13111804870cca561ad042af05da5dd985eeda7529a35c19ee161fd85e4b97e
products:
  - REST API Developer Guide
  - Platform Developer Content
---

# 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|

## Syntax

**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&param_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

**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.

```nolang

/services/data/vXX.X/named/query/Get_Account_Details_From_Name?name=Acme
      
```

**Example Response Body**

```nolang
{
    "totalSize": 1,
    "done": true,
    "records": [
        {
            "attributes": {
            "type": "Account",
            "url": "/services/data/v64.0/sobjects/Account/001Ws00003cPDMRIA4"
            },
            "Name": "Acme",
            "Description": "A trendy, fast-casual dining group offering an eclectic mix of globally inspired dishes. Known for its vibrant, urban ambiance and innovative menu, Urban Eats Collective brings city vibes to every meal.",
            "Phone": "214-555-1010",
            "Website": "www.urbaneats.com",
            "NumberOfEmployees": 500,
            "BillingAddress": {
                "city": "Dallas",
                "country": "USA",
                "geocodeAccuracy": null,
                "latitude": null,
                "longitude": null,
                "postalCode": "75219",
                "state": "TX",
                "street": "2401 Victory Avenue"
            }
        }
    ]
}
```