---
title: "List share code"
method: GET
path: "/client/v1/cd-keys/list-share-code"
---

# List share code

`GET /client/v1/cd-keys/list-share-code`

Returns a list of share codes

## Query parameters

- `status` integer
- `limit` integer
- `page` integer
- `sort_by` string
- `order_by` string
- `keyword` string
- `email` string
- `data_type` integer
- `is_enterprise` integer

## Response `200`

Successful response

- ResponseListShareCode — Returns the list of share codes for the user.
  - `success` boolean — Indicates whether the request was successful.
  - `message` string — Response message.
  - `result` object — Data.
    - `items` ShareCodeInfo[] — Array of share codes
      - `code` string — Share code value.
      - `data_type` integer — Code type: 1 = IP, 2 = traffic.
      - `expired_at` integer, nullable — Expiration timestamp. Null means the code does not expire.
      - `amount_traffic` integer — Traffic amount associated with the code (bytes).
      - `forward_to` string, nullable — Email address the code was forwarded to (if configured).
      - `used_by` string, nullable — Email address of the user who redeemed the code.
      - `number_of_ips` integer — Number of IPs associated with the code.
      - `status` integer — Share code status. 0 = Available 1 = Used 2 = Revoked
      - `used_at` integer, nullable — Timestamp when the code was used.
      - `created_at` integer — Timestamp when the code was created.
    - `total_items` integer — Total number of items.
    - `total_pages` integer — Total number of pages.

## Other responses

- `400` — Bad request
- `403` — Authentication error

---

[API](https://skmtc.net/9proxy/apis/cd-key.md) · [All operations](https://skmtc.net/9proxy/apis/cd-key/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/9proxy/cd-key/versions/c159f83789a8/schema)