Events API v2 - Events

Skill Level: 
Advanced

This API endpoint allows reading a list of events from a calendar.

Available Endpoints

Read

GET http://events.unl.edu/api/v2/calendar/{calendar_id}/events/

This endpoint is for getting a list of posted events from a calendar. This will include past events that may have already occurred.

HTTP Method

GET

Authentication Requirements

None

Request Data

  • calendar_id string | number Required Path
    ID or shortname of the calendar the events will be from. This will go into the path of the request.
  • limit number query
    This is the number of events you want to receive. Max limit is 500 and default is 100.
  • offset number query
    This offset is to be used to get the next batch of events beyond the initial limit.

Response Data

  • Status number
    Status code for the request.
  • Message string
    Status message for the request.
  • Data Array of Event Objects | null
    The list of the calendar's events data or null on error.
    • id string
      The ID of the event.
    • title string | null
      The title of the event or null if none is set.
    • subtitle string | null
      The subtitle of the event or null if none is set.
    • description string | null
      The description of the event or null if none is set.
    • webpage string | null
      The webpage of the event or null if none is set. This will always be a URL.
    • private-public 'private' | 'public' | null
      The status of the event's publicity or null if none is set. This will always be public or private.
    • listing-contact-name string | null
      The event's listed contact's name or null if none is set.
    • listing-contact-phone string | null
      The event's listed contact's phone number or null if none is set.
    • listing-contact-email string | null
      The event's listed contact's email or null if none is set.
    • listing-contact-url string | null
      The event's listed contact's url or null if none is set. This will always be a URL.
    • listing-contact-type 'person' | 'organization' | null
      The type of the event's listed contact or null if none is set. This will always be a person or organization.
    • canceled bool
      If the event has been canceled.
    • calendar-event-status string
      The event status of that event on that calendar.
    • original-calendar Calendar Object
      The original calendar the event was posted on.
      • id string
        The ID of the calendar.
      • name string
        The name of the calendar.
      • short-name string
        The short name of the calendar. This can be used in the URL of other events API v2 requests.
      • default-timezone string
        The default timezone of the calendar. This can be overridden by event's data times.
      • webpage string | null
        The webpage of the calendar or null if none is set.
      • email-list string | null
        The list of emails for the calendar or null if none is set. Emails will be separated by commas.
      • event-release-preference string
        The release process for events after they are created on the calendar.
      • recommendations-within-account bool
        Whether users on the same account can recommend events to this calendar.
    • eventtypes Array of Event Type Objects
      A list of all the event types this event has attached to it. This list will only have one item in it.
      • ID String
        ID of the event type record.
      • Name String
        Name of the event type record.
    • audiences Array of Audience Objects
      A list of all the audiences this event has attached to it.
      • ID String
        ID of the audience record.
      • Name String
        Name of the audience record.
    • image-url string | null
      The URL of the image of the event or null if none are set. This will always be a URL.
    • occurrences Array of Event Occurrence Objects
      A list of all the occurrences of the event.
      • id string
        The ID of the occurrence date time. This ID can be used to look up events.
      • start-time string
        The start time of the occurrence date time. This is in the ISO 8601 format.
      • end-time string | null
        The end time of the occurrence date time or null if none is set. This is in the ISO 8601 format.
      • is-all-day bool
        Whether the event occurrence is all day or at a specific time.
      • event-timezone string
        The timezone of the event occurrence. This will override the calendar's default timezone.
      • is-recurring bool
        Whether the event occurrence has recurrences or not.
      • canceled bool
        Whether the event occurrence has been canceled or not.
      • event-additional-public-info string | null
        The additional info for the event occurrence or null if none is set.
      • event-room string | null
        The room the event occurrence will take place or null if none is set. This will override the location's room.
      • event-directions string | null
        The directions for the event occurrence or null if none is set. This will override the location's directions.
      • event-location-additional-public-info string | null
        The additional info for the event occurrence's location or null if none is set. This will override the location's additional public info.
      • event-virtual-additional-public-info string | null
        The additional info for the event occurrence's virtual location or null if none is set. This will override the virtual location's additional public info.
      • location Location Object | null
        The location of the event occurrence or null if none is set.
        • id string
          The ID of the location.
        • name string | null
          The name of the location or null if none is set.
        • address-1 string | null
          The street address of the location or null if none is set.
        • address-2 string | null
          The additional address of the location or null if none is set.
        • city string | null
          The city of the location or null if none is set.
        • state string | null
          The state of the location or null if none is set. This will always be the 2 letter abbreviation of the state.
        • zip string | null
          The zip of the location or null if none is set. This will always be ≤ 10 characters long.
        • map-url string | null
          The url of the map graphical interface of the location or null if none is set. This will always be a URL.
        • webpage string | null
          The web page of the location or null if none is set. This will always be a URL.
        • hours string | null
          The hours of the location or null if none is set.
        • phone string | null
          The phone number of the location or null if none is set.
        • default-room string | null
          The room of the location or null if none is set. This will be overridden on events.unl.edu if the event has a room set.
        • default-directions string | null
          The directions of the location or null if none is set. This will be overridden on events.unl.edu if the event has a directions set.
        • default-additional-public-info string | null
          The additional public info of the location or null if none is set. This will be overridden on events.unl.edu if the event has specific location additional public info set.
        • user-id string | null
          The user UID that the location is saved to or null if none is set.
        • calendar-id string | null
          The calendar ID that the location is saved to or null if none is set.
      • virtual-location Virtual Location Object | null
        The virtual location of the event occurrence or null if none is set.
        • id string
          The ID of the virtual location.
        • name string
          The name of the virtual location.
        • url string
          The url of the virtual location.
        • default-additional-public-info string | null
          The additional public info of the virtual location or null if none is set. This will be overridden on events.unl.edu if the event has specific virtual location additional public info set.
        • user-id string | null
          The user UID that the virtual location is saved to or null if none is set.
        • calendar-id string | null
          The calendar ID that the virtual location is saved to or null if none is set.
      • recurring-dates Array of Recurrence Objects
        A list of the event occurrence recurrences.
        • id string
          The ID of the recurrence record. This ID can be used to look up events.
        • recurring-date string
          The date of the recurrence. This is in YYYY-MM-DD format.
        • recurrence-id string
          The ID of the recurrence relative to the occurrence.
        • ongoing bool
          Whether the recurrence is ongoing.
        • canceled bool
          Whether this recurrence is canceled or not.

