API Reference

Subjects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Subjects

get/subjects

List Subjects

Query ParametersExpand Collapse

limit: optional number

maximum100

minimum1

offset: optional number

minimum0

ReturnsExpand Collapse

has_more: boolean

subjects: array of SubjectResource { id, created_at, email, 3 more }

id: string

The ID of the subject.

created_at: string

The date and time the subject was created.

formatdate-time

email: string

The email of the subject.

formatemail

external_id: string

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

metadata: map[string]

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

name: string

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

List Subjects

HTTP

HTTP

TypeScript

Python

Go

Terraform

curl https://api.uselark.ai/subjects \
    -H "X-API-Key: $LARK_API_KEY"

200 example

{
  "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

200 example

{
  "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"
    }
  ]
}