Lists a note's active members, owner first.

GET

/v1/notes/{id}/members

• Reverse-proxied API origin

Any member may view the roster.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Note id

Responses

200

Members

Media typeapplication/json

A note’s members, owner first.

object

members

required

Array<object>

One member of a shared note.

object

handle

The addressing key, absent for an account that has no handle.

string

name

What to show for this member. A handle-less member is named by address to the note’s owner, who added them by it, and to nobody else.

string

role

required

A member’s access level on a note, as stored and as served. Revoked marks a former member’s tombstone. It never appears on a live membership.

string

Allowed values: owner editor viewer revoked

userId

required

Identity, and what the roster is keyed on: every member has one.

string format: uuid

nextPageToken

required

Always empty: this collection answers in one page. Present so pagination can be added later without breaking a client that honours it.

string

Example

{
  "members": [
    {
      "role": "owner"
    }
  ]
}

Headers

ETag

string

Strong validator of this representation

400

The request is malformed

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

401

No valid session token

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

Headers

WWW-Authenticate

string

The Bearer challenge (RFC 6750).

404

Note not found

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Too many requests

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

Headers

Retry-After

string

Seconds to wait. Sent when the limit knows when it lifts.

500

The service failed

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

503

The service is at capacity

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}