Sign in
Me

List the agendas you are a member of

Changed on

Returns a cursor-paginated list of the agendas the authenticated user is a member of, with their role on each. Private agendas the user belongs to ARE included (each item carries a private flag), and so are agendas not indexed in public search.

get/me/agendas

Request

  • Base URL: https://api.openagenda.com/v3
  • URL: https://api.openagenda.com/v3/me/agendas
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://openagenda.com/api/auth/oauth2/authorize, token URL https://openagenda.com/api/auth/oauth2/token, scopes: me:read)

Query parameters

afterstring

Opaque pagination cursor returned in pagination.after of the previous page. Omit it to fetch the first page.

limitinteger

Maximum number of items to return per page. An out-of-range or non-integer value is rejected with 400, never clamped; use the after cursor to page further.

detailedboolean

When true, each item in data is returned in its detailed representation, including the detailed-only fields. When false (the default), items are the lighter summary representation.

fieldsstring[]

Comma-separated list of fields to keep on each data item, to shrink the payload of large pages. When set, it selects the response shape directly over the resource's full field set, so detailed does not apply (it only governs the default shape when fields is omitted) and fields wins if both are given. uid is always returned. Each resource takes the names its own data item declares, and a dotted path descends one segment per level: on an event, location.name or timings.begin. An unknown top-level field is rejected with 400, and so is an unknown sub-field under a closed object (location.zzz); under an open container - an additionalFields custom-field bag, on the resources that carry one, or a localized text map - any sub-key is accepted and yields nothing when absent (additionalFields.myField). Response schemas stay complete, so a generated client still types the omitted fields as present — read them as optional on this path.

[
  "uid",
  "slug"
]
slugstring[]

Restrict to the agendas carrying these slugs. A slug matching none of your memberships yields an empty page. Repeat the parameter for multiple values.

roleMemberRole[]

Restrict to the memberships holding one of these roles. Repeat the parameter for multiple values.

Response

A page of the caller's agenda memberships.

Example response

{
  "data": [
    {
      "uid": 12345,
      "slug": "festival-des-lumieres",
      "title": "Festival des Lumières",
      "description": "La programmation du festival.",
      "image": {
        "width": 1400,
        "height": 900,
        "src": "https://img.openagenda.com/u/1080x0/main/12345.full.image.jpg",
        "srcTemplate": "https://img.openagenda.com/u/{geo}/main/12345.full.image.jpg",
        "srcset": [
          {
            "width": 640,
            "url": "https://img.openagenda.com/u/640x0/main/12345.full.image.jpg"
          },
          {
            "width": 1080,
            "url": "https://img.openagenda.com/u/1080x0/main/12345.full.image.jpg"
          }
        ]
      },
      "official": false,
      "private": false,
      "role": "administrator"
    }
  ],
  "pagination": {
    "after": "eyJ1aWQiOjIzNDU2fQ",
    "limit": 20,
    "total": 342,
    "totalRelation": "exact"
  }
}

Changes

  • 948e1d1c57f3Revision changes
    • info

      added the new optional query request parameter role

    • info

      added the new optional query request parameter slug

    • info

      added the optional property /////// to the response with the status

  • 550dac9bcc88Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the query request parameter role

    • warning

      deleted the query request parameter slug

    • info

      removed from the response body oneOf list for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed the bad_request enum value from the / response property for the response status

    • info

      removed the bad_request enum value from the / response property for the response status

    • info

      removed the forbidden enum value from the / response property for the response status

    • info

      removed the forbidden enum value from the / response property for the response status

    • info

      removed the insufficient_scope enum value from the / response property for the response status

    • info

      removed the insufficient_scope enum value from the / response property for the response status

    • info

      removed the not_found enum value from the / response property for the response status

    • info

      removed the not_found enum value from the / response property for the response status

    • info

      removed the read_only_credential enum value from the / response property for the response status

    • info

      removed the read_only_credential enum value from the / response property for the response status

    • info

      removed the service_unavailable enum value from the / response property for the response status

    • info

      removed the service_unavailable enum value from the / response property for the response status

    • info

      removed the unauthorized enum value from the / response property for the response status

    • info

      removed the unauthorized enum value from the / response property for the response status

    • info

      added the required property to the response with the status