Availability

The availability endpoint returns free appointment slots for a branch over a date range, optionally narrowed to a single provider. Use it to answer "when is the next opening?" or to render a booking calendar. It requires the availability:read scope.

#The slot object

Field	Type	Description
`provider_id`	string	The provider this slot is free for.
`branch_id`	string	The branch the slot is at.
`start`	string \| null	ISO 8601 earliest start of the slot.
`end`	string \| null	ISO 8601 end of the slot window.
`latest_start`	string \| null	ISO 8601 latest a visit can start and still fit.

#Find availability

GET

Returns a bounded list (no cursor) of slots in the window.

Parameter	In	Required	Description
`from`	query	yes	Start date, ISO `YYYY-MM-DD`.
`to`	query	yes	End date, ISO `YYYY-MM-DD`.
`branch_id`	query	yes	The branch to search.
`provider_id`	query	no	Restrict to one provider.

curl -G https://api.smile-app.co.il/v1/availability \
  -H "Authorization: Bearer sk_live_..." \
  --data-urlencode "from=2026-07-01" \
  --data-urlencode "to=2026-07-07" \
  --data-urlencode "branch_id=1"

sc availability --branch 1 --from 2026-07-01 --to 2026-07-07

{
  "data": [
    {
      "provider_id": "12",
      "branch_id": "1",
      "start": "2026-07-01T09:00:00+03:00",
      "end": "2026-07-01T17:00:00+03:00",
      "latest_start": "2026-07-01T16:30:00+03:00"
    }
  ]
}

from, to, and branch_id are required

Unlike most list endpoints, availability requires from, to, and branch_id. Omitting any of them returns 400 Bad Request.