Skip to main content
GET
/
v1
/
events
Get Events
curl --request GET \
  --url http://localhost:4000/v1/events \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "color": "<string>",
      "eventType": "<string>",
      "description": "<string>",
      "internalDescription": "<string>",
      "deletedAt": "<unknown>",
      "language": "<string>",
      "emailValidationEnabled": true,
      "phoneNumberValidationEnabled": true,
      "creditCheck": {
        "type": {},
        "toggle": true
      },
      "userId": 123,
      "duration": 123,
      "durationUnit": "<string>",
      "location": "<string>",
      "dateRangeType": "<string>",
      "dateRangeUnit": "<string>",
      "linkPrefix": "<string>",
      "status": "<string>",
      "allowReschedule": true,
      "phonePreferred": true,
      "splitFullName": true,
      "businessEmail": true,
      "disableDuplicateBooking": true,
      "lockHostOnReschedule": true,
      "dateRangeDays": 123,
      "bypassQuestion": true
    }
  ],
  "count": 123,
  "totalCount": 123,
  "hasVisibleEvents": true
}

Authorizations

Authorization
string
header
required

API key required in Authorization header. Format: iclosed-<token>

Query Parameters

limit
integer
default:10
Required range: 1 <= x <= 500
page
integer
Required range: x >= 0
userId
integer
eventType
enum<string>
Available options:
STRATEGY_EVENT,
DISCOVERY_EVENT

Response

List of events or single event

data
object[]
count
number
totalCount
number
hasVisibleEvents
boolean