Example Code

Javascript 
async function eventsAPI() {
    const response = await fetch('https://events.unl.edu/api/v2/calendar/3809/events/');
    // const response = await fetch('https://events.unl.edu/api/v2/calendar/wdn_monthly/events/');
    if (response.ok) {
        const response_json = await response.json();
        console.log(response_json.data);
    }
}
CURL 
curl -X GET 'https://events.unl.edu/api/v2/calendar/3809/events/'
PHP 
function eventsAPI() {
    $url = 'https://events.unl.edu/api/v2/calendar/3809/events/';
    // $url = 'https://events.unl.edu/api/v2/calendar/wdn_monthly/events/';

    // Make an HTTP GET request using file_get_contents
    $response = file_get_contents($url);

    if ($response !== false) {
        // Decode the JSON response
        $responseData = json_decode($response, true);

        // Check if JSON decoding was successful
        if ($responseData !== null) {
            // Access the 'data' field in the response JSON
            var_dump($responseData);
        } else {
            echo 'JSON decoding error';
        }
    } else {
        echo 'Error fetching data';
    }
}

Read (By Location)

GET http://events.unl.edu/api/v2/calendar/{calendar_id}/events/location/{location_id}/

This endpoint will find all events at a particular location by its id.

HTTP Method

GET

Authentication Requirements

None

Request Data

  • calendar_id string | number Required Path
    ID or shortname of the calendar the events will be from. This will go into the path of the request.
  • location_id number Required Path
    The location to filter the events by.

