---
title: "List API tokens"
method: GET
path: "/admin/api_tokens"
tags: ["API tokens"]
---

# List API tokens

`GET /admin/api_tokens`

## Request

- Base URL: `https://api.pipelinecrm.com/api/v3`
- URL: `https://api.pipelinecrm.com/api/v3/admin/api_tokens`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `app-key`
  - API key in query parameter `api_key` and API key in query parameter `app_key`

Every API token in the account, newest first, including revoked and expired ones: they stay as the
record of a credential that once existed. The secret itself is never returned. `token_prefix` is the
visible start of the token, enough to match a row against a configuration file.

## Response `200`

Successful Response

- object
  - `entries` ApiTokenAll[], required
    - `id` integer: Unique identifier
    - `created_at` string: Timestamp when the record was created (time zone in user's time zone).
    - `name` string: The name the user gave the token when creating it
    - `token_prefix` string: The first characters of the token, so a row can be matched to a configuration. The rest is never stored.
    - `scopes` string[]: `read` alone is a read-only token; `read` and `write` together may modify data.
    - `expires_at` string, nullable: When the token stops working; null for a token that never expires
    - `last_used_at` string, nullable: When the token last authenticated a request, recorded at most once a minute; null if never used
    - `revoked_at` string, nullable: Set when the token was revoked; null while it is live
    - `user_id` integer: The user the token acts as
    - `user` object, nullable: The user the token acts as; null if that user no longer exists
      - `id` integer
      - `first_name` string
      - `last_name` string
      - `email` string
  - `pagination` Pagination, required: Paging details returned alongside `entries` on every paginated list.
    - `page` integer: The page returned. Request another with `?page=N`.
    - `per_page` integer: Page size. `?per_page=N`, capped at 200.
    - `total` integer: Total number of records matching the request across all pages.
    - `pages` integer: Number of pages at this `per_page`.
    - `total_in_account` integer, nullable: Total number of records of this type visible to you before filters were applied. Null when not computed for the endpoint.
    - `page_var` string: Name of the query parameter that selects the page. Always `page`.
    - `url` string, nullable: Path of the request, when the endpoint reports it.

## Other responses

- `403`: The credentials are valid but this user may not perform the action (permissions, a read-only token, or API access switched off).

---

[API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)