---
title: "List API clients"
method: GET
path: "/apiops/projects/{projectName}/api-clients"
tags: ["ApiClient"]
---

# List API clients

`GET /apiops/projects/{projectName}/api-clients`

## Request

- Base URL: `http://167.86.118.166:32080`
- URL: `http://167.86.118.166:32080/apiops/projects/{projectName}/api-clients`
- Auth: none declared
- TypeScript: <https://skmtc.dev/apinizer/apis/apinizer-management-apis/docs/apiops/projects/:projectName/api-clients/get.ts> (a function with typed inputs; its response is checked against the schema)

The project's API clients, by clientId by default; filterable by owner (type + key), lifecycle state and a clientId/description search; sortable by clientId, operationalState, expiresAt.

## Path parameters

- `projectName` string, required

## Query parameters

- `ownerType` 'CONSUMER' | 'APPLICATION'
- `ownerKey` string
- `state` 'DRAFT' | 'ACTIVE' | 'SUSPENDED' | 'REVOKED'
- `search` string
- `page` integer
- `size` integer
- `sort` string

## Response `200`

OK

- ApiOpsPagedResponseApiOpsResponseApiClient
  - `status` 'SUCCESS' | 'FAILURE'
  - `items` ApiOpsResponseApiClient[]
    - `apiClientKey` string
    - `clientId` string
    - `description` string
    - `owner` ApiOpsApiClientOwnerDTO
      - `type` 'CONSUMER' | 'APPLICATION'
      - `key` string
    - `organizationCode` string
    - `operationalState` 'DRAFT' | 'ACTIVE' | 'SUSPENDED' | 'REVOKED'
    - `readiness` 'READY' | 'PENDING_SECRET' | 'UNRESOLVED_DEPENDENCY'
    - `validFrom` string, date-time
    - `expiresAt` string, date-time
    - `allowedGrantTypes` string[]
    - `tokenEndpointAuthMethod` string
    - `redirectUris` string[]
    - `tokenIssuanceProfile` string
    - `tokenNeverExpires` boolean
    - `tokenExpiresInAmount` integer
    - `tokenExpiresInUnit` 'MILLI_SECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS'
    - `refreshTokenAllowed` boolean
    - `refreshTokenCount` integer
    - `refreshTokenExpiresInAmount` integer
    - `refreshTokenExpiresInUnit` 'MILLI_SECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS'
    - `jwtSignatureAlgorithm` string
    - `revokedAt` string, date-time
    - `revokedBy` string
    - `revokedReason` string
    - `lifecycleRevision` integer
    - `version` integer
    - `secretVersions` ApiOpsResponseApiClientSecretVersion[]
      - `versionId` string
      - `label` string
      - `status` 'PENDING_ACTIVATION' | 'ACTIVE' | 'GRACE' | 'REVOKED'
      - `materialType` string
      - `storageMode` 'ENCRYPTED' | 'HASHED'
      - `recoveryState` 'AVAILABLE' | 'UNAVAILABLE' | 'SHREDDED'
      - `validFrom` string, date-time
      - `expiresAt` string, date-time
      - `graceUntil` string, date-time
      - `createdAt` string, date-time
      - `revokedAt` string, date-time
      - `revokedReason` string
      - `version` integer
  - `page` integer
  - `size` integer
  - `totalElements` integer
  - `totalPages` integer
  - `sort` string[]

---

[API](https://skmtc.dev/apinizer/apis/apinizer-management-apis.md) - [All operations](https://skmtc.dev/apinizer/apis/apinizer-management-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/apinizer/apis/apinizer-management-apis/revisions/e083046b24cd?raw)