Data Retrieval API
reference australia Updated Sep 10, 2026 1 min read r_DataRetrievalAPI.md
Data Retrieval API method summaries and descriptions.
| Method Summary | Description |
|---|---|
| getKeys | Query the targeted table by example values and return a comma delimited sys_id list. |
| getRecords | 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 | Query using and aggregate functions SUM, COUNT MIN, MAX, LAST, and AVG. To enable the aggregate functions, activate the Aggregate Web Service Plugin. |
- getKeys
Query the targeted table by example values and return a comma delimitedsys_idlist. - getRecords
Query the targeted table by example values and return all matching records and their fields. - get
Query a single record from the targeted table bysys_idand return the record and its fields. - aggregate
Query a table using an aggregate function including SUM, COUNT, MIN, MAX, LAST, and AVG.
Parent Topic:SOAP direct web service API functions
Related topics
42 lines · 2.8 KB
--- title: Data Retrieval API description: Data Retrieval API method summaries and descriptions. locale: en-US canonical_url: https://www.servicenow.com/docs/r/australia/api-reference/web-services/r\_DataRetrievalAPI.html release: australia product: Web Services classification: web-services topic_type: reference last_updated: "2026-09-10" reading_time_minutes: 1 breadcrumb: [API functions, Direct services, SOAP web service, Inbound, Web services, API implementation, API implementation and reference] --- # Data Retrieval API Data Retrieval API method summaries and descriptions. |Method Summary|Description| |--------------|-----------| |[getKeys](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/web-services/r_GetKeys.md)|Query the targeted table by example values and return a comma delimited `sys_id` list.| |[getRecords](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/web-services/r_GetRecords.md)|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://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/web-services/r_Aggregate.md)|Query using and aggregate functions SUM, COUNT MIN, MAX, LAST, and AVG. To enable the aggregate functions, activate the Aggregate Web Service Plugin.| - **[getKeys](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/web-services/r_GetKeys.md)** Query the targeted table by example values and return a comma delimited `sys_id` list. - **[getRecords](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/web-services/r_GetRecords.md)** Query the targeted table by example values and return all matching records and their fields. - **[get](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/web-services/r_Get.md)** Query a single record from the targeted table by `sys_id` and return the record and its fields. - **[aggregate](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/web-services/r_Aggregate.md)** Query a table using an aggregate function including SUM, COUNT, MIN, MAX, LAST, and AVG. **Parent Topic:**[SOAP direct web service API functions](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/web-services/r_DirectWebServiceAPIFunctions.md) **Related topics** [Data Modification API](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/web-services/r_DataModificationAPI.md)
| title | Data Retrieval API |
| description | Data Retrieval API method summaries and descriptions. |
| locale | en-US |
| canonical_url | https://www.servicenow.com/docs/r/australia/api-reference/web-services/r\_DataRetrievalAPI.html |
| release | australia |
| product | Web Services |
| classification | web-services |
| topic_type | reference |
| last_updated | 2026-09-10 |
| reading_time_minutes | 1 |
| breadcrumb | API functionsDirect servicesSOAP web serviceInboundWeb servicesAPI implementationAPI implementation and reference |