List this account's memberships
Every newsletter this account has a place on, and the role it holds there. It answers "which teams am I on"; GET /newsletters/{newsletter}/members answers "who is on this team" and needs settings: read instead.
Needs account: read, which either an API key or an OAuth token can carry. A credential without it is refused whatever newsletters it reaches. One with it reads the account it belongs to and no other: there is no parameter here in which to name a person.
A row can name a newsletter no other operation will let this credential address. Each row is the person's own membership and says nothing about that newsletter beyond an identifier, nor anything about anybody else on its team.
The owner of a newsletter appears here with the owner role, the same membership GET /newsletters/{newsletter}/members emits.
newsletter is a reference, and ?expand=newsletter replaces it with a NewsletterSummary: handle, name, description and artwork, all of which that newsletter's own page already shows anybody. Expanding widens nothing else, so a newsletter this credential holds no grant on stays unreadable through GET /newsletters/{newsletter}.
Request
- Base URL: https://api.usecommune.com
- URL: https://api.usecommune.com/memberships
- Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://usecommune.com/api/oauth/authorize, token URL https://usecommune.com/api/oauth/token, scopes: account:read)
Query parameters
The pagination.next_cursor value from the previous page. Omit it to read the first page. A cursor is opaque, is only valid for the same operation with the same filters, and is not a durable identifier.
How many items to return in this page. This is a page size, not an offset. Fewer items than requested may come back and that does not mean the collection is exhausted, only an absent next_cursor does.
Comma-separated list of relationship paths to inline in the response. Unexpanded relationships are returned as a reference object carrying only id and object. Each operation documents the paths it accepts, and an unknown path answers 400. Nested paths use a dot, for example article.newsletter.
Comma-separated allow-list of top level properties to return on each object, so a client can trim a response it does not need in full. id and object are always returned. An unknown property name answers 400. Properties omitted by an operation, such as content on any article list, cannot be brought back with fields.
Response
A page of memberships, oldest first.
Example response
{
"pagination": {
"next_cursor": "Y3Vyc29yOjE3NTY0MjM2MDAwMDA6MDE5MmM4"
},
"data": [
{
"newsletter": {
"object": "newsletter",
"id": "9a4c1c6e-0f2b-4f47-9d3f-6d1b1a2c3d4e"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.