# Yardo Docs ## Docs - [Get portalbookings](https://docs.getyardo.com/api-reference/anonymousbooking/get-portalbookings.md) - [Get portallocations allowlist status](https://docs.getyardo.com/api-reference/anonymousbooking/get-portallocations-allowlist-status.md) - [Get portallocations availability](https://docs.getyardo.com/api-reference/anonymousbooking/get-portallocations-availability.md) - [Get portallocations booking settings](https://docs.getyardo.com/api-reference/anonymousbooking/get-portallocations-booking-settings.md) - [Get portallocations carrier access requestsstatus](https://docs.getyardo.com/api-reference/anonymousbooking/get-portallocations-carrier-access-requestsstatus.md) - [Get portallocations invite requestsstatus](https://docs.getyardo.com/api-reference/anonymousbooking/get-portallocations-invite-requestsstatus.md) - [Post portalbookings](https://docs.getyardo.com/api-reference/anonymousbooking/post-portalbookings.md) - [Post portalbookingsauthenticated](https://docs.getyardo.com/api-reference/anonymousbooking/post-portalbookingsauthenticated.md) - [Post portalbookingsotprequest](https://docs.getyardo.com/api-reference/anonymousbooking/post-portalbookingsotprequest.md) - [Post portalbookingsotpverify](https://docs.getyardo.com/api-reference/anonymousbooking/post-portalbookingsotpverify.md) - [Post portallocations carrier access requests](https://docs.getyardo.com/api-reference/anonymousbooking/post-portallocations-carrier-access-requests.md) - [Post portallocations carrier verification](https://docs.getyardo.com/api-reference/anonymousbooking/post-portallocations-carrier-verification.md) - [Post portallocations invite requests](https://docs.getyardo.com/api-reference/anonymousbooking/post-portallocations-invite-requests.md) - [Accept carrier team invitation](https://docs.getyardo.com/api-reference/carrier-portal/accept-carrier-team-invitation.md) - [Approve pending carrier member claim (carrier admin)](https://docs.getyardo.com/api-reference/carrier-portal/approve-pending-carrier-member-claim-carrier-admin.md) - [Assign or clear appointment resources](https://docs.getyardo.com/api-reference/carrier-portal/assign-or-clear-appointment-resources.md) - [Browse discoverable facilities](https://docs.getyardo.com/api-reference/carrier-portal/browse-discoverable-facilities.md) - [Bulk assign or clear appointment resources](https://docs.getyardo.com/api-reference/carrier-portal/bulk-assign-or-clear-appointment-resources.md) - [Cancel a carrier team invitation](https://docs.getyardo.com/api-reference/carrier-portal/cancel-a-carrier-team-invitation.md) - [Cancel appointment (hybrid)](https://docs.getyardo.com/api-reference/carrier-portal/cancel-appointment-hybrid.md) - [Complete carrier claim email verification (v2)](https://docs.getyardo.com/api-reference/carrier-portal/complete-carrier-claim-email-verification-v2.md) - [Create a carrier appointment request](https://docs.getyardo.com/api-reference/carrier-portal/create-a-carrier-appointment-request.md) - [Create a carrier profile for the portal user](https://docs.getyardo.com/api-reference/carrier-portal/create-a-carrier-profile-for-the-portal-user.md) - [Create a saved view for the current portal user](https://docs.getyardo.com/api-reference/carrier-portal/create-a-saved-view-for-the-current-portal-user.md) - [Create carrier fleet asset](https://docs.getyardo.com/api-reference/carrier-portal/create-carrier-fleet-asset.md) - [Create carrier fleet driver](https://docs.getyardo.com/api-reference/carrier-portal/create-carrier-fleet-driver.md) - [Create reschedule request (facility-reviewed)](https://docs.getyardo.com/api-reference/carrier-portal/create-reschedule-request-facility-reviewed.md) - [Delete a document for an appointment](https://docs.getyardo.com/api-reference/carrier-portal/delete-a-document-for-an-appointment.md) - [Delete a saved view for the current portal user](https://docs.getyardo.com/api-reference/carrier-portal/delete-a-saved-view-for-the-current-portal-user.md) - [Delete appointment document](https://docs.getyardo.com/api-reference/carrier-portal/delete-appointment-document.md) - [Delete current carrier claim verification document (v2)](https://docs.getyardo.com/api-reference/carrier-portal/delete-current-carrier-claim-verification-document-v2.md) - [Get appointment message thread](https://docs.getyardo.com/api-reference/carrier-portal/get-appointment-message-thread.md) - [Get carrier appointment details](https://docs.getyardo.com/api-reference/carrier-portal/get-carrier-appointment-details.md) - [Get carrier claim details (v2)](https://docs.getyardo.com/api-reference/carrier-portal/get-carrier-claim-details-v2.md) - [Get carrier portal appointment details](https://docs.getyardo.com/api-reference/carrier-portal/get-carrier-portal-appointment-details.md) - [Get carrier portal appointment status history](https://docs.getyardo.com/api-reference/carrier-portal/get-carrier-portal-appointment-status-history.md) - [Get carrier profile](https://docs.getyardo.com/api-reference/carrier-portal/get-carrier-profile.md) - [Get driver SMS consent status during assignment](https://docs.getyardo.com/api-reference/carrier-portal/get-driver-sms-consent-status-during-assignment.md) - [Get selected carrier profile settings](https://docs.getyardo.com/api-reference/carrier-portal/get-selected-carrier-profile-settings.md) - [Get the active view preference for the current portal user](https://docs.getyardo.com/api-reference/carrier-portal/get-the-active-view-preference-for-the-current-portal-user.md) - [Invite a user to the carrier team](https://docs.getyardo.com/api-reference/carrier-portal/invite-a-user-to-the-carrier-team.md) - [List appointment document requirements and status](https://docs.getyardo.com/api-reference/carrier-portal/list-appointment-document-requirements-and-status.md) - [List appointment documents](https://docs.getyardo.com/api-reference/carrier-portal/list-appointment-documents.md) - [List carrier appointments](https://docs.getyardo.com/api-reference/carrier-portal/list-carrier-appointments.md) - [List carrier fleet assets](https://docs.getyardo.com/api-reference/carrier-portal/list-carrier-fleet-assets.md) - [List carrier fleet drivers](https://docs.getyardo.com/api-reference/carrier-portal/list-carrier-fleet-drivers.md) - [List carrier portal appointment cancellation requests](https://docs.getyardo.com/api-reference/carrier-portal/list-carrier-portal-appointment-cancellation-requests.md) - [List carrier portal appointments (by email or approved carrier claim)](https://docs.getyardo.com/api-reference/carrier-portal/list-carrier-portal-appointments-by-email-or-approved-carrier-claim.md) - [List carrier team invitations for carrier admins](https://docs.getyardo.com/api-reference/carrier-portal/list-carrier-team-invitations-for-carrier-admins.md) - [List carrier team members for carrier admins](https://docs.getyardo.com/api-reference/carrier-portal/list-carrier-team-members-for-carrier-admins.md) - [List carriers linked to the portal user](https://docs.getyardo.com/api-reference/carrier-portal/list-carriers-linked-to-the-portal-user.md) - [List current user's carrier claims (v2)](https://docs.getyardo.com/api-reference/carrier-portal/list-current-users-carrier-claims-v2.md) - [List documents for an appointment](https://docs.getyardo.com/api-reference/carrier-portal/list-documents-for-an-appointment.md) - [List past carrier appointments](https://docs.getyardo.com/api-reference/carrier-portal/list-past-carrier-appointments.md) - [List pending carrier member requests for carrier admins](https://docs.getyardo.com/api-reference/carrier-portal/list-pending-carrier-member-requests-for-carrier-admins.md) - [List reschedule requests for an appointment](https://docs.getyardo.com/api-reference/carrier-portal/list-reschedule-requests-for-an-appointment.md) - [List saved views for the current portal user](https://docs.getyardo.com/api-reference/carrier-portal/list-saved-views-for-the-current-portal-user.md) - [Mint a realtime ticket for appointment thread updates](https://docs.getyardo.com/api-reference/carrier-portal/mint-a-realtime-ticket-for-appointment-thread-updates.md) - [Post message to appointment thread](https://docs.getyardo.com/api-reference/carrier-portal/post-message-to-appointment-thread.md) - [Request access/invite for a facility](https://docs.getyardo.com/api-reference/carrier-portal/request-accessinvite-for-a-facility.md) - [Request carrier claim email verification (v2)](https://docs.getyardo.com/api-reference/carrier-portal/request-carrier-claim-email-verification-v2.md) - [Request or resend driver SMS consent during assignment](https://docs.getyardo.com/api-reference/carrier-portal/request-or-resend-driver-sms-consent-during-assignment.md) - [Resend a carrier team invitation](https://docs.getyardo.com/api-reference/carrier-portal/resend-a-carrier-team-invitation.md) - [Respond to carrier claim info request (v2)](https://docs.getyardo.com/api-reference/carrier-portal/respond-to-carrier-claim-info-request-v2.md) - [Submit a carrier claim (v2)](https://docs.getyardo.com/api-reference/carrier-portal/submit-a-carrier-claim-v2.md) - [Submit carrier claim request](https://docs.getyardo.com/api-reference/carrier-portal/submit-carrier-claim-request.md) - [Update a saved view for the current portal user](https://docs.getyardo.com/api-reference/carrier-portal/update-a-saved-view-for-the-current-portal-user.md) - [Update carrier fleet asset](https://docs.getyardo.com/api-reference/carrier-portal/update-carrier-fleet-asset.md) - [Update carrier fleet driver](https://docs.getyardo.com/api-reference/carrier-portal/update-carrier-fleet-driver.md) - [Update claim contact email and restart automatic verification](https://docs.getyardo.com/api-reference/carrier-portal/update-claim-contact-email-and-restart-automatic-verification.md) - [Update permitted appointment fields](https://docs.getyardo.com/api-reference/carrier-portal/update-permitted-appointment-fields.md) - [Update selected carrier profile settings](https://docs.getyardo.com/api-reference/carrier-portal/update-selected-carrier-profile-settings.md) - [Update the last-used view preference for the current portal user](https://docs.getyardo.com/api-reference/carrier-portal/update-the-last-used-view-preference-for-the-current-portal-user.md) - [Upload a carrier claim verification document (v2)](https://docs.getyardo.com/api-reference/carrier-portal/upload-a-carrier-claim-verification-document-v2.md) - [Upload a document for a booking (tracking ID)](https://docs.getyardo.com/api-reference/carrier-portal/upload-a-document-for-a-booking-tracking-id.md) - [Upload a document for an appointment](https://docs.getyardo.com/api-reference/carrier-portal/upload-a-document-for-an-appointment.md) - [Upload appointment document](https://docs.getyardo.com/api-reference/carrier-portal/upload-appointment-document.md) - [Get portalverify](https://docs.getyardo.com/api-reference/emailverification/get-portalverify.md) - [Get portalinvite](https://docs.getyardo.com/api-reference/invitelink/get-portalinvite.md) - [Confirm driver arrival](https://docs.getyardo.com/api-reference/public-check-in/confirm-driver-arrival.md) - [Confirm driver intent (creates or updates a single exception)](https://docs.getyardo.com/api-reference/public-check-in/confirm-driver-intent-creates-or-updates-a-single-exception.md) - [Get appointment status for a driver session](https://docs.getyardo.com/api-reference/public-check-in/get-appointment-status-for-a-driver-session.md) - [Get location context for kiosk check-in](https://docs.getyardo.com/api-reference/public-check-in/get-location-context-for-kiosk-check-in.md) - [Get status/instructions for a kiosk exception](https://docs.getyardo.com/api-reference/public-check-in/get-statusinstructions-for-a-kiosk-exception.md) - [Issue a driver session token using a check-in token (view-only)](https://docs.getyardo.com/api-reference/public-check-in/issue-a-driver-session-token-using-a-check-in-token-view-only.md) - [Lookup an appointment (no operational side effects on failure)](https://docs.getyardo.com/api-reference/public-check-in/lookup-an-appointment-no-operational-side-effects-on-failure.md) - [Renew a driver session token](https://docs.getyardo.com/api-reference/public-check-in/renew-a-driver-session-token.md) - [Upload an optional attachment for a kiosk help request](https://docs.getyardo.com/api-reference/public-check-in/upload-an-optional-attachment-for-a-kiosk-help-request.md) - [Validate check-in token and get appointment details](https://docs.getyardo.com/api-reference/public-check-in/validate-check-in-token-and-get-appointment-details.md) - [Dock Doors](https://docs.getyardo.com/essentials/dock-doors.md): This guide explains **how to create, configure, and manage dock doors in Yardo**. Dock doors are the primary schedulable resource in the system and directly determine appointment availability and capacity. - [Equipment](https://docs.getyardo.com/essentials/equipment.md): This guide explains **how to configure and manage equipment in Yardo**. Equipment settings allow you to model real operational constraints by defining what resources are required for appointments and how those resources are allocated. - [Holidays](https://docs.getyardo.com/essentials/holidays.md): This guide explains **how to configure holidays in Yardo**. Holidays are used to mark full-day closures that override a location’s normal operating hours. - [Locations](https://docs.getyardo.com/essentials/locations.md): This guide explains **how to create, configure, and manage locations in Yardo**. Locations represent physical facilities and define the operational boundaries for scheduling, time zones, and capacity. - [Maintenance Windows](https://docs.getyardo.com/essentials/maintenance-windows.md): This guide explains **how to schedule and manage maintenance windows in Yardo**. Maintenance windows temporarily reduce availability by blocking scheduling capacity during planned downtime. - [Public Booking](https://docs.getyardo.com/essentials/public-booking.md): This guide explains **how to configure public booking access and booking form behavior for a facility**. Booking access settings determine **who can request appointments**, how those requests are validated, and what information is required before a request enters your scheduling workflow. - [Scheduling Appointments](https://docs.getyardo.com/essentials/scheduling-appointments.md): This guide explains how to create and manage appointments in Yardo using the internal appointment form. Appointments can be created from the main navigation or directly from the schedule page. - [Users & Roles](https://docs.getyardo.com/essentials/users-and-roles.md): This guide explains **how to manage users, roles, and permissions in Yardo**. It is intended for administrators responsible for configuring access across the organization. - [Zones](https://docs.getyardo.com/essentials/zones.md): This guide explains **how to create and manage zones in Yardo**. Zones allow you to group dock doors within a location and apply shared operational rules such as specialization and capacity limits. - [Carrier Portal Getting Started](https://docs.getyardo.com/generated/carriers/carrier-portal-getting-started.md): How carrier users access and use the Yardo carrier portal. - [Driver Check-In](https://docs.getyardo.com/generated/drivers/driver-check-in-design.md): How Yardo driver check-in works through deep links, SMS, and QR flows. - [Welcome to Yardo](https://docs.getyardo.com/index.md): Yardo is a modern dock scheduling platform built for warehouse and distribution teams that want to eliminate spreadsheets, emails, and manual coordination with carriers. - [Initial Setup](https://docs.getyardo.com/initial-setup.md): Follow these steps to get Yardo ready for daily operations. Once complete, you can begin scheduling appointments immediately. - [Key Concepts](https://docs.getyardo.com/key-concepts.md): The concepts below define Yardo’s data model and operational structure. Understanding how they relate to one another will help you configure the system correctly and operate it efficiently at scale. ## OpenAPI Specs - [openapi](https://docs.getyardo.com/api-reference/openapi.json)