# us.off-the-clock.push.getPushSettings

> Published by [off-the-clock.us](https://lexicon.garden/identity/did:plc:tevv7zpavtjtsvqrrwwipobt)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.push.getPushSettings)
- [Documentation](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.push.getPushSettings/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:tevv7zpavtjtsvqrrwwipobt/us.off-the-clock.push.getPushSettings/examples)

## Definitions

### `us.off-the-clock.push.getPushSettings#device`

**Type**: `object`

One of the viewer's subscriptions. The endpoint itself is never answered.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `createdAt` | `string` (datetime) | Yes |  |
| `host` | `string` | Yes | The push service's host. |
| `id` | `string` | Yes | An opaque name for the subscription, for unregisterPushSubscription. |
| `label` | `string` | No | What the browser called itself, such as iPhone or Mac · Firefox. |
| `lastSuccessAt` | `string` (datetime) | No |  |

### `us.off-the-clock.push.getPushSettings#kindSetting`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `enabled` | `boolean` | Yes |  |
| `kind` | `string` | Yes |  |

### `us.off-the-clock.push.getPushSettings`

**Type**: `query`

Whether this AppView sends Web Push, its VAPID public key, and the viewer's devices and push preferences (D63).

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `devices` | `array` | Yes |  |
| `kinds` | `array` | Yes |  |
| `mutedSpaces` | `array` | Yes |  |
| `publicKey` | `string` | No | The VAPID public key as base64url, the applicationServerKey browsers subscribe with; absent with push off. |
| `pushEnabled` | `boolean` | Yes |  |

#### Errors

- **NotSpaceMember**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "device": {
      "description": "One of the viewer's subscriptions. The endpoint itself is never answered.",
      "properties": {
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "host": {
          "description": "The push service's host.",
          "type": "string"
        },
        "id": {
          "description": "An opaque name for the subscription, for unregisterPushSubscription.",
          "type": "string"
        },
        "label": {
          "description": "What the browser called itself, such as iPhone or Mac · Firefox.",
          "maxLength": 64,
          "type": "string"
        },
        "lastSuccessAt": {
          "format": "datetime",
          "type": "string"
        }
      },
      "required": [
        "id",
        "host",
        "createdAt"
      ],
      "type": "object"
    },
    "kindSetting": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "kind": {
          "knownValues": [
            "reply",
            "mention",
            "quote",
            "rsvp",
            "event-status",
            "like",
            "repost",
            "vote"
          ],
          "type": "string"
        }
      },
      "required": [
        "kind",
        "enabled"
      ],
      "type": "object"
    },
    "main": {
      "description": "Whether this AppView sends Web Push, its VAPID public key, and the viewer's devices and push preferences (D63).",
      "errors": [
        {
          "name": "NotSpaceMember"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "devices": {
              "items": {
                "ref": "#device",
                "type": "ref"
              },
              "type": "array"
            },
            "kinds": {
              "items": {
                "ref": "#kindSetting",
                "type": "ref"
              },
              "type": "array"
            },
            "mutedSpaces": {
              "items": {
                "description": "A pair's TID.",
                "type": "string"
              },
              "type": "array"
            },
            "publicKey": {
              "description": "The VAPID public key as base64url, the applicationServerKey browsers subscribe with; absent with push off.",
              "type": "string"
            },
            "pushEnabled": {
              "type": "boolean"
            }
          },
          "required": [
            "pushEnabled",
            "devices",
            "kinds",
            "mutedSpaces"
          ],
          "type": "object"
        }
      },
      "type": "query"
    }
  },
  "id": "us.off-the-clock.push.getPushSettings",
  "lexicon": 1
}
```