Workspace

Set up

TypeScript

npm install @reminix/sdk

import { createClient } from "@reminix/sdk";

const reminix = createClient(); // reads REMINIX_API_KEY

Python

pip install reminix

from reminix import Reminix

reminix = Reminix()  # reads REMINIX_API_KEY

CLI

npm install -g @reminix/cli
reminix login

curl

export REMINIX_API_KEY="<your API key>"

Get the current workspace

GET /v1/workspace

Returns the Workspace the credential acts in — the API key’s own, or the one named by X-Workspace for a personal access token.

TypeScript

await reminix.workspace.get();

Python

reminix.workspace.get()

CLI

reminix workspace get

curl

curl -X GET "https://api.reminix.com/v1/workspace" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

More about this endpoint

Useful as an integration smoke test (“who am I?”).

List workspace members

GET /v1/workspace/members

The workspace’s members with their roles, newest first.

TypeScript

await reminix.workspace.members.list();

Python

reminix.workspace.members.list()

CLI

reminix workspace members list

curl

curl -X GET "https://api.reminix.com/v1/workspace/members" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Field	Description
limitnumber, query	Items per page, 1–100 (default 25).
cursorstring, query	Opaque token from a previous page's nextCursor.

More about this endpoint

Paginate with the opaque nextCursor; limit is clamped to 1–100 (default 25). Members are invited, removed and given roles in the app.

List pending invitations

GET /v1/workspace/invitations

Invitations sent and not yet accepted, declined or expired, newest first.

TypeScript

await reminix.workspace.invitations.list();

Python

reminix.workspace.invitations.list()

CLI

reminix workspace invitations list

curl

curl -X GET "https://api.reminix.com/v1/workspace/invitations" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Field	Description
limitnumber, query	Items per page, 1–100 (default 25).
cursorstring, query	Opaque token from a previous page's nextCursor.

More about this endpoint

Owners and admins only for a personal credential, as in the app. Paginate with the opaque nextCursor.

Get your plan’s usage this period

GET /v1/workspace/usage

How much of each meter the workspace used this period, with the plan’s limit for it (null = unlimited).

TypeScript

await reminix.workspace.usage();

Python

reminix.workspace.usage()

CLI

reminix workspace usage

curl

curl -X GET "https://api.reminix.com/v1/workspace/usage" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

More about this endpoint

A period is a month from the workspace’s billing date: its subscription’s (an annual plan refills monthly from its start), else the day the workspace was created.

List teams

GET /v1/workspace/teams

The workspace’s teams with their members’ user ids, newest first.

TypeScript

await reminix.workspace.teams.list();

Python

reminix.workspace.teams.list()

CLI

reminix workspace teams list

curl

curl -X GET "https://api.reminix.com/v1/workspace/teams" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Field	Description
limitnumber, query	Items per page, 1–100 (default 25).
cursorstring, query	Opaque token from a previous page's nextCursor.

More about this endpoint

Paginate with the opaque nextCursor; limit is clamped to 1–100 (default 25). Teams are created and staffed in the app.