> ## 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 dispatches > The unit's alerts, newest first, paginated. Filter by `item_id` and `status`. ## OpenAPI ````yaml /api-reference/openapi.json get /establishments/{establishment}/events 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}/events: get: tags: - Dispatches summary: List dispatches description: >- The unit's alerts, newest first, paginated. Filter by `item_id` and `status`. operationId: v1.establishments.events.index parameters: - name: establishment in: path required: true description: The establishment ID schema: type: integer - name: item_id in: query schema: type: integer - name: status in: query schema: $ref: '#/components/schemas/EventStatus' - 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 `Event` content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Event' 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: EventStatus: type: string description: |- | | |---| | `pending`
Queued to be sent now. | | `processing`
Being sent. | | `dispatched`
Sent; see `sent_count` and `failed_count`. | | `failed`
Not sent; see `failure_reason`. | | `cancelled`
Cancelled while scheduled. | | `scheduled`
Waiting for `scheduled_at`. | enum: - pending - processing - dispatched - failed - cancelled - scheduled title: EventStatus Event: type: object properties: id: type: integer item: type: object properties: id: type: integer public_code: type: string name: type: - string - 'null' required: - id - public_code - name title: type: - string - 'null' message: type: string status: $ref: '#/components/schemas/EventStatus' scheduled_at: type: - string - 'null' description: When the alert is or was due; `null` for an immediate send. dispatched_at: type: - string - 'null' recipients_count: type: integer description: Subscribers the alert was sent to. credits_cost: type: integer description: 'Credits debited: one per recipient.' sent_count: type: integer failed_count: type: integer failure_reason: anyOf: - $ref: '#/components/schemas/EventFailureReason' - type: 'null' estimated_credits_cost: type: - integer - 'null' description: >- Scheduled alerts only: the cost estimated when the alert was scheduled or last rescheduled. warning_sent_at: type: - string - 'null' cancelled_at: type: - string - 'null' cancelled_by: type: - object - 'null' description: >- The person who cancelled; `null` when an API key did or the alert was not cancelled. properties: id: type: integer name: type: string required: - id - name cancelled_by_api_client: type: - object - 'null' description: >- The API key that cancelled; `null` when a person did or the alert was not cancelled. properties: id: type: integer name: type: string required: - id - name created_by: type: - object - 'null' description: >- The person who created the alert; `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 alert; `null` when a person did. properties: id: type: integer name: type: string required: - id - name created_at: type: - string - 'null' notifications: type: object description: 'Only on `GET …/events/{event}`: recipients per delivery status.' additionalProperties: type: integer required: - id - item - title - message - status - scheduled_at - dispatched_at - recipients_count - credits_cost - sent_count - failed_count - failure_reason - estimated_credits_cost - warning_sent_at - cancelled_at - cancelled_by - cancelled_by_api_client - created_by - created_by_api_client - created_at title: Event 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 EventFailureReason: type: string description: >- | | |---| | `processing_error`
An error while sending; the credits were not debited. | | `insufficient_credits`
The balance did not cover the send when it was due. | | `missed_schedule`
The scheduled time passed while the system was unavailable. | | `item_not_dispatchable`
The item, unit or chain could no longer be alerted when the send was due. | enum: - processing_error - insufficient_credits - missed_schedule - item_not_dispatchable title: EventFailureReason 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.