# List clients

Paginated; optional q does a case-insensitive contains-match across displayName and externalId. Default sort: displayName ascending.

Endpoint: GET /integration/rest/api/v1/client
Version: v0
Security: X-AUTH-KEY

## Query parameters:

  - `q` (string)
    Free-text search across displayName and externalId

  - `pageNumber` (integer)
    Page number (1-based)

  - `pageSize` (integer)
    Page size

  - `sort.sortBy` (string)
    Sorting field

  - `sort.direction` (string)
    Sorting direction
    Enum: "ASC", "DESC"

## Response 200 fields (*/*):

  - `content` (array)

  - `content.createDate` (string)

  - `content.updateDate` (string)

  - `content.deepLink` (string)
    Deep link URL to open this entity in Ops.App.

  - `content.displayName` (string)
    Customer-visible display name. Unique per organization (case-insensitive).

  - `content.externalId` (string)
    Customer-side external identifier. Unique per organization (case-insensitive).

  - `pageRequest` (object)

  - `pageRequest.pageNumber` (integer)

  - `pageRequest.pageSize` (integer)

  - `pageRequest.sort` (object)

  - `pageRequest.sort.sortBy` (string)

  - `pageRequest.sort.direction` (string)
    Enum: "ASC", "DESC"

  - `totalElements` (integer)

## Response 403 fields (*/*):

  - `code` (string)
    Error code

  - `message` (string)
    Error message

  - `timeStamp` (integer)
    Timestamp

  - `correlationId` (string)
    Correlation id