---
title: "List intents"
method: GET
path: "/intents/"
tags: ["Billing"]
---

# List intents

`GET /intents/`

Operational intents associated with subscriptions that need attention.
Read-only.

## Query parameters

- `page` integer
- `page_size` integer
- `subscription` string

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated intent list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` Intent[], required — The items in the current page.
    - `id` integer
    - `subscription` string — Subscription ID.
    - `description` string
    - `needs_attention_reason` 'biller_issue' | 'gateway_issue' | 'reference_expired' | 'without_usage_records' | 'processing_issue' | 'without_reference'
    - `created` string, date-time

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/revisions/70cbc827dc7b/schema)