Public API

Get one experience in detail

Full details for one experience occurrence returned by search: complete description, refund policy, skill level, gallery images, live availability and a direct booking_url (checkout).

Use it after search when the user shows interest in a specific result or asks a follow-up ("is it beginner friendly?", "can I get a refund?", "how many spots are left?"). id is the id field of a search result.

Example: GET /public/v1/experiences/0b7e5c1a-2f3d-4e5f-8a9b-0c1d2e3f4a5b

Returns 404 NOT_FOUND for unknown ids and for experiences that are no longer public. Booking always happens on Sweatpals via url or booking_url.

get/public/v1/experiences/{id}

Request

  • Base URL
    https://ilove.sweatpals.com/api
  • Auth
    none declared

Path parameters

idstring required
Example:0b7e5c1a-2f3d-4e5f-8a9b-0c1d2e3f4a5b

The id of a search result.

Response

The experience with full details.

idstring required

Occurrence id; pass it to GET /experiences/{id}.

event_idstring required

Series id shared by every occurrence of a recurring experience (informational).

titlestring required
short_descriptionstring nullable required

Plain-text summary, at most 300 characters.

startstring required

Start in ISO 8601 with the venue's UTC offset.

endstring nullable required

End in ISO 8601 with the venue's UTC offset.

timezonestring required

IANA time zone of the venue.

is_onlineboolean required
tagsstring[] required

Activity tags (e.g. Running, Yoga).

availability'available' | 'limited' | 'sold_out' | 'waitlist' | 'unknown' required

limited = 5 or fewer spots left; waitlist = sold out with an open waitlist; unknown = could not be determined (never implies sold out).

spots_remainingnumber nullable required

Spots left; null when capacity is unlimited or unknown.

image_urlstring nullable required
urlstring required

Canonical event page; send the user here to view and book.

descriptionstring nullable required

Full description as the host wrote it (may contain Markdown).

refund_policystring nullable required
skill_level'beginner' | 'intermediate' | 'advanced' required
booking_urlstring required

Opens checkout directly; same attribution params as url.

gallery_image_urlsstring[] required

Example response

{
  "id": "0b7e5c1a-2f3d-4e5f-8a9b-0c1d2e3f4a5b",
  "event_id": "9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a",
  "title": "Sunrise Trail Run + Coffee",
  "short_description": "An easy-paced 5K on the Butler trail followed by coffee with the crew. All paces welcome.",
  "start": "2026-10-03T07:00:00-05:00",
  "end": "2026-10-03T08:30:00-05:00",
  "timezone": "America/Chicago",
  "venue": {
    "name": "Zilker Park",
    "address": "Austin, Texas, United States",
    "lat": 30.2669,
    "lng": -97.7729
  },
  "market": {
    "slug": "austin-tx",
    "name": "Austin",
    "region": "Texas"
  },
  "price": {
    "amount": 25,
    "currency": "USD"
  },
  "host": {
    "id": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
    "name": "Austin Sunrise Runners",
    "url": "https://sweatpals.com/host/austinsunriserunners"
  },
  "tags": [
    "Running"
  ],
  "spots_remaining": 12,
  "image_url": "https://edge.sweatpals.com/api/files/2c9f0a1b-3d4e-4f5a-9b8c-7d6e5f4a3b2c?variant=l",
  "url": "https://sweatpals.com/event/sunrise-trail-run/2026-10-03?utm_source=agent&utm_medium=ai_agent&ref=agent",
  "description": "Meet at the Zilker Park boathouse. **Easy pace**, no one gets left behind.",
  "refund_policy": "Full automatic refund if cancelled more than 24 hours before the start.",
  "booking_url": "https://sweatpals.com/event/sunrise-trail-run/2026-10-03/checkout?utm_source=agent&utm_medium=ai_agent&ref=agent",
  "gallery_image_urls": [
    "https://edge.sweatpals.com/api/files/4a5b6c7d-8e9f-4a0b-9c1d-2e3f4a5b6c7d?variant=l"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.