Response Data

  • Status number
    Status code for the request.
  • Message string
    Status message for the request.
  • Data Array of Event Objects | null
    The list of the calendar's events data or null on error.
    • id string
      The ID of the event.
    • title string | null
      The title of the event or null if none is set.
    • subtitle string | null
      The subtitle of the event or null if none is set.
    • description string | null
      The description of the event or null if none is set.
    • webpage string | null
      The webpage of the event or null if none is set. This will always be a URL.
    • private-public 'private' | 'public' | null
      The status of the event's publicity or null if none is set. This will always be public or private.
    • listing-contact-name string | null
      The event's listed contact's name or null if none is set.
    • listing-contact-phone string | null
      The event's listed contact's phone number or null if none is set.
    • listing-contact-email string | null
      The event's listed contact's email or null if none is set.
    • listing-contact-url string | null
      The event's listed contact's url or null if none is set. This will always be a URL.
    • listing-contact-type 'person' | 'organization' | null
      The type of the event's listed contact or null if none is set. This will always be a person or organization.
    • canceled bool
      If the event has been canceled.
    • calendar-event-status string
      The event status of that event on that calendar.
    • original-calendar Calendar Object
      The original calendar the event was posted on.
      • id string
        The ID of the calendar.
      • name string
        The name of the calendar.
      • short-name string
        The short name of the calendar. This can be used in the URL of other events API v2 requests.
      • default-timezone string
        The default timezone of the calendar. This can be overridden by event's data times.
      • webpage string | null
        The webpage of the calendar or null if none is set.
      • email-list string | null
        The list of emails for the calendar or null if none is set. Emails will be separated by commas.
      • event-release-preference string
        The release process for events after they are created on the calendar.
      • recommendations-within-account bool
        Whether users on the same account can recommend events to this calendar.
    • eventtypes Array of Event Type Objects
      A list of all the event types this event has attached to it. This list will only have one item in it.
      • ID String
        ID of the event type record.
      • Name String
        Name of the event type record.
    • audiences Array of Audience Objects
      A list of all the audiences this event has attached to it.
      • ID String
        ID of the audience record.
      • Name String
        Name of the audience record.
    • image-url string | null
      The URL of the image of the event or null if none are set. This will always be a URL.
    • occurrences Array of Event Occurrence Objects
      A list of all the occurrences of the event.
      • id string
        The ID of the occurrence date time. This ID can be used to look up events.
      • start-time string
        The start time of the occurrence date time. This is in the ISO 8601 format.
      • end-time string | null
        The end time of the occurrence date time or null if none is set. This is in the ISO 8601 format.
      • is-all-day bool
        Whether the event occurrence is all day or at a specific time.
      • event-timezone string
        The timezone of the event occurrence. This will override the calendar's default timezone.
      • is-recurring bool
        Whether the event occurrence has recurrences or not.
      • canceled bool
        Whether the event occurrence has been canceled or not.
      • event-additional-public-info string | null
        The additional info for the event occurrence or null if none is set.
      • event-room string | null
        The room the event occurrence will take place or null if none is set. This will override the location's room.
      • event-directions string | null
        The directions for the event occurrence or null if none is set. This will override the location's directions.
      • event-location-additional-public-info string | null
        The additional info for the event occurrence's location or null if none is set. This will override the location's additional public info.
      • event-virtual-additional-public-info string | null
        The additional info for the event occurrence's virtual location or null if none is set. This will override the virtual location's additional public info.
      • location Location Object | null
        The location of the event occurrence or null if none is set.
        • id string
          The ID of the location.
        • name string | null
          The name of the location or null if none is set.
        • address-1 string | null
          The street address of the location or null if none is set.
        • address-2 string | null
          The additional address of the location or null if none is set.
        • city string | null
          The city of the location or null if none is set.
        • state string | null
          The state of the location or null if none is set. This will always be the 2 letter abbreviation of the state.
        • zip string | null
          The zip of the location or null if none is set. This will always be ≤ 10 characters long.
        • map-url string | null
          The url of the map graphical interface of the location or null if none is set. This will always be a URL.
        • webpage string | null
          The web page of the location or null if none is set. This will always be a URL.
        • hours string | null
          The hours of the location or null if none is set.
        • phone string | null
          The phone number of the location or null if none is set.
        • default-room string | null
          The room of the location or null if none is set. This will be overridden on events.unl.edu if the event has a room set.
        • default-directions string | null
          The directions of the location or null if none is set. This will be overridden on events.unl.edu if the event has a directions set.
        • default-additional-public-info string | null
          The additional public info of the location or null if none is set. This will be overridden on events.unl.edu if the event has specific location additional public info set.
        • user-id string | null
          The user UID that the location is saved to or null if none is set.
        • calendar-id string | null
          The calendar ID that the location is saved to or null if none is set.
      • virtual-location Virtual Location Object | null
        The virtual location of the event occurrence or null if none is set.
        • id string
          The ID of the virtual location.
        • name string
          The name of the virtual location.
        • url string
          The url of the virtual location.
        • default-additional-public-info string | null
          The additional public info of the virtual location or null if none is set. This will be overridden on events.unl.edu if the event has specific virtual location additional public info set.
        • user-id string | null
          The user UID that the virtual location is saved to or null if none is set.
        • calendar-id string | null
          The calendar ID that the virtual location is saved to or null if none is set.
      • recurring-dates Array of Recurrence Objects
        A list of the event occurrence recurrences.
        • id string
          The ID of the recurrence record. This ID can be used to look up events.
        • recurring-date string
          The date of the recurrence. This is in YYYY-MM-DD format.
        • recurrence-id string
          The ID of the recurrence relative to the occurrence.
        • ongoing bool
          Whether the recurrence is ongoing.
        • canceled bool
          Whether this recurrence is canceled or not.

Example Code

Javascript 
async function eventsAPI() {
    const response = await fetch('https://events.unl.edu/api/v2/calendar/3809/events/location/29092/');
    // const response = await fetch('https://events.unl.edu/api/v2/calendar/wdn_monthly/events/location/29092/');
    if (response.ok) {
        const response_json = await response.json();
        console.log(response_json.data);
    }
}
CURL 
curl -X GET 'https://events.unl.edu/api/v2/calendar/3809/events/location/29092/'
PHP 
function eventsAPI() {
    $url = 'https://events.unl.edu/api/v2/calendar/3809/events/location/29092/';
    // $url = 'https://events.unl.edu/api/v2/calendar/wdn_monthly/events/location/29092/';

    // Make an HTTP GET request using file_get_contents
    $response = file_get_contents($url);

    if ($response !== false) {
        // Decode the JSON response
        $responseData = json_decode($response, true);

        // Check if JSON decoding was successful
        if ($responseData !== null) {
            // Access the 'data' field in the response JSON
            var_dump($responseData);
        } else {
            echo 'JSON decoding error';
        }
    } else {
        echo 'Error fetching data';
    }
}

