v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

List custom object records

Returns a paginated list of records for the specified custom object type. Use offset and limit to paginate through results, and $field query parameters to filter. See <u>List endpoints</u> for more information about <u>pagination</u> and <u>filtering</u>.

get/v1/objects/{entitySlug}

Path parameters

entitySlugstring required

The slug of the custom object type.

Query parameters

offsetinteger

Number of records to skip for pagination. Defaults to 0.

limitinteger

Maximum number of records to return. Defaults to 25, maximum 25.

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Response

OK

objectstring required

The object type, always "list".

totalCountinteger required

Total number of entities matching the query.