ARKH Developer Portal

/users

Query users of your app. See who has your app installed and their current state.

User States

active - User has the app open and in foreground
passive - User has the app but it's backgrounded
inactive - User has disabled the app

Quick Links

GET

/v1/apps/:app_id/users

List all users of an app

GET

/v1/apps/:app_id/users/:user_app_id

Get a specific user's status

GET

/v1/apps/:app_id/users

List all users who have this app installed with their current state.

Parameters

Name

Type

Req

Description

state

string

Filter by state: "active", "passive", "inactive", or "all" (default)

Request

curl -X GET "https://developer.arkh.com/api/apps/app_01234567/users" \
  -H "Authorization: Bearer arkh_your_api_key_here"

Response

{
  "users": [
    {
      "user_app_id": "550e8400-e29b-41d4-a716-446655440000",
      "state": "active",
      "installed_at": "2024-01-15T14:30:00Z"
    },
    {
      "user_app_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "state": "inactive",
      "installed_at": "2024-01-10T09:15:00Z"
    }
  ]
}

GET

/v1/apps/:app_id/users/:user_app_id

Get detailed status for a specific user. Use @me to check your own status.

Request

curl -X GET "https://developer.arkh.com/api/apps/app_01234567/users/@me" \
  -H "Authorization: Bearer arkh_your_api_key_here"

Response

{
  "user_app_id": "550e8400-e29b-41d4-a716-446655440000",
  "app_id": "app_01234567",
  "state": "active",
  "permissions": {
    "vibes": true,
    "gestures": true
  },
  "installed_at": "2024-01-15T14:30:00Z"
}

Error Responses

400

Invalid user_app_id or @me cannot be resolved

404

App not found, not owned by you, or user not found