← Files GoodMemARCHIVED FILE

skills/goodmem-sdk/references/typescript/instance/get.md

693 Bytes · Oct 4, 2026 · 12:23 UTC

↓ Download file

<!-- sdk-ref package=@pairsystems/goodmem registry=npm version=0.1.6 -->

# instance.get

Returns singleton instance identity, ownership, and audit metadata after requiring effective READ_INSTANCE authority. The built-in ADMIN role supplies this authority; instance ownership alone does not. A scoped API key must also retain READ_INSTANCE in its immutable ceiling. This operation does not expose credentials or mutate instance state.

```ts
get(requestOptions?: RequestOptions): Promise<GoodMemInstanceResponseShape>
```

[instance](../instance.md) · [TypeScript](../../typescript.md)

Related types — open only those used by your request:

- [RequestOptions](../models/RequestOptions.md)

SHA-256: 4cba1e56a200523e3b55710bcc6c8ff50441f6cadd784c26ef694b5a576d72dc