Instance Records

Get Records

Query records from a model using the async query builder.

Permissions: Requires read access to the instance; database row-level permissions still apply.

Quota: Returns at most 200 records and 50 items per related collection.

post/instances/{instance_id}/modules/{module_name}/{model_name}

Request

  • Base URL: https://lamin.ai/api
  • URL: https://lamin.ai/api/instances/{instance_id}/modules/{module_name}/{model_name}
  • Auth: HTTP bearer

Path parameters

module_namestring required

Schema module name.

model_namestring required

Model name within the schema module.

instance_idstring uuid required

Instance UUID.

Query parameters

limitinteger

Maximum number of records to return.

offsetinteger

Number of records to skip.

limit_to_manyinteger

Maximum number of related records to include.

include_foreign_keysboolean

Include foreign-key columns in the result.

space_idstring uuid nullable

Space UUID for space-scoped access checks.

Request body

selectstring[] nullable
searchstring
search_instring[] nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.