YARD

YARD API Reference

Explore the endpoints, request parameters and responses available to your account. Sign in to see additional endpoints according to your YARD permissions.

Download OpenAPI JSON

Events

Published events, drafts, saved events and event submissions.

  • GET /v1/events/{slug}/calendar.ics: Download an event as iCalendar
  • GET /v1/events: Published visible events
  • GET /v1/events/{slug}: Event detail

Calendars

Calendars, calendar ownership and event markings.

  • GET /v1/calendars: Public calendars
  • GET /v1/calendars/{slug}: Calendar detail

Cards

YARD Cards, contact downloads and contact requests.

  • GET /v1/cards/{uuid}/contact.vcf: Download a public Card vCard
  • GET /v1/cards: Browse active YARD Cards
  • GET /v1/cards/{uuid}: Read an active YARD Card

Collections

Curated collections and their contents.

  • GET /v1/collections: Collections
  • GET /v1/collections/{slug}: Collection detail

Search, filters and discovery suggestions.

  • GET /v1/public-search: Search public YARD pages and Objects in Elasticsearch
  • GET /v1/search: Search published events
  • GET /v1/explore: Filter published events

Media

Images, uploads and media metadata.

  • GET /v1/public-media/{id}: Published event or calendar image

Integrations

Embedded views, remote dialogs and WordPress plugin releases.

  • GET /api/v1/get-code/: Legacy YARD calendar embed contract
  • GET /api/v1/get-modal-js/: Legacy YARD event modal contract
  • GET /v1/remote/calendars: Rendered public calendar for the YARD embed
  • GET /v1/remote/events/{id}/modal: Rendered public event modal for the YARD embed
  • GET /v1/plugin/releases/latest: Latest YARD WordPress plugin release

If you have questions or suggestions, please write to: team@yard.global