---
title: "Get a ApiKeyResource by ID"
method: GET
path: "/users/{userId}/apikeys/{id}"
tags: ["ApiKeys"]
---

# Get a ApiKeyResource by ID

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

Gets a API key by ID.

## Path parameters

- `userId` string, required
- `id` string, required

## Response `200`

The requested Api Key

- ApiKeyResource
  - `AccessLevel` 'FullAccess' | 'ReadOnly' | 'Custom' — The access level this API key grants.
  - `ActorType` 'User' | 'AiAgent'
  - `ApiKey` SensitiveValue
    - `HasValue` boolean
    - `Hint` string
    - `NewValue` string
  - `Created` string, date-time
  - `Expires` string, date-time
  - `Id` string — Gets or sets a unique identifier for this resource.
  - `IsLastUsedTimestampKnown` boolean — 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

## 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.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/revisions/b296c3a60aa5/schema)