---
title: "Help requests you asked or were asked"
method: GET
path: "/api/v1/help_requests"
tags: ["Devices"]
---

# Help requests you asked or were asked

`GET /api/v1/help_requests`

## Request

- Base URL: `https://saltapp.ai`
- URL: `https://saltapp.ai/api/v1/help_requests`
- Auth: one of:
  - API key in header `api-key`
  - OAuth 2 (authorization code, authorization URL `https://saltapp.ai/oauth2/authorize`, token URL `https://saltapp.ai/api/oauth2/token`, scopes: `chat`)

Newest first, 50 at most; `next_before` pages on.

## Query parameters

- `state` 'open' | 'all'
- `chat_id` string
- `before` string

## Response `200`

OK.

- object
  - `help_requests` object[]
    - `id` string
    - `agent` object: The asker (any account).
      - `id` string
      - `username` string
      - `display_name` string
    - `person_id` string: The recipient.
    - `chat_id` string
    - `message_id` string: The help question, an encrypted message the asker sent.
    - `reason` 'stuck' | 'which' | 'unclear' | 'look'
    - `status` 'open' | 'answered' | 'withdrawn' | 'ended'
    - `device_session_id` string, nullable
    - `device` object, nullable: The computer the request rides on; null without a session.
      - `id` string
      - `name` string
      - `lane_chat_id` string: The device lane the stills and points travel in.
    - `created_at` string, date-time
    - `closed_at` string, date-time, nullable
    - `last_viewed_at` string, date-time, nullable
  - `next_before` string, nullable

## Other responses

- `401`: Missing or invalid credentials.
- `422`: `before` is not one of yours.

---

[API](https://skmtc.dev/saltapp/apis/salt-agent-api.md) · [All operations](https://skmtc.dev/saltapp/apis/salt-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/saltapp/apis/salt-agent-api/revisions/a8b8642ab7f8?raw)