Service Modules > Scheduling and Optimization > Service Board > Max for Developers > Appendix B: Max REST API > REST API Version 2 > Count Records of a Specified Object
 
Count Records of a Specified Object
Method
GET
URL
/v2/<object_full_identifier>/count
Parameters
filter
Response Content Type
application/json
Example Response
The response is an integer that represented the total number of records counted.
Parameters
Parameter
Description
Data Type
Example
filter
Filtering condition that selects the records to be counted. SQML syntax for the WHERE clause is supported to allow filtering on eager-loaded fields.
If not specified, all undeleted records are counted.
String
Count only the records updated by the system user:
/v2/<object_full_identifier>/count?filter=io_updated_by.io_username='system'
Error Response Messages
HTTP Status Code
Error Type
Error Message
400
missing_parameter_error
Missing or invalid required parameter
400
smql_query_error
SMQL query error
400
serialization_error
Serialization error
500
server_error
Server error
Access Control
This REST API endpoint respects access control and permissions for each record. Data that users lack permissions to read is not returned. All authenticated users (for example, with the Standard User role) can execute this REST endpoint.
Examples
• Count all undeleted objects:
https://server/v2/io_object/count
• Count all undeleted objects created after January 1, 2024:
https://server/v2/io_object/count?filter=io_created_on>'2024-01-01'
• Count all undeleted objects updated by the system user:
https://server/v2/io_object/count?filter=io_updated_by.io_username='system'
• Count all Showcase records, including deleted records:
https://<server>/v2/io_showcase/count?filter=io_deleted=true+or+io_deleted=false
For more information:
Was this helpful?