Instance Records

Get Relatives

Query hierarchical relatives asynchronously. Requires instance read access.

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

Request

  • Base URL: https://lamin.ai/api
  • URL: https://lamin.ai/api/instances/{instance_id}/modules/{module_name}/{model_name}/relatives
  • 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

The maximum number of relative records to return.

offsetinteger

The offset for paginating through the results.

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.