Skip to main content
GET
/
availability
cURL
curl --request GET \
  --url https://api.example.com/availability \
  --header 'x-meetergo-api-user-id: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "schedule": {
      "monday": {
        "enabled": true,
        "hours": [
          {
            "start": "<string>",
            "end": "<string>"
          }
        ]
      },
      "tuesday": {
        "enabled": true,
        "hours": [
          {
            "start": "<string>",
            "end": "<string>"
          }
        ]
      },
      "wednesday": {
        "enabled": true,
        "hours": [
          {
            "start": "<string>",
            "end": "<string>"
          }
        ]
      },
      "thursday": {
        "enabled": true,
        "hours": [
          {
            "start": "<string>",
            "end": "<string>"
          }
        ]
      },
      "friday": {
        "enabled": true,
        "hours": [
          {
            "start": "<string>",
            "end": "<string>"
          }
        ]
      },
      "saturday": {
        "enabled": true,
        "hours": [
          {
            "start": "<string>",
            "end": "<string>"
          }
        ]
      },
      "sunday": {
        "enabled": true,
        "hours": [
          {
            "start": "<string>",
            "end": "<string>"
          }
        ]
      }
    },
    "timezone": "<string>",
    "availabilityExceptions": [
      {
        "ownerId": "<string>",
        "ownerType": "company",
        "available": true,
        "start": "<string>",
        "end": "<string>",
        "createdAt": "<string>",
        "id": 123,
        "title": "<string>",
        "note": "<string>",
        "deletedAt": "<string>"
      }
    ],
    "isDefault": true,
    "createdAt": "<string>",
    "deletedAt": "<string>",
    "useExplicitAvailability": true,
    "explicitAvailabilityEventTitle": "<string>"
  }
]

Authorizations

​
x-meetergo-api-user-id
string
header
required

User ID to act as when using API Key authentication (required with API Key)

Query Parameters

​
userId
string

Response

200 - application/json
​
id
string
required
​
name
string
required
​
schedule
object
required
​
timezone
string
required
​
availabilityExceptions
object[]
required
​
isDefault
boolean
required
​
createdAt
string
required
​
deletedAt
string
​
useExplicitAvailability
boolean

When enabled, only calendar events with the specified title will be used as available slots.

​
explicitAvailabilityEventTitle
string | null

The calendar event title to look for when useExplicitAvailability is enabled.