# online.fg-goose.gsb.getSession

> Published by [ember.delve.town](https://lexicon.garden/identity/did:plc:6amo7col5h4ciq2gpm5eur7b)

✓ This is the authoritative definition for this NSID.

## Description

The issuer's scratch world status and home-clock expiry. Method-bound service auth; unknown or expired scratch: RecordNotFound.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:6amo7col5h4ciq2gpm5eur7b/online.fg-goose.gsb.getSession)
- [Documentation](https://lexicon.garden/lexicon/did:plc:6amo7col5h4ciq2gpm5eur7b/online.fg-goose.gsb.getSession/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:6amo7col5h4ciq2gpm5eur7b/online.fg-goose.gsb.getSession/examples)

## Definitions

### `online.fg-goose.gsb.getSession`

**Type**: `query`

The issuer's scratch world status and home-clock expiry. Method-bound service auth; unknown or expired scratch: RecordNotFound.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `session` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `expires` | `integer` | Yes | Home-world clock minute at which it is discarded if idle. |
| `session` | `string` | Yes | `scratch/<name>`. |
| `status` | `string` | Yes | world-status verdict. |

#### Errors

- **AuthRequired**
- **InvalidToken**
- **InvalidRequest**
- **RateLimitExceeded**
- **RecordNotFound**
- **HostUnavailable**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The issuer's scratch world status and home-clock expiry. Method-bound service auth; unknown or expired scratch: RecordNotFound.",
      "errors": [
        {
          "name": "AuthRequired"
        },
        {
          "name": "InvalidToken"
        },
        {
          "name": "InvalidRequest"
        },
        {
          "name": "RateLimitExceeded"
        },
        {
          "name": "RecordNotFound"
        },
        {
          "name": "HostUnavailable"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "expires": {
              "description": "Home-world clock minute at which it is discarded if idle.",
              "minimum": 0,
              "type": "integer"
            },
            "session": {
              "description": "`scratch/<name>`.",
              "type": "string"
            },
            "status": {
              "const": "world",
              "description": "world-status verdict.",
              "type": "string"
            }
          },
          "required": [
            "session",
            "status",
            "expires"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "session": {
            "type": "string"
          }
        },
        "required": [
          "session"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "description": "The issuer's scratch world status and home-clock expiry. Method-bound service auth; unknown or expired scratch: RecordNotFound.",
  "id": "online.fg-goose.gsb.getSession",
  "lexicon": 1
}
```