Object Records


# Here is a curl example
curl \
X GET -H "Authorization:{token}" http://localhost:8888/api/Objects/ObjectRecords
      ?object_id=111&show_all=true&include_subfolders=true&include_custom_fields=true
      &simple_text=test&fields_name=_System_Test
      &page_number=1&page_size=100

To get the object records, you need to make a GET call to the following url :
http://localhost:8888/api/Objects/ObjectRecords


Result example :

{
  "records": [
    {
      "object_id": 0,
      "record_id": 0,
      "object_type": 0,
      "record_guid": "string",
      "record_fields": [
        {
          "system_name": "string",
          "system_description": "string",
          "value": {}
        }
      ]
    }
  ],
  "pager": {
    "HasNext": true,
    "HasPrevious": true,
    "CurrentPage": 0,
    "PageSize": 0,
    "TotalPages": 0,
    "TotalCount": 0
  }
}

Query Parameters

Field	Parameter Type	Type	Description
object_id	query	long	Object Id.
show_all	query	boolean	Show All (Optional - default false).
include_subfolders	query	boolean	Include Subfolders (Optional - default false).
include_custom_fields	query	boolean	Determines whether custom fields should be included in the response. When set to `true` (default), the API returns both system and custom fields. When set to `false`, only the system-defined fields are included. This parameter is optional and is useful for optimizing performance or limiting data when custom fields are not required.
simple_text	query	string	Simple Text (Optional - default "").
fields_name	query	string	Fields Name (Optional - default "").
page_number	query	integer	Page Number (Optional - default 1). A cursor for use in pagination. Specifies the page number to display.
page_size	query	integer	Page Size (Optional - default 100). A limit on the number of objects to be returned, between 1 and 100.
Authorization	header	string	Add Authorization header token