Read (By Virtual Location)

GET http://events.unl.edu/api/v2/calendar/{calendar_id}/events/virtual-location/{location_id}/

This endpoint will find all events at a particular virtual location by its id.

HTTP Method

GET

Authentication Requirements

None

Request Data

  • calendar_id string | number Required Path
    ID or shortname of the calendar the events will be from. This will go into the path of the request.
  • location_id number Required Path
    The location to filter the events by.

Response Data

  • Status number
    Status code for the request.
  • Message string
    Status message for the request.
  • Data Array of Event Objects | null
    The list of the calendar's events data or null on error.
    • id string
      The ID of the event.
    • title string | null
      The title of the event or null if none is set.
    • subtitle string | null
      The subtitle of the event or null if none is set.
    • description string | null
      The description of the event or null if none is set.
    • webpage string | null
      The webpage of the event or null if none is set. This will always be a URL.
    • private-public 'private' | 'public' | null
      The status of the event's publicity or null if none is set. This will always be public or private.
    • listing-contact-name string | null
      The event's listed contact's name or null if none is set.
    • listing-contact-phone string | null
      The event's listed contact's phone number or null if none is set.
    • listing-contact-email string | null
      The event's listed contact's email or null if none is set.
    • listing-contact-url string | null
      The event's listed contact's url or null if none is set. This will always be a URL.
    • listing-contact-type 'person' | 'organization' | null
      The type of the event's listed contact or null if none is set. This will always be a person or organization.
    • canceled bool
      If the event has been canceled.
    • calendar-event-status string
      The event status of that event on that calendar.
    • original-calendar Calendar Object
      The original calendar the event was posted on.
      • id string
        The ID of the calendar.
      • name string
        The name of the calendar.
      • short-name string
        The short name of the calendar. This can be used in the URL of other events API v2 requests.
      • default-timezone string
        The default timezone of the calendar. This can be overridden by event's data times.
      • webpage string | null
        The webpage of the calendar or null if none is set.
      • email-list string | null
        The list of emails for the calendar or null if none is set. Emails will be separated by commas.
      • event-release-preference string
        The release process for events after they are created on the calendar.
      • recommendations-within-account bool
        Whether users on the same account can recommend events to this calendar.
    • eventtypes Array of Event Type Objects
      A list of all the event types this event has attached to it. This list will only have one item in it.
      • ID String
        ID of the event type record.
      • Name String
        Name of the event type record.
    • audiences Array of Audience Objects
      A list of all the audiences this event has attached to it.
      • ID String
        ID of the audience record.
      • Name String
        Name of the audience record.
    • image-url string | null
      The URL of the image of the event or null if none are set. This will always be a URL.
    • occurrences Array of Event Occurrence Objects
      A list of all the occurrences of the event.
      • id string
        The ID of the occurrence date time. This ID can be used to look up events.
      • start-time string
        The start time of the occurrence date time. This is in the ISO 8601 format.
      • end-time string | null
        The end time of the occurrence date time or null if none is set. This is in the ISO 8601 format.
      • is-all-day bool
        Whether the event occurrence is all day or at a specific time.
      • event-timezone string
        The timezone of the event occurrence. This will override the calendar's default timezone.
      • is-recurring bool
        Whether the event occurrence has recurrences or not.
      • canceled bool
        Whether the event occurrence has been canceled or not.
      • event-additional-public-info string | null
        The additional info for the event occurrence or null if none is set.
      • event-room string | null
        The room the event occurrence will take place or null if none is set. This will override the location's room.
      • event-directions string | null
        The directions for the event occurrence or null if none is set. This will override the location's directions.
      • event-location-additional-public-info string | null
        The additional info for the event occurrence's location or null if none is set. This will override the location's additional public info.
      • event-virtual-additional-public-info string | null
        The additional info for the event occurrence's virtual location or null if none is set. This will override the virtual location's additional public info.
      • location Location Object | null
        The location of the event occurrence or null if none is set.
        • id string
          The ID of the location.
        • name string | null
          The name of the location or null if none is set.
        • address-1 string | null
          The street address of the location or null if none is set.
        • address-2 string | null
          The additional address of the location or null if none is set.
        • city string | null
          The city of the location or null if none is set.
        • state string | null
          The state of the location or null if none is set. This will always be the 2 letter abbreviation of the state.
        • zip string | null
          The zip of the location or null if none is set. This will always be ≤ 10 characters long.
        • map-url string | null
          The url of the map graphical interface of the location or null if none is set. This will always be a URL.
        • webpage string | null
          The web page of the location or null if none is set. This will always be a URL.
        • hours string | null
          The hours of the location or null if none is set.
        • phone string | null
          The phone number of the location or null if none is set.
        • default-room string | null
          The room of the location or null if none is set. This will be overridden on events.unl.edu if the event has a room set.
        • default-directions string | null
          The directions of the location or null if none is set. This will be overridden on events.unl.edu if the event has a directions set.
        • default-additional-public-info string | null
          The additional public info of the location or null if none is set. This will be overridden on events.unl.edu if the event has specific location additional public info set.
        • user-id string | null
          The user UID that the location is saved to or null if none is set.
        • calendar-id string | null
          The calendar ID that the location is saved to or null if none is set.
      • virtual-location Virtual Location Object | null
        The virtual location of the event occurrence or null if none is set.
        • id string
          The ID of the virtual location.
        • name string
          The name of the virtual location.
        • url string
          The url of the virtual location.
        • default-additional-public-info string | null
          The additional public info of the virtual location or null if none is set. This will be overridden on events.unl.edu if the event has specific virtual location additional public info set.
        • user-id string | null
          The user UID that the virtual location is saved to or null if none is set.
        • calendar-id string | null
          The calendar ID that the virtual location is saved to or null if none is set.
      • recurring-dates Array of Recurrence Objects
        A list of the event occurrence recurrences.
        • id string
          The ID of the recurrence record. This ID can be used to look up events.
        • recurring-date string
          The date of the recurrence. This is in YYYY-MM-DD format.
        • recurrence-id string
          The ID of the recurrence relative to the occurrence.
        • ongoing bool
          Whether the recurrence is ongoing.
        • canceled bool
          Whether this recurrence is canceled or not.

