# Get borrowers

Get borrowers filtering with optional parameters.

Endpoint: GET /people
Version: 2025-03-26
Security: oauth2, bearerAuth, apiKeyHeader

## Query parameters:

  - `searchable` (boolean)
    If `true`, format the entire response as one suitable for an ElasticSearch search index.

  - `status` (string)
    Status of borrower(s).

  - `limit` (integer)
    The maximum count of results to retrieve.

  - `sortBy` (array)
    The data attributes by which to sort the results.

  - `startingAfter` (string)
    Return results starting after the provided object identifier.

  - `endingBefore` (string)
    Return results ending before the provided object identifier.

  - `borrowerType` (string)
    Exactly match the type of borrower.

  - `ids` (array)
    List of IDs.

## Response 200 fields (application/json):

  - `count` (integer)
    Number of items returned by the current request.

  - `nextUrl` (string)
    URL of the next set of results.

  - `previousUrl` (string)
    URL of the previous set of results.

  - `status` (integer)
    HTTP status code.

  - `total` (integer)
    Total number of items in this result.

  - `data` (array)

  - `data.identities` (array)

  - `data.identities.isPrimary` (boolean)
    Whether the identity is the borrower's primary identity or not. A borrower may
only have one primary identity. Primary identities can be created when
creating a borrower, or separately.

  - `data.redactedFields` (array)
    Paths of fields on this object whose values were hidden because your credentials lack the `person:read.pii` permission. Always present on responses that can carry personal data — an empty array means nothing was hidden. Paths are relative to this object. Objects nested inside this one, including every element of an array of objects, carry their own list rather than appearing here. A path ending in `[]` is an array of plain values such as `selfEmails[]`, and means at least one element of that array was hidden — not necessarily all of them. This field is never accepted on requests.
    Example: ["name.lastName","dateOfBirth"]