find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/addevent:addevent-calendar-subscribers-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: v2.14.0
  title: Calendar and Event Calendar subscribers API
  contact:
    name: AddEvent Inc
    email: support@addevent.com
servers:
- url: https://api.addevent.com/calevent/v2
security:
- bearerAuth: []
tags:
- name: Calendar subscribers
paths:
  /subscribers:
    get:
      operationId: search-calendar-subscribers
      summary: Search calendar subscribers
      tags:
      - Calendar subscribers
      description: Search for calendar subscribers that have been previously created. Returns a search result object that contains a `subscribers` property that contains an array of up to `page_size` calendar subscribers. If no calendar subscribers match the query, the resulting array will be empty.
      parameters:
      - $ref: '#/components/parameters/calendar-ids'
      - $ref: '#/components/parameters/subscriber-status'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/page-size'
      - $ref: '#/components/parameters/subscriber-sort'
      - $ref: '#/components/parameters/sort-order'
      responses:
        '200':
          $ref: '#/components/responses/200-subscriber-search'
        '400':
          $ref: '#/components/responses/400-invalid-query-parameters'
  /subscribers/{subscriber_id}:
    get:
      operationId: retrieve-calendar-subscriber
      summary: Retrieve a calendar subscriber
      tags:
      - Calendar subscribers
      description: Retrieves a calendar subscriber object.
      parameters:
      - $ref: '#/components/parameters/subscriber-id'
      responses:
        '200':
          $ref: '#/components/responses/200-subscriber'
        '404':
          $ref: '#/components/responses/404-not-found'
    delete:
      operationId: delete-calendar-subscriber
      summary: Delete a calendar subscriber
      tags:
      - Calendar subscribers
      description: Permenantly deletes a calendar subscriber. It cannot be undone.
      parameters:
      - $ref: '#/components/parameters/subscriber-id'
      responses:
        '204':
          $ref: '#/components/responses/204-deleted'
        '404':
          $ref: '#/components/responses/404-not-found'
