Search Subjects

subjects.search() -> SubjectSearchResponse

get/subjects/search

Search Subjects

ParametersExpand Collapse

query: str

Search query to match against subject name or email

limit: Optional[int]

maximum100

minimum1

offset: Optional[int]

minimum0

ReturnsExpand Collapse

class SubjectSearchResponse: …

has_more: bool

subjects: List[SubjectResource]

id: str

The ID of the subject.

created_at: datetime

The date and time the subject was created.

formatdate-time

email: Optional[str]

The email of the subject.

formatemail

external_id: Optional[str]

The ID of the subject in your system. You may pass it to the API in place of the subject ID.

metadata: Dict[str, str]

Additional metadata about the subject. You may use this to store any custom data about the subject.

name: Optional[str]

The name of the subject. Used for display in the dashboard.

Search Subjects

import os
from lark import Lark

client = Lark(
    api_key=os.environ.get("LARK_API_KEY"),  # This is the default and can be omitted
)
response = client.subjects.search(
    query="query",
)
print(response.has_more)

{
  "has_more": true,
  "subjects": [
    {
      "id": "subj_VyX6Q96h5avMho8O7QWlKeXE",
      "created_at": "2025-11-01T00:00:00Z",
      "email": "john.doe@example.com",
      "external_id": "user_1234567890",
      "metadata": {},
      "name": "John Doe"
    }
  ]
}

Returns Examples

{
  "has_more": true,
  "subjects": [
    {
      "id": "subj_VyX6Q96h5avMho8O7QWlKeXE",
      "created_at": "2025-11-01T00:00:00Z",
      "email": "john.doe@example.com",
      "external_id": "user_1234567890",
      "metadata": {},
      "name": "John Doe"
    }
  ]
}