> ## Documentation Index
> Fetch the complete documentation index at: https://diameterpay.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Individual End Users

> GET /v1/end-users/individuals — Search and filter individual end users with pagination. Requires end-users:read scope.

Returns a paginated list of individual end users matching your filter criteria. All query parameters are optional — omitting them returns all individual end users accessible to your account in descending creation order. You can narrow results by name (partial match), specific end user IDs, product, or your own internal identifier. Use `page` and `limit` to walk through large result sets.

## Endpoint

```
GET /v1/end-users/individuals
```

**Required scope:** `com.diameterpay.api/end-users.read`

## Request Headers

**Authorization** `string` *required*

Bearer token obtained from your OAuth 2.0 token endpoint. Format: `Bearer {access_token}`

## Query Parameters

**page** `integer`

Page number to return. Defaults to `1`.

**limit** `integer`

Number of records per page. Defaults to `10`. Maximum is `100`.

**name** `string`

Partial name search applied against `fullName`. Case-insensitive. For example, `name=jane` matches `Jane Smith` and `Jane Doe`.

**endUserIds** `array`

Filter to a specific set of end user UUIDs. Pass multiple values as repeated query parameters: `endUserIds=uuid1&endUserIds=uuid2`.

**productId** `string`

UUID v4 of the product. When provided, only end users associated with that product are returned.

**internalEndUserId** `string`

Exact match filter on `internalEndUserIdentifier`. Useful for looking up a Diameter record using your own system's ID.

## Response

Returns `200 OK` with a paginated response envelope containing an array of `IndividualEndUserOutput` objects.

**data** `array`

Array of individual end user objects matching the query. Each object has the same structure as the [Get Individual End User](https://diameterpay.mintlify.site/api-reference/end-users/get-individual.md) response.

**pagination** `object`

Pagination metadata.

**pagination fields**

**page** `integer`

The current page number.

**limit** `integer`

Number of records returned per page.

**totalItems** `integer`

Total number of individual end users matching the filter criteria.

**totalPages** `integer`

Total number of pages available given the current `limit`.

**hasNextPage** `boolean`

`true` if there is at least one more page of results after this one.

**hasPreviousPage** `boolean`

`true` if this is not the first page.

## Example Request

```bash theme={null}
curl --request GET \
  --url 'https://api.sandbox.diameterpay.com/v1/end-users/individuals?page=1&limit=10&name=jane&productId=a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  --header 'Authorization: Bearer {access_token}'
```

### Filtering by Multiple IDs

```bash theme={null}
curl --request GET \
  --url 'https://api.sandbox.diameterpay.com/v1/end-users/individuals?endUserIds=f47ac10b-58cc-4372-a567-0e02b2c3d479&endUserIds=c1d2e3f4-a5b6-7890-cdef-012345678901' \
  --header 'Authorization: Bearer {access_token}'
```

### Lookup by Internal ID

```bash theme={null}
curl --request GET \
  --url 'https://api.sandbox.diameterpay.com/v1/end-users/individuals?internalEndUserId=usr_1234567890' \
  --header 'Authorization: Bearer {access_token}'
```

## Example Response

```json theme={null}
{
  "data": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "firstName": "Jane",
      "middleName": null,
      "lastName": "Smith",
      "fullName": "Jane Smith",
      "email": "jane.smith@example.com",
      "mobilePhone": "+12125551234",
      "dateOfBirth": "1990-07-15",
      "nationality": "US",
      "idType": "PASSPORT",
      "idNumber": "A12345678",
      "idCountry": "US",
      "pepStatus": "NO",
      "gender": null,
      "onboardingStatus": "ACTIVE",
      "onboardedInBanks": ["PORTAGE"],
      "addresses": [
        {
          "addressType": "RESIDENTIAL",
          "country": "US",
          "postalCode": "10001",
          "townName": "New York",
          "streetName": "5th Avenue",
          "buildingNumber": "350",
          "countrySubdivision": "NY"
        }
      ],
      "internalEndUserIdentifier": null,
      "createdAt": "2024-06-01T12:00:00.000Z",
      "updatedAt": "2024-06-01T12:05:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "totalItems": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.