---
title: "Get a list of API Keys for a User"
method: GET
path: "/users/{userId}/apikeys/v1"
tags: ["ApiKeys"]
---

# Get a list of API Keys for a User

`GET /users/{userId}/apikeys/v1`

## Request

- Base URL: `https://demo.octopus.app/api`
- URL: `https://demo.octopus.app/api/users/{userId}/apikeys/v1`
- Auth: one of:
  - API key in header `X-Octopus-ApiKey`
  - API key in query parameter `ApiKey`
  - API key in header `X-NuGet-ApiKey`

Lists all API keys for a user, returning the most recent results first.

## Path parameters

- `userId` string, required

## Query parameters

- `partialKeyword` string
- `partialPurpose` string
- `skip` integer
- `take` integer

## Response `200`

Success

- GetUserApiKeysResponse
  - `ApiKeys` ApiKeyResourceCollection
    - `Id` string: Gets or sets a unique identifier for this resource.
    - `Items` ApiKeyResource[]
      - `AccessLevel` 'FullAccess' | 'ReadOnly' | 'Custom', required: The access level this API key grants.
      - `ActorType` 'User' | 'AiAgent', required
      - `ApiKey` SensitiveValue, required
        - `HasValue` boolean
        - `Hint` string
        - `NewValue` string
      - `Created` string, date-time, required
      - `Expires` string, date-time
      - `Id` string: Gets or sets a unique identifier for this resource.
      - `IsLastUsedTimestampKnown` boolean, required: Whether the API key's last-used time is being tracked. False for keys that predate last-used tracking, whose usage history is unknown. When true, a null LastUsedTimeStamp means the key has never been used.
      - `LastModifiedBy` string: Gets or sets the username of the user who last modified this resource.
      - `LastModifiedOn` string, date-time: Gets or sets the date/time that this resource was last modified.
      - `LastUsedTimeStamp` string, date-time: The date and time (UTC) the API key was last used to authenticate; null if it has never been used.
      - `Links` object: Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
      - `Purpose` string
      - `UserId` string, required
    - `ItemsPerPage` integer
    - `ItemType` string: The type of item in this list
    - `LastModifiedBy` string: Gets or sets the username of the user who last modified this resource.
    - `LastModifiedOn` string, date-time: Gets or sets the date/time that this resource was last modified.
    - `LastPageNumber` integer
    - `Links` object: Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
    - `NumberOfPages` integer
    - `TotalResults` integer

## Other responses

- `400`: Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404`: Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.dev/octopus/apis/octopus-server-api.md) - [All operations](https://skmtc.dev/octopus/apis/octopus-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octopus/apis/octopus-server-api/revisions/fe937c07da34?raw)