Carrier Portal
- GETList carrier appointments
- POSTCreate a carrier appointment request
- GETList past carrier appointments
- GETGet carrier appointment details
- GETList documents for an appointment
- POSTUpload a document for an appointment
- DELDelete a document for an appointment
- POSTSubmit carrier claim request
- GETGet carrier profile
- GETList current user's carrier claims (v2)
- POSTSubmit a carrier claim (v2)
- GETList pending carrier member requests for carrier admins
- GETList carrier team members for carrier admins
- GETList carrier team invitations for carrier admins
- POSTInvite a user to the carrier team
- DELCancel a carrier team invitation
- POSTResend a carrier team invitation
- GETGet carrier claim details (v2)
- POSTUpdate claim contact email and restart automatic verification
- POSTRequest carrier claim email verification (v2)
- POSTUpload a carrier claim verification document (v2)
- DELDelete current carrier claim verification document (v2)
- POSTRespond to carrier claim info request (v2)
- POSTApprove pending carrier member claim (carrier admin)
- POSTAccept carrier team invitation
- GETComplete carrier claim email verification (v2)
- POSTUpload a document for a booking (tracking ID)
- GETList carrier portal appointments (by email or approved carrier claim)
- GETGet carrier portal appointment details
- PATCHUpdate permitted appointment fields
- POSTCancel appointment (hybrid)
- GETGet carrier portal appointment status history
- GETList carrier portal appointment cancellation requests
- GETList appointment documents
- POSTUpload appointment document
- DELDelete appointment document
- GETList appointment document requirements and status
- GETList reschedule requests for an appointment
- POSTCreate reschedule request (facility-reviewed)
- GETGet appointment message thread
- POSTMint a realtime ticket for appointment thread updates
- POSTPost message to appointment thread
- GETBrowse discoverable facilities
- POSTRequest access/invite for a facility
- GETList carriers linked to the portal user
- POSTCreate a carrier profile for the portal user
- GETGet selected carrier profile settings
- PATCHUpdate selected carrier profile settings
- GETGet the active view preference for the current portal user
- PATCHUpdate the last-used view preference for the current portal user
- GETList saved views for the current portal user
- POSTCreate a saved view for the current portal user
- DELDelete a saved view for the current portal user
- PATCHUpdate a saved view for the current portal user
- GETList carrier fleet drivers
- POSTCreate carrier fleet driver
- PATCHUpdate carrier fleet driver
- GETList carrier fleet assets
- POSTCreate carrier fleet asset
- PATCHUpdate carrier fleet asset
- PATCHAssign or clear appointment resources
- GETGet driver SMS consent status during assignment
- POSTRequest or resend driver SMS consent during assignment
- POSTBulk assign or clear appointment resources
AnonymousBooking
- POSTPost portalbookings
- POSTPost portalbookingsauthenticated
- POSTPost portalbookingsotprequest
- POSTPost portalbookingsotpverify
- GETGet portalbookings
- GETGet portallocations booking settings
- POSTPost portallocations carrier verification
- GETGet portallocations allowlist status
- POSTPost portallocations carrier access requests
- GETGet portallocations carrier access requestsstatus
- POSTPost portallocations invite requests
- GETGet portallocations invite requestsstatus
- GETGet portallocations availability
EmailVerification
InviteLink
Public Check-In
- GETValidate check-in token and get appointment details
- POSTConfirm driver arrival
- GETGet appointment status for a driver session
- POSTRenew a driver session token
- POSTIssue a driver session token using a check-in token (view-only)
- GETGet location context for kiosk check-in
- POSTLookup an appointment (no operational side effects on failure)
- POSTConfirm driver intent (creates or updates a single exception)
- POSTUpload an optional attachment for a kiosk help request
- GETGet status/instructions for a kiosk exception
Cancel appointment (hybrid)
curl --request POST \
--url https://api.example.com/portal/appointments/{appointmentId}/cancel \
--header 'Authorization: Bearer <token>'Carrier Portal
Cancel appointment (hybrid)
POST
/
portal
/
appointments
/
{appointmentId}
/
cancel
Cancel appointment (hybrid)
curl --request POST \
--url https://api.example.com/portal/appointments/{appointmentId}/cancel \
--header 'Authorization: Bearer <token>'Documentation Index
Fetch the complete documentation index at: https://docs.getyardo.com/llms.txt
Use this file to discover all available pages before exploring further.
⌘I