Markit AI LogoMarkit | Docs
Markit API

Events

The events resource allows you to handle Retrieve related functionality to view your events on Markit. The following actions can be performed on this resource...

  • Retrieve All Events
  • Retrieve a Single Event

Retrieve All Events

Retrieves all Markit events on your account.

    GET https://api.markitai.com/v1/events

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will return contacts with a createdAt of "asc" (ascending).

    GET https://api.markitai.com/v1/events?createdAt=asc

Available query parameters:

  • limit: 20 (default)
  • offset: 0 (default)
  • createdAt: ‘desc’ | ‘asc’ (default = ‘desc’)
  • upcoming: boolean (true to show only upcoming events by start time)

Example Response:

{
  "data": [
    {
      "id": "123456",
      "geohash": "xxxxxx",
      "googlePlaceId": "XXXXXX",
      "googleDescription": "XxXxXx",
      "body": { "content": [], "type": "doc" },
      "createdBy": "abc123",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "lat": 42.360091,
      "lng": -71.09416,
      "photoURL": "https://firebasestorage.googleapis.com/...",
      "isDraft": false,
      "theme": 0,
      "title": "Event Title",
      "start": "2024-01-01T00:00:00.000Z",
      "end": "2024-01-02T00:00:00.000Z",
      "eventType": "Markit",
      "externalEventId": "",
      "externalLink": "",
      "link": "",
      "visibility": 1,
      "visibilityCommunity": "",
      "stripePaymentCollector": "",
      "customTickets": [
        {
          "price": 0,
          "id": "123123",
          "minQuantity": 1,
          "maxQuantity": 8,
          "quantityAvailable": 0,
          "hideTicket": false,
          "formQuestions": ["abc", "def", "ghi"],
          "type": "free",
          "label": "RSVP",
          "externalTicketId": ""
        },
        ...
      ],
      "promoCodes": [],
      "canRefund": false,
      "canTransfer": false,
      "crowdfundingGoal": 0,
      "crowdfundingHide": false,
      "contributions": [],
      "hideResponses": true,
      "formattedAddress": "US...",
      "privateLocation": false,
      "locationDetails": "",
      "isFeatured": false,
      "locationBasedRSVP": false,
      "isVirtual": false,
      "isManualSoldOut": false
    },
    ...
  ],
  "pagingData": {
    "prevPage": null,
    "currentPage": null,
    "nextPage": null,
    "currentPageString": null,
    "hasMore": false
  }
}

Retrieve a Single Event

Retrieves a single event with the event ID equal to {id}.

    GET https://api.markitai.com/v1/events/{id}

Example Response:

{
  "event": {
    "id": "123456",
    "geohash": "xxxxxx",
    "googlePlaceId": "XXXXXX",
    "googleDescription": "XxXxXx",
    "body": { "content": [], "type": "doc" },
    "createdBy": "abc123",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "lat": 42.360091,
    "lng": -71.09416,
    "photoURL": "https://firebasestorage.googleapis.com/...",
    "isDraft": false,
    "theme": 0,
    "title": "Event Title",
    "start": "2024-01-01T00:00:00.000Z",
    "end": "2024-01-02T00:00:00.000Z",
    "eventType": "Markit",
    "externalEventId": "",
    "externalLink": "",
    "link": "",
    "visibility": 1,
    "visibilityCommunity": "",
    "stripePaymentCollector": "",
    "customTickets": [
      {
        "price": 0,
        "id": "123123",
        "minQuantity": 1,
        "maxQuantity": 8,
        "quantityAvailable": 0,
        "hideTicket": false,
        "formQuestions": ["abc", "def", "ghi"],
        "type": "free",
        "label": "RSVP",
        "externalTicketId": ""
      },
      ...
    ],
    "promoCodes": [],
    "canRefund": false,
    "canTransfer": false,
    "crowdfundingGoal": 0,
    "crowdfundingHide": false,
    "contributions": [],
    "hideResponses": true,
    "formattedAddress": "US...",
    "privateLocation": false,
    "locationDetails": "",
    "isFeatured": false,
    "locationBasedRSVP": false,
    "isVirtual": false,
    "isManualSoldOut": false
  }
}

On this page