Example Code

Javascript 
async function eventsAPI() {
    const response = await fetch('https://events.unl.edu/api/v2/calendar/3809/events/virtual-location/12345/');
    // const response = await fetch('https://events.unl.edu/api/v2/calendar/wdn_monthly/events/virtual-location/12345/');
    if (response.ok) {
        const response_json = await response.json();
        console.log(response_json.data);
    }
}
CURL 
curl -X GET 'https://events.unl.edu/api/v2/calendar/3809/events/virtual-location/12345/'
PHP 
function eventsAPI() {
    $url = 'https://events.unl.edu/api/v2/calendar/3809/events/virtual-location/12345/';
    // $url = 'https://events.unl.edu/api/v2/calendar/wdn_monthly/events/virtual-location/12345/';

    // Make an HTTP GET request using file_get_contents
    $response = file_get_contents($url);

    if ($response !== false) {
        // Decode the JSON response
        $responseData = json_decode($response, true);

        // Check if JSON decoding was successful
        if ($responseData !== null) {
            // Access the 'data' field in the response JSON
            var_dump($responseData);
        } else {
            echo 'JSON decoding error';
        }
    } else {
        echo 'Error fetching data';
    }
}

Read (Pending)

GET http://events.unl.edu/api/v2/calendar/{calendar_id}/events/pending/

This endpoint is for getting a list of the pending events from a calendar.

HTTP Method

GET

Authentication Requirements

You must add a header to the request with the header key being Authentication and the value being your API Token.

Request Data

  • calendar_id string | number Required Path
    ID or shortname of the calendar the events will be from. This will go into the path of the request.
  • limit number query
    This is the number of events you want to receive. Max limit is 500 and default is 100.
  • offset number query
    This offset is to be used to get the next batch of events beyond the initial limit.

