---
sourceDocument: Yokohama API Reference
sourceDocumentLink: https://www.servicenow.com/docs/r/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Data Retrieval API

# Data Retrieval API {#ariaid-title1}

* Release version: Yokohama
* 
* Updated January 30, 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

Data Retrieval API method summaries and descriptions.
{#r_DataRetrievalAPI__id_gsh_xqt_3xb__entry__2}

| Method Summary | Description |
|-|-|
| [getKeys](https://www.servicenow.com/docs/xE0yXZaDTGSWXeIGpZp2aA "Query the targeted table by example values and return a comma delimited sys_id list.") | Query the targeted table by example values and return a comma delimited `sys_id` list. |
| [getRecords](https://www.servicenow.com/docs/PqkurE7DhVcU__2fySpmLA "Query the targeted table by example values and return all matching records and their fields.") | Query the targeted table by example values and return all matching records and their fields. |
| get | Query a single record from the targeted table by `sys_id` and return the record and its fields. |
| [aggregate](https://www.servicenow.com/docs/ClBZsYDkUeJPb8LgWYmqJA "Query a table using an aggregate function including SUM, COUNT, MIN, MAX, LAST, and AVG.") | Query using and aggregate functions SUM, COUNT MIN, MAX, LAST, and AVG. To enable the aggregate functions, activate the Aggregate Web Service Plugin. |
[Table 1. Data Retrieval API]

{#r_DataRetrievalAPI__id_gsh_xqt_3xb}
* **[getKeys](https://www.servicenow.com/docs/xE0yXZaDTGSWXeIGpZp2aA)**   
  Query the targeted table by example values and return a comma delimited `sys_id` list.
* **[getRecords](https://www.servicenow.com/docs/PqkurE7DhVcU__2fySpmLA)**   
  Query the targeted table by example values and return all matching records and their fields.
* **[get](https://www.servicenow.com/docs/jgPWOT9MKhLRXH3OvHtIUg)**   
  Query a single record from the targeted table by `sys_id` and return the record and its fields.
* **[aggregate](https://www.servicenow.com/docs/ClBZsYDkUeJPb8LgWYmqJA)**   
  Query a table using an aggregate function including SUM, COUNT, MIN, MAX, LAST, and AVG.

**Related reference**   

* [Data Modification API](https://www.servicenow.com/docs/jFiXKJexBrQFoEEbUbst5g "Data Modification API method summaries and descriptions.")