> ## Documentation Index > Fetch the complete documentation index at: https://docs.needalert.app/llms.txt > Use this file to discover all available pages before exploring further. # List items > The unit's items with their `subscribers_count`, paginated. Filter by `status`, `queue_type`, `search` (name) or `external_reference` (exact, case-sensitive); sort by `name`, `created_at` or `subscribers_count`. ## OpenAPI ````yaml /api-reference/openapi.json get /establishments/{establishment}/items openapi: 3.1.0 info: title: Need Alert API version: '1' description: >- The Need Alert API lets your own system — an ERP, an online store, a clinic's scheduling software — do what the panel does, without anyone at the screen: keep items in sync, read who is waiting, estimate the cost of an alert, send or schedule it, and follow your credit balance. Authenticate every request with an API key created by the chain owner in the panel (**Integrações**), sent as `Authorization: Bearer `. Always send `Accept: application/json`. Send `Idempotency-Key` on the two creating endpoints so a retry never creates an item or alerts the subscribers twice. Guides, in Portuguese and English: https://need-alert.mintlify.app/api/overview servers: - url: https://needalert.app/api/v1 description: Production security: - apiKey: [] tags: - name: Establishments - name: Items - name: Dispatches - name: Credits paths: /establishments/{establishment}/items: get: tags: - Items summary: List items description: >- The unit's items with their `subscribers_count`, paginated. Filter by `status`, `queue_type`, `search` (name) or `external_reference` (exact, case-sensitive); sort by `name`, `created_at` or `subscribers_count`. operationId: v1.establishments.items.index parameters: - name: establishment in: path required: true description: The establishment ID schema: type: integer - name: status in: query schema: $ref: '#/components/schemas/ItemStatus' - name: queue_type in: query schema: $ref: '#/components/schemas/QueueType' - name: search in: query schema: type: - string - 'null' maxLength: 100 - name: external_reference in: query schema: type: - string - 'null' maxLength: 100 - name: sort in: query schema: type: string enum: - name - created_at - subscribers_count - name: direction in: query schema: type: string enum: - asc - desc - name: per_page in: query schema: type: integer minimum: 1 maximum: 100 - name: page in: query description: Page number. schema: type: integer default: 1 - name: Accept-Language in: header description: >- Language of `message` and of translated content such as item names (`pt-BR` or `en`). Without it, the chain's default language. schema: type: string enum: - pt-BR - en example: pt-BR - name: X-Request-Id in: header description: >- Your own correlation id (1–64 characters of `A-Za-z0-9._-`), echoed back; generated when absent. Quote it to support. schema: type: string pattern: ^[A-Za-z0-9._-]{1,64}$ minLength: 1 maxLength: 64 responses: '200': description: Paginated set of `Item` content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Item' links: type: object properties: first: type: - string - 'null' last: type: - string - 'null' prev: type: - string - 'null' next: type: - string - 'null' required: - first - last - prev - next meta: type: object properties: current_page: type: integer minimum: 1 from: type: - integer - 'null' minimum: 1 last_page: type: integer minimum: 1 links: type: array description: Generated paginator links. items: type: object properties: url: type: - string - 'null' label: type: string active: type: boolean required: - url - label - active path: type: - string - 'null' description: Base path for paginator generated URLs. per_page: type: integer description: Number of items shown per page. minimum: 0 to: type: - integer - 'null' description: Number of the last item in the slice. minimum: 1 total: type: integer description: Total number of items being paginated. minimum: 0 required: - current_page - from - last_page - links - path - per_page - to - total required: - data - links - meta headers: Content-Language: description: The language of the body, BCP 47 (`pt-BR`, `en`). schema: type: string X-Request-Id: description: The request id, yours or the one generated here. schema: type: string '401': description: '- `unauthenticated`: Missing, malformed, expired or revoked API key.' content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorEnvelope' - type: object properties: code: type: string enum: - unauthenticated headers: Content-Language: description: The language of the body, BCP 47 (`pt-BR`, `en`). schema: type: string X-Request-Id: description: The request id, yours or the one generated here. schema: type: string '403': description: >- - `establishment_unavailable`: The unit is inactive or suspended. - `forbidden`: The key lacks the permission this operation needs in this unit (`view`, `create_items`, `edit_items`, `dispatch_events` or `manage_billing`). - `tenant_suspended`: The chain that owns the key is suspended. content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorEnvelope' - type: object properties: code: type: string enum: - establishment_unavailable - forbidden - tenant_suspended headers: Content-Language: description: The language of the body, BCP 47 (`pt-BR`, `en`). schema: type: string X-Request-Id: description: The request id, yours or the one generated here. schema: type: string '404': description: >- - `not_found`: No such resource, or it is outside the key's scope. The API never reveals whether a resource you cannot see exists. content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorEnvelope' - type: object properties: code: type: string enum: - not_found headers: Content-Language: description: The language of the body, BCP 47 (`pt-BR`, `en`). schema: type: string X-Request-Id: description: The request id, yours or the one generated here. schema: type: string '422': description: >- - `validation_failed`: Invalid input. `errors`: each invalid field mapped to its messages. content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorEnvelope' - type: object properties: code: type: string enum: - validation_failed errors: type: object description: each invalid field mapped to its messages. additionalProperties: type: array items: type: string headers: Content-Language: description: The language of the body, BCP 47 (`pt-BR`, `en`). schema: type: string X-Request-Id: description: The request id, yours or the one generated here. schema: type: string '429': description: >- - `too_many_requests`: Over the key's budget of 300 requests per minute. Wait the seconds in `Retry-After`. content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorEnvelope' - type: object properties: code: type: string enum: - too_many_requests headers: Retry-After: description: Seconds to wait before the next request. schema: type: integer X-RateLimit-Limit: description: Requests allowed per minute. schema: type: integer X-RateLimit-Remaining: description: Requests left in the current minute. schema: type: integer Content-Language: description: The language of the body, BCP 47 (`pt-BR`, `en`). schema: type: string X-Request-Id: description: The request id, yours or the one generated here. schema: type: string components: schemas: ItemStatus: type: string description: >- | | |---| | `active`
Accepts subscriptions and alerts. | | `paused`
Visible, but takes no new subscriptions or alerts until reactivated. | | `archived`
Terminal: kept for history only. | enum: - active - paused - archived title: ItemStatus QueueType: type: string description: >- | | |---| | `single`
One-time alert: a subscription ends after its first alert. | | `recurring`
Recurring alert: the subscription stays and is alerted every time. | enum: - single - recurring title: QueueType Item: type: object properties: id: type: integer establishment_id: type: integer product_catalog_id: type: - integer - 'null' description: The chain-catalog product this item was created from, if any. public_code: type: string description: Short, immutable code printed on the QR sticker. external_reference: type: - string - 'null' description: >- Your own code for the item (SKU, procedure code). Unique per unit among non-archived items; matched exactly, case-sensitive. public_url: type: string description: The public page people subscribe from. qr_code_url: type: string description: The QR code image endpoint of this item. name: type: - string - 'null' description: >- In `content_locale`: the requested language, or the fallback when it has no translation. description: type: - string - 'null' description: In `content_locale`, like `name`. content_locale: $ref: '#/components/schemas/Locale' description: The language `name` and `description` above were served in. translations: type: object description: Every translation, keyed by locale (`pt_BR`, `en`). additionalProperties: type: object properties: name: type: string description: type: - string - 'null' required: - name - description image_url: type: - string - 'null' description: The item's picture, `null` when it has none. queue_type: $ref: '#/components/schemas/QueueType' description: >- How subscriptions behave after an alert: `single` ends them, `recurring` keeps them. | | |---| | `single`
One-time alert: a subscription ends after its first alert. | | `recurring`
Recurring alert: the subscription stays and is alerted every time. | status: $ref: '#/components/schemas/ItemStatus' attributes: type: object description: Free-form key/value data of the item. properties: id: type: integer establishment_id: type: integer product_catalog_id: type: - integer - 'null' public_code: type: string external_reference: type: - string - 'null' image_path: type: - string - 'null' queue_type: type: string status: type: string attributes: type: - string - 'null' subscribers_count: type: integer requires_sensitive_consent: type: string created_by_user_id: type: - integer - 'null' created_by_api_client_id: type: - integer - 'null' created_at: type: - string - 'null' updated_at: type: - string - 'null' deleted_at: type: - string - 'null' subscribers_count: type: integer description: People currently subscribed and eligible for the next alert. requires_sensitive_consent: type: boolean description: >- Whether subscribing asks for the sensitive-data consent (health items). created_by: type: - object - 'null' description: >- The person who created the item; `null` when an API key or the system did. properties: id: type: integer name: type: string required: - id - name created_by_api_client: type: - object - 'null' description: The API key that created the item; `null` when a person did. properties: id: type: integer name: type: string required: - id - name created_at: type: - string - 'null' updated_at: type: - string - 'null' required: - id - establishment_id - product_catalog_id - public_code - external_reference - public_url - qr_code_url - name - description - content_locale - translations - image_url - queue_type - status - attributes - subscribers_count - requires_sensitive_consent - created_by - created_by_api_client - created_at - updated_at title: Item ErrorEnvelope: type: object description: The shape of every error response of the API. properties: message: type: string description: >- Translated (see `Content-Language`), for display only. Never program against it. code: type: string description: Stable `snake_case` identifier of the error. Program against it. errors: type: object description: >- Only on some errors: the invalid fields of a `validation_failed`, or extra data of a business-rule refusal. required: - message - code title: ErrorEnvelope Locale: type: string enum: - pt_BR - en title: Locale securitySchemes: apiKey: type: http description: >- An API key created by the chain owner in the panel (**Integrações** → **Nova chave**), sent as `Authorization: Bearer `. The key (`|na_…`) is shown once, at creation; rotate or revoke it on the same screen. It is a server secret: never ship it in browser or mobile code. scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.