## List all individuals (client profiles)

**get** `/individuals`

Retrieve a paginated list of client profiles/individuals using cursor-based pagination

### Query Parameters

- `after: optional string`

  Cursor for forward pagination. Returns items after this cursor.

- `before: optional string`

  Cursor for backward pagination. Returns items before this cursor.

- `household_id: optional string`

  Filter individuals by household ID

- `is_primary: optional boolean`

  Filter by primary client status

- `limit: optional number`

  Maximum number of items to return

### Returns

- `IndividualList object { data, page_info, total_count }`

  - `data: array of Individual`

    - `id: string`

      Unique identifier with client_profile_ prefix

    - `created_at: string`

      Timestamp when the individual was created

    - `first_name: string`

      First name of the individual

    - `household_id: string`

      Household ID this individual belongs to

    - `is_beneficiary: boolean`

      Whether this client profile should be an eligible beneficiary for entities and gifts

    - `is_deceased: boolean`

      Whether this client profile is deceased

    - `is_grantor: boolean`

      Whether this client profile should be an eligible grantor/owner/other principal for entities

    - `is_primary: boolean`

      Whether this is one of the (at most) two primary clients on this household

    - `is_trustee: boolean`

      Whether this client profile should be an eligible trustee for entities

    - `last_name: string`

      Last name of the individual

    - `updated_at: string`

      Timestamp when the individual was last updated

    - `address_line1: optional string`

      Street address line 1 (from address edge)

    - `address_line2: optional string`

      Street address line 2 (from address edge)

    - `city: optional string`

      City (from address edge)

    - `country: optional string`

      Country (from address edge)

    - `date_of_birth: optional string`

      Date of birth (encrypted field)

    - `date_of_death: optional string`

      Date of death if applicable (encrypted field)

    - `deleted_at: optional string`

      Timestamp when the individual was soft deleted

    - `email: optional string`

      Email address

    - `middle_name: optional string`

      Middle name of the individual

    - `notes: optional string`

      Notes about the client profile

    - `postal_code: optional string`

      ZIP or postal code (from address edge)

    - `state: optional string`

      State or province (from address edge)

    - `suffix: optional string`

      Name suffix (Jr., Sr., III, etc.)

  - `page_info: PageInfo`

    - `has_next_page: boolean`

      When paginating forwards, are there more items?

    - `has_previous_page: boolean`

      When paginating backwards, are there more items?

    - `end_cursor: optional string`

      Cursor pointing to the last item in the current page

    - `start_cursor: optional string`

      Cursor pointing to the first item in the current page

  - `total_count: number`

    Total number of items matching the query (across all pages)

### Example

```http
curl https://$WITHLUMINARY_SUBDOMAIN.withluminary.com/api/public/v1/individuals
```

#### Response

```json
{
  "data": [
    {
      "id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "first_name": "John",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "is_beneficiary": true,
      "is_deceased": true,
      "is_grantor": true,
      "is_primary": true,
      "is_trustee": true,
      "last_name": "Smith",
      "updated_at": "2024-01-20T14:45:00Z",
      "address_line1": "123 Main St",
      "address_line2": "Apt 4B",
      "city": "San Francisco",
      "country": "USA",
      "date_of_birth": "1980-05-15",
      "date_of_death": "2019-12-27",
      "deleted_at": "2019-12-27T18:11:19.117Z",
      "email": "john.smith@example.com",
      "middle_name": "Michael",
      "notes": "notes",
      "postal_code": "94102",
      "state": "CA",
      "suffix": "Jr."
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}
```