components:
  responses:
    204-deleted:
      description: Deleted successfully
    400-invalid-query-parameters:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            properties:
              error_id:
                type: string
                description: A UUID which can be used to troubleshoot the error.
              error_message:
                type: string
                description: Additional information about the error.
              property_validation_errors:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    reason:
                      type: string
                  description: An array of invalid parameter names, and the associated reason that the property is invalid.
          examples:
            Invalid query parameters:
              $ref: '#/components/examples/invalid-query-parameters'
    404-not-found:
      description: Not found
    200-subscriber:
      description: Ok
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/subscriber'
          examples:
            Subscriber:
              $ref: '#/components/examples/subscriber-all'
    200-subscriber-search:
      description: Ok
      content:
        application/json:
          schema:
            type: object
            properties:
              pagination:
                $ref: '#/components/schemas/pagination'
              links:
                $ref: '#/components/schemas/links'
              subscribers:
                type: array
                items:
                  $ref: '#/components/schemas/subscriber'
          examples:
            Search results:
              $ref: '#/components/examples/subscriber-search'
  parameters:
    subscriber-status:
      name: status
      in: query
      schema:
        type: array
        items:
          type: string
          enum:
          - active
          - inactive
          - blocked
        default: active
      description: 'Only return subscribers with a specific status. Allowed values are:


        * `active`: The calendar subscriber''s feed has synced in the last 30 days.

        * `inactive`: The calendar subscriber''s feed has not synced in the last 30 days.

        * `blocked`: The calendar subscriber has been blocked by the calendar owner. The calendar subscriber''s feed will not show any events.

        '
    page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
      description: Page number of the search results. The first page of results is `page=1`.
    page-size:
      name: page_size
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 20
        default: 10
      description: A limit on the number of objects to be returned. `page_size` must be between 1 and 20, and the default is 10.
    subscriber-sort:
      name: sort_by
      in: query
      schema:
        type: string
        enum:
        - created
        - synced
        - calendar_id
        default: created
      description: The calendar subscriber property to sort by. Allowed values are `created`, `synced`, or `calendar_id`. If `sort_order` is provided, then `sort_by` must also be provided.
    calendar-ids:
      name: calendar_ids
      in: query
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          pattern: ^\S+$
      description: Comma-separated list of calendar IDs. Limits search results to those specific calendars.
    subscriber-id:
      name: subscriber_id
      in: path
      required: true
      schema:
        type: string
        pattern: ^\S+$
      description: Unique identifier for the calendar subscriber.
    sort-order:
      name: sort_order
      in: query
      schema:
        type: string
        enum:
        - asc
        - desc
        default: desc
      description: The order of the returned search results, sorted by the property specified in `sort_by`. Allowed values are `asc` or `desc`. If `sort_order` is provided, then `sort_by` must also be provided.
  examples:
    invalid-query-parameters:
      value:
        error_message: Attribute Validation Error
        invalid_param_responses:
        - name: sort_by
          reason: Invalid sorting field provided
        error_id: 1-655f6e3c-2597d3171a91c593213d3e40
    subscriber-all:
      value:
        id: uf1699543535yj
        calendar_id: 1698814128493614
        subscriber_status: active
        calendar_type: Google
        sync_count: 18
        synced: '2023-11-27 15:22:20'
        subscriber_form_data:
          name: Firstname Lastname
          email: emailaddress@addevent.com
        subscriber_form_labels:
          name: Name
          email: Email
        geo_location:
          ip: ''
          city: San Francisco
          region: California
          country: US
          location: 37.781500, -122.402400
          postal: 94107
        created: '2023-11-09 15:25:52'
    subscriber-search:
      value:
        pagination:
          current_page: 1
          next_page: 1
          previous_page: 1
          total_items: 1
          total_pages: 1
          page_size: 10
        links:
          next_page_url: https://api.addevent.com/calevent/v2/subscribers&page=1
          previous_page_url: https://api.addevent.com/calevent/v2/subscribers&page=1
        subscribers:
        - $ref: '#/components/examples/subscriber-all/value'
  schemas:
    subscriber:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the calendar subscriber.
        calendar_id:
          type: string
          description: The ID of the calendar that this subscriber is associated with.
        subscriber_status:
          type: string
          description: 'Indicates whether the calendar subscriber''s feed has recently updated or if the subscriber is blocked. Subscriber status is one of the following values:

            * `active`: the calendar feed has synced within the last 30 days

            * `inactive`: the calendar feed has not synced within the last 30 days

            * `blocked`: the subscriber has been blocked by the calendar owner. The calendar feed appears as empty for the subscriber

            '
        calendar_type:
          type: string
          description: 'Calendar service that was used to subscribe to the calendar. Calendar type is one of the following values: `apple`, `appleical`, `google`, `office365`, `outlook`, `outlookcom`, `yahoo`, `other`.

            '
        sync_count:
          type: integer
          description: The number of times that the subscriber's calendar feed has synced.
        synced:
          type: string
          description: Time at which the subscriber last pulled an updated calendar feed. The subscriber's calendar should reflect the AddEvent calendar at this point in time.
        subscriber_form_data:
          type: object
          description: The values entered by the user in the subscriber form before subscribing to this calendar. If users can subscribe to the calendar anonymously, then this object will be empty.
        subscriber_form_labels:
          type: object
          description: The names of the input fields for the subscriber form. The names of these input fields can be matched to the values entered by the subscriber using the keys of both objects. If users can subscribe to the calendar anonymously, then this object will be empty.
        geo_location:
          $ref: '#/components/schemas/geolocation'
        created:
          type: string
          description: Time at which the subscriber was created.
    links:
      type: object
      properties:
        next_page_url:
          type: string
          description: Link to the next page of search results.
        previous_page_url:
          type: string
          description: Link to the previous page of search results.
      description: Links to additional search results.
    pagination:
      type: object
      properties:
        current_page:
          type: integer
          description: Page number of the current page of search results.
        next_page:
          type: integer
          description: Page number of the next page of search results.
        previous_page:
          type: integer
          description: Page number of the previous page of search results.
        total_items:
          type: integer
          description: The total number of objects in the search results.
        total_pages:
          type: integer
          description: The total number of pages of search results.
        page_size:
          type: integer
          description: The number of search results per page
      description: Meta data about the search results and paging.
    geolocation:
      type: object
      properties:
        ip:
          type: string
          format: ipv4
        city:
          type: string
        region:
          type: string
        country:
          type: string
        location:
          type: string
        postal:
          type: string
      description: The user's location where they subscribed to a calendar or RSVPd to an event. Note that for users that are located in regions covered by GDPR, this data is automatically annonymized. You can also choose to annonymize all geolcation data collection for your account from your settings page.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: APIkey
      description: Your API key can be found on your AddEvent account page - https://dashboard.addevent.com/account/settings
x-provenance:
  method: searched
  source: https://docs.addevent.com/reference
  harvested: '2026-10-27'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.addevent.com/reference/create-calendar.md
  - https://docs.addevent.com/reference/create-event.md
  - https://docs.addevent.com/reference/create-rsvp-attendee.md
  - https://docs.addevent.com/reference/delete-calendar-subscriber.md
  - https://docs.addevent.com/reference/delete-calendar.md
  - https://docs.addevent.com/reference/delete-event.md
  - https://docs.addevent.com/reference/delete-rsvp-attendee.md
  - https://docs.addevent.com/reference/list-calendar-templates.md
  - https://docs.addevent.com/reference/list-event-templates.md
  - https://docs.addevent.com/reference/list-rsvp-forms.md
  - https://docs.addevent.com/reference/list-timezones.md
  - https://docs.addevent.com/reference/retrieve-calendar-subscriber.md
  - https://docs.addevent.com/reference/retrieve-calendar.md
  - https://docs.addevent.com/reference/retrieve-event.md
  - https://docs.addevent.com/reference/retrieve-rsvp-attendee.md
  - https://docs.addevent.com/reference/search-calendar-subscribers.md
  - https://docs.addevent.com/reference/search-calendars.md
  - https://docs.addevent.com/reference/search-events.md
  - https://docs.addevent.com/reference/search-rsvp-attendees.md
  - https://docs.addevent.com/reference/update-calendar.md
  - https://docs.addevent.com/reference/update-event.md
  - https://docs.addevent.com/reference/update-rsvp-attendee.md
  merge:
    pages: 22
    deduped: 129
    conflicts_kept_first: 0