Response Data

  • Status number
    Status code for the request.
  • Message string
    Status message for the request.
  • Data Array of Event Objects | null
    The list of the calendar's pending events data or null on error.
    • id string
      The ID of the event.
    • title string | null
      The title of the event or null if none is set.
    • subtitle string | null
      The subtitle of the event or null if none is set.
    • description string | null
      The description of the event or null if none is set.
    • webpage string | null
      The webpage of the event or null if none is set. This will always be a URL.
    • private-public 'private' | 'public' | null
      The status of the event's publicity or null if none is set. This will always be public or private.
    • listing-contact-name string | null
      The event's listed contact's name or null if none is set.
    • listing-contact-phone string | null
      The event's listed contact's phone number or null if none is set.
    • listing-contact-email string | null
      The event's listed contact's email or null if none is set.
    • listing-contact-url string | null
      The event's listed contact's url or null if none is set. This will always be a URL.
    • listing-contact-type 'person' | 'organization' | null
      The type of the event's listed contact or null if none is set. This will always be a person or organization.
    • canceled bool
      If the event has been canceled.
    • calendar-event-status string
      The event status of that event on that calendar.
    • original-calendar Calendar Object
      The original calendar the event was posted on.
      • id string
        The ID of the calendar.
      • name string
        The name of the calendar.
      • short-name string
        The short name of the calendar. This can be used in the URL of other events API v2 requests.
      • default-timezone string
        The default timezone of the calendar. This can be overridden by event's data times.
      • webpage string | null
        The webpage of the calendar or null if none is set.
      • email-list string | null
        The list of emails for the calendar or null if none is set. Emails will be separated by commas.
      • event-release-preference string
        The release process for events after they are created on the calendar.
      • recommendations-within-account bool
        Whether users on the same account can recommend events to this calendar.
    • eventtypes Array of Event Type Objects
      A list of all the event types this event has attached to it. This list will only have one item in it.
      • ID String
        ID of the event type record.
      • Name String
        Name of the event type record.
    • audiences Array of Audience Objects
      A list of all the audiences this event has attached to it.
      • ID String
        ID of the audience record.
      • Name String
        Name of the audience record.
    • image-url string | null
      The URL of the image of the event or null if none are set. This will always be a URL.
    • occurrences Array of Event Occurrence Objects
      A list of all the occurrences of the event.
      • id string
        The ID of the occurrence date time. This ID can be used to look up events.
      • start-time string
        The start time of the occurrence date time. This is in the ISO 8601 format.
      • end-time string | null
        The end time of the occurrence date time or null if none is set. This is in the ISO 8601 format.
      • is-all-day bool
        Whether the event occurrence is all day or at a specific time.
      • event-timezone string
        The timezone of the event occurrence. This will override the calendar's default timezone.
      • is-recurring bool
        Whether the event occurrence has recurrences or not.
      • canceled bool
        Whether the event occurrence has been canceled or not.
      • event-additional-public-info string | null
        The additional info for the event occurrence or null if none is set.
      • event-room string | null
        The room the event occurrence will take place or null if none is set. This will override the location's room.
      • event-directions string | null
        The directions for the event occurrence or null if none is set. This will override the location's directions.
      • event-location-additional-public-info string | null
        The additional info for the event occurrence's location or null if none is set. This will override the location's additional public info.
      • event-virtual-additional-public-info string | null
        The additional info for the event occurrence's virtual location or null if none is set. This will override the virtual location's additional public info.
      • location Location Object | null
        The location of the event occurrence or null if none is set.
        • id string
          The ID of the location.
        • name string | null
          The name of the location or null if none is set.
        • address-1 string | null
          The street address of the location or null if none is set.
        • address-2 string | null
          The additional address of the location or null if none is set.
        • city string | null
          The city of the location or null if none is set.
        • state string | null
          The state of the location or null if none is set. This will always be the 2 letter abbreviation of the state.
        • zip string | null
          The zip of the location or null if none is set. This will always be ≤ 10 characters long.
        • map-url string | null
          The url of the map graphical interface of the location or null if none is set. This will always be a URL.
        • webpage string | null
          The web page of the location or null if none is set. This will always be a URL.
        • hours string | null
          The hours of the location or null if none is set.
        • phone string | null
          The phone number of the location or null if none is set.
        • default-room string | null
          The room of the location or null if none is set. This will be overridden on events.unl.edu if the event has a room set.
        • default-directions string | null
          The directions of the location or null if none is set. This will be overridden on events.unl.edu if the event has a directions set.
        • default-additional-public-info string | null
          The additional public info of the location or null if none is set. This will be overridden on events.unl.edu if the event has specific location additional public info set.
        • user-id string | null
          The user UID that the location is saved to or null if none is set.
        • calendar-id string | null
          The calendar ID that the location is saved to or null if none is set.
      • virtual-location Virtual Location Object | null
        The virtual location of the event occurrence or null if none is set.
        • id string
          The ID of the virtual location.
        • name string
          The name of the virtual location.
        • url string
          The url of the virtual location.
        • default-additional-public-info string | null
          The additional public info of the virtual location or null if none is set. This will be overridden on events.unl.edu if the event has specific virtual location additional public info set.
        • user-id string | null
          The user UID that the virtual location is saved to or null if none is set.
        • calendar-id string | null
          The calendar ID that the virtual location is saved to or null if none is set.
      • recurring-dates Array of Recurrence Objects
        A list of the event occurrence recurrences.
        • id string
          The ID of the recurrence record. This ID can be used to look up events.
        • recurring-date string
          The date of the recurrence. This is in YYYY-MM-DD format.
        • recurrence-id string
          The ID of the recurrence relative to the occurrence.
        • ongoing bool
          Whether the recurrence is ongoing.
        • canceled bool
          Whether this recurrence is canceled or not.

Example Code

