sessions_list

GET

/sessions

const url = 'https://api.canopyhq.dev/sessions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.canopyhq.dev/sessions \
  --header 'Authorization: Bearer <token>'

Authorizations

install_key

Parameters

Query Parameters

principal

string

Only the sessions filed under this principal; absent, every session of the install.

after

An opaque continuation from an owner’s directory.

string

The opaque continuation returned by the prior page.

limit

integer

Maximum rows to return; defaults to 50.

Responses

200

One page of the install’s sessions, or one principal’s.

application/json

One bounded page from an install’s session directory.

object

items

required

Array<object>

A session’s directory row. subject is the filed subject digest.

object

archived

required

boolean

required

A stream id: 72 hex chars, the shard then the owner digest.

string

opened

required

string

subject

string | null

next

One of:

null
string

null

Example

{
  "items": [
    {
      "id": "000000000000000000000000000000000000000000000000000000000000000000000000"
    }
  ]
}

400

A query string that did not parse.

401

No install key, or one no install answers.