Javascript 
async function eventsAPI() {
    const response = await fetch('https://events.unl.edu/api/v2/calendar/3809/events/pending/', {
        headers: {
            'Authentication': MY_API_TOKEN,
        }
    });
    // const response = await fetch('https://events.unl.edu/api/v2/calendar/wdn_monthly/events/pending/', {
    //     headers: {
    //         'Authentication': MY_API_TOKEN,
    //     }
    // });
    if (response.ok) {
        const response_json = await response.json();
        console.log(response_json.data);
    }
}
CURL 
curl -X GET 'https://events.unl.edu/api/v2/calendar/3809/events/pending/' \
-H 'Authentication: MY_API_TOKEN'
PHP 
function eventsAPI() {
    $apiToken = 'MY_API_TOKEN';

    $url = 'https://events.unl.edu/api/v2/calendar/3809/events/pending/';
    //$url = 'https://events.unl.edu/api/v2/calendar/wdn_monthly/events/pending/';
    $headers = array(
        'Authentication: ' . $apiToken,
    );

    // Initialize cURL session
    $ch = curl_init();

    // Set cURL options
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

    // Execute cURL session and get the response
    $response = curl_exec($ch);

    // Check if cURL request was successful
    if ($response === false) {
        // Handle cURL error
        echo 'cURL Error: ' . curl_error($ch);
    } else {
        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        if ($httpCode === 200) {
            // Successful response
            $responseData = json_decode($response, true);
            var_dump($responseData);
        } else {
            // Error response
            echo 'API Error: ' . $response;
        }
    }

    // Close cURL session
    curl_close($ch);
}

Read (Archived)

GET http://events.unl.edu/api/v2/calendar/{calendar_id}/events/archived/

This endpoint is for getting a list of the archived events from a calendar.

HTTP Method

GET

Authentication Requirements

You must add a header to the request with the header key being Authentication and the value being your API Token.

Request Data

  • calendar_id string | number Required Path
    ID or shortname of the calendar the events will be from. This will go into the path of the request.
  • limit number query
    This is the number of events you want to receive. Max limit is 500 and default is 100.
  • offset number query
    This offset is to be used to get the next batch of events beyond the initial limit.

Response Data

  • Status number
    Status code for the request.
  • Message string
    Status message for the request.
  • Data Array of Event Objects | null
    The list of the calendar's archived events data or null on error.
    • id string
      The ID of the event.
    • title string | null
      The title of the event or null if none is set.
    • subtitle string | null
      The subtitle of the event or null if none is set.
    • description string | null
      The description of the event or null if none is set.
    • webpage string | null
      The webpage of the event or null if none is set. This will always be a URL.
    • private-public 'private' | 'public' | null
      The status of the event's publicity or null if none is set. This will always be public or private.
    • listing-contact-name string | null
      The event's listed contact's name or null if none is set.
    • listing-contact-phone string | null
      The event's listed contact's phone number or null if none is set.
    • listing-contact-email string | null
      The event's listed contact's email or null if none is set.
    • listing-contact-url string | null
      The event's listed contact's url or null if none is set. This will always be a URL.
    • listing-contact-type 'person' | 'organization' | null
      The type of the event's listed contact or null if none is set. This will always be a person or organization.
    • canceled bool
      If the event has been canceled.
    • calendar-event-status string
      The event status of that event on that calendar.
    • original-calendar Calendar Object
      The original calendar the event was posted on.
      • id string
        The ID of the calendar.
      • name string
        The name of the calendar.
      • short-name string
        The short name of the calendar. This can be used in the URL of other events API v2 requests.
      • default-timezone string
        The default timezone of the calendar. This can be overridden by event's data times.
      • webpage string | null
        The webpage of the calendar or null if none is set.
      • email-list string | null
        The list of emails for the calendar or null if none is set. Emails will be separated by commas.
      • event-release-preference string
        The release process for events after they are created on the calendar.
      • recommendations-within-account bool
        Whether users on the same account can recommend events to this calendar.
    • eventtypes Array of Event Type Objects
      A list of all the event types this event has attached to it. This list will only have one item in it.
      • ID String
        ID of the event type record.
      • Name String
        Name of the event type record.
    • audiences Array of Audience Objects
      A list of all the audiences this event has attached to it.
      • ID String
        ID of the audience record.
      • Name String
        Name of the audience record.
    • image-url string | null
      The URL of the image of the event or null if none are set. This will always be a URL.
    • occurrences Array of Event Occurrence Objects
      A list of all the occurrences of the event.
      • id string
        The ID of the occurrence date time. This ID can be used to look up events.
      • start-time string
        The start time of the occurrence date time. This is in the ISO 8601 format.
      • end-time string | null
        The end time of the occurrence date time or null if none is set. This is in the ISO 8601 format.
      • is-all-day bool
        Whether the event occurrence is all day or at a specific time.
      • event-timezone string
        The timezone of the event occurrence. This will override the calendar's default timezone.
      • is-recurring bool
        Whether the event occurrence has recurrences or not.
      • canceled bool
        Whether the event occurrence has been canceled or not.
      • event-additional-public-info string | null
        The additional info for the event occurrence or null if none is set.
      • event-room string | null
        The room the event occurrence will take place or null if none is set. This will override the location's room.
      • event-directions string | null
        The directions for the event occurrence or null if none is set. This will override the location's directions.
      • event-location-additional-public-info string | null
        The additional info for the event occurrence's location or null if none is set. This will override the location's additional public info.
      • event-virtual-additional-public-info string | null
        The additional info for the event occurrence's virtual location or null if none is set. This will override the virtual location's additional public info.
      • location Location Object | null
        The location of the event occurrence or null if none is set.
        • id string
          The ID of the location.
        • name string | null
          The name of the location or null if none is set.
        • address-1 string | null
          The street address of the location or null if none is set.
        • address-2 string | null
          The additional address of the location or null if none is set.
        • city string | null
          The city of the location or null if none is set.
        • state string | null
          The state of the location or null if none is set. This will always be the 2 letter abbreviation of the state.
        • zip string | null
          The zip of the location or null if none is set. This will always be ≤ 10 characters long.
        • map-url string | null
          The url of the map graphical interface of the location or null if none is set. This will always be a URL.
        • webpage string | null
          The web page of the location or null if none is set. This will always be a URL.
        • hours string | null
          The hours of the location or null if none is set.
        • phone string | null
          The phone number of the location or null if none is set.
        • default-room string | null
          The room of the location or null if none is set. This will be overridden on events.unl.edu if the event has a room set.
        • default-directions string | null
          The directions of the location or null if none is set. This will be overridden on events.unl.edu if the event has a directions set.
        • default-additional-public-info string | null
          The additional public info of the location or null if none is set. This will be overridden on events.unl.edu if the event has specific location additional public info set.
        • user-id string | null
          The user UID that the location is saved to or null if none is set.
        • calendar-id string | null
          The calendar ID that the location is saved to or null if none is set.
      • virtual-location Virtual Location Object | null
        The virtual location of the event occurrence or null if none is set.
        • id string
          The ID of the virtual location.
        • name string
          The name of the virtual location.
        • url string
          The url of the virtual location.
        • default-additional-public-info string | null
          The additional public info of the virtual location or null if none is set. This will be overridden on events.unl.edu if the event has specific virtual location additional public info set.
        • user-id string | null
          The user UID that the virtual location is saved to or null if none is set.
        • calendar-id string | null
          The calendar ID that the virtual location is saved to or null if none is set.
      • recurring-dates Array of Recurrence Objects
        A list of the event occurrence recurrences.
        • id string
          The ID of the recurrence record. This ID can be used to look up events.
        • recurring-date string
          The date of the recurrence. This is in YYYY-MM-DD format.
        • recurrence-id string
          The ID of the recurrence relative to the occurrence.
        • ongoing bool
          Whether the recurrence is ongoing.
        • canceled bool
          Whether this recurrence is canceled or not.

Example Code

Javascript 
async function eventsAPI() {
    const response = await fetch('https://events.unl.edu/api/v2/calendar/3809/events/archived/', {
        headers: {
            'Authentication': MY_API_TOKEN,
        }
    });
    // const response = await fetch('https://events.unl.edu/api/v2/calendar/wdn_monthly/events/archived/', {
    //     headers: {
    //         'Authentication': MY_API_TOKEN,
    //     }
    // });
    if (response.ok) {
        const response_json = await response.json();
        console.log(response_json.data);
    }
}
CURL 
curl -X GET 'https://events.unl.edu/api/v2/calendar/3809/events/archived/' \
-H 'Authentication: MY_API_TOKEN'
PHP 
function eventsAPI() {
    $apiToken = 'MY_API_TOKEN';

    $url = 'https://events.unl.edu/api/v2/calendar/3809/events/archived/';
    //$url = 'https://events.unl.edu/api/v2/calendar/wdn_monthly/events/archived/';
    $headers = array(
        'Authentication: ' . $apiToken,
    );

    // Initialize cURL session
    $ch = curl_init();

    // Set cURL options
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

    // Execute cURL session and get the response
    $response = curl_exec($ch);

    // Check if cURL request was successful
    if ($response === false) {
        // Handle cURL error
        echo 'cURL Error: ' . curl_error($ch);
    } else {
        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        if ($httpCode === 200) {
            // Successful response
            $responseData = json_decode($response, true);
            var_dump($responseData);
        } else {
            // Error response
            echo 'API Error: ' . $response;
        }
    }

    // Close cURL session
    curl_close($ch);
}
Contributed By: 
DXG