> ## Documentation Index > Fetch the complete documentation index at: https://docs.grdd.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get Reservation by Reservation ID > Retrieve a reservation snapshot by GRiDD ID and Reservation # Do **not** call this endpoint in a loop or on a timer — that's what [webhooks](/platform-api/reference/webhook-callbacks) are for. ## OpenAPI ````yaml platform-api/openapi.json GET /getReservationByReservationId/{GRIDDID}/{RESERVATIONID}/{version} openapi: 3.1.0 info: title: GNet Platform API description: >- RESTful API for exchanging ground transportation reservations over the GNet Platform (Platform.svc). Requesters send (farm-out) reservations; providers receive (farm-in) reservations and push status updates back. version: V1 contact: name: GRiDD Support email: support@grdd.net servers: - url: https://api.grdd.net/Platform.svc description: Production security: - tokenAuth: [] tags: - name: Authentication description: Obtain and release security tokens - name: Reservations description: Submit, retrieve, cancel, and retry reservations - name: Provider Updates description: Provider systems push status changes to GNet - name: Tracking description: Real-time chauffeur/vehicle location paths: /getReservationByReservationId/{GRIDDID}/{RESERVATIONID}/{version}: get: tags: - Reservations summary: 'Get reservation by Reservation #' description: >- Requesters can get the latest snapshot of a reservation they submitted, given their GRiDD ID and Reservation #. Do **not** poll this endpoint — use webhook callbacks for updates. operationId: getReservationByReservationId parameters: - $ref: '#/components/parameters/griddId' - name: RESERVATIONID in: path required: true description: 'Reservation # of the requester.' schema: type: string - $ref: '#/components/parameters/version' responses: '200': description: Latest reservation snapshot content: application/json: schema: $ref: '#/components/schemas/Reservation' '401': $ref: '#/components/responses/Unauthorized' components: parameters: griddId: name: GRIDDID in: path required: true description: GRiDD ID. schema: type: string version: name: version in: path required: true description: API version. Must be set to `V1`. schema: type: string enum: - V1 schemas: Reservation: type: object description: >- The GNet reservation payload. See the Object Model reference for full field-by-field documentation. Dates/times in location sections are local to the pickup location, format YYYY-MM-DDTHH:mm:ss. required: - affiliateReservation - locations - passengerCount - passengers - preferredVehicleType - reservationType properties: affiliateReservation: $ref: '#/components/schemas/AffiliateReservation' locations: $ref: '#/components/schemas/Locations' passengerCount: type: string description: Number of passengers. example: '1' passengers: type: array items: $ref: '#/components/schemas/Passenger' preferredVehicleType: type: string description: Requested vehicle type. See the Vehicle Types reference. example: SEDAN preferredChauffeurNo: type: string description: ID of preferred chauffeur. reservationType: type: string enum: - REGULAR - ONDEMAND - QUOTE description: >- Reservation type. QUOTE requests return pricing without creating a reservation. runType: type: string enum: - TRANSPORT - AIRPORT - HOURLY description: Run type. status: type: string description: Status code of the reservation. example: BOOKING_REQUEST reservationDate: type: string description: Date the reservation was created, local time, YYYY-MM-DDTHH:mm:ss. specialInstructions: type: string description: Trip notes and instructions. totalAmount: type: string description: Estimated total cost of trip. totalTripDuration: type: string description: Trip duration in minutes. For hourly trips, the estimated minutes. totalTripDist: type: string description: Total trip distance. namesignInstructions: type: string description: Name sign instructions. namesignURL: type: string description: URL for the name sign. luggageCount: type: string description: Number of pieces of luggage. meetAndGreet: type: string description: Meet and greet instructions. operatorId: type: string description: Operator ID. origination: type: string description: Trip origination code or identifier. submissionTarget: type: string description: Target for submission. transactionId: type: string description: >- Required when updating a reservation. Leave blank for NEW reservations. submitMode: type: string description: >- Set to WAIT to process synchronously and wait for the result. Leave blank otherwise. example: WAIT fees: type: array description: Charge line items. items: $ref: '#/components/schemas/Fee' notes: type: array description: Affiliate notes. items: $ref: '#/components/schemas/Note' account: $ref: '#/components/schemas/Account' AffiliateReservation: type: object description: >- Header section of the payload: GNet member IDs of the sender and receiver, their reservation numbers, and the command field. required: - action - requesterId - providerId - requesterResNo properties: action: type: string enum: - NEW - UPDATE - CANCEL description: Command field telling GNet what the payload is for. requesterId: type: string description: GRiDD ID of requester. example: 5StarLimo providerId: type: string description: GRiDD ID of provider. example: littlestarLimo requesterResNo: type: string description: Reservation number of requester. example: '22121' providerResNo: type: string description: >- Reservation number of provider. Required for UPDATE and CANCEL. Fills in once a reservation is successfully submitted. status: type: string description: >- Status code of reservation. On a communication error this is set to FAILED. Locations: type: object required: - pickup - dropOff properties: pickup: $ref: '#/components/schemas/Location' dropOff: $ref: '#/components/schemas/Location' stops: type: array description: Intermediate stops. items: $ref: '#/components/schemas/Location' Passenger: type: object required: - firstName - lastName - phones properties: firstName: type: string lastName: type: string middleName: type: string alias: type: string description: Passenger's alias name. email: type: string accountNumber: type: string description: Customer ID / Account number in the system. phoneNumber: type: string description: Primary phone number. phones: type: array items: $ref: '#/components/schemas/Phone' imageURL: type: string description: URL for passenger image/photo. active: type: string description: Active status of passenger. commentsForDispatcher: type: string commentsForDriver: type: string defaultLanguage: type: string defaultTimezone: type: string Fee: type: object properties: code: type: string example: base currency: type: string example: USD description: type: string example: Base charges fee: type: string example: '75.00' percent: type: - string - 'null' reimbursable: type: - string - 'null' type: type: string description: Fee type, e.g. CHARGE, EXPENSE, EXTRA_SERVICE. example: EXPENSE Note: type: object properties: context: type: string description: Should be set to AFFILIATE. example: AFFILIATE message: type: string description: Actual notes and instructions from the affiliate. user: type: string description: Optional user ID of the person sending the message. status: type: string Account: type: object description: Account information of the SENDER in the RECEIVER system. properties: accountNumber: type: string description: >- Customer ID / Account Number of the SENDER in the RECEIVER system. If present it is used; otherwise the PROVIDER setting for this relationship is used. accountName: type: string description: Name of the SENDER. callerName: type: string callerEmail: type: string callerNumber: type: string Location: type: object required: - locationType - address - address1 - city - state - zipCode - country properties: locationType: type: string enum: - ADDRESS - AIRPORT description: Location type. time: type: string description: >- Local time at the pickup location, YYYY-MM-DDTHH:mm:ss. Required on pickup. example: '2016-04-13T19:15:00' address: type: string description: >- Full one-line address. For airport trips, the 3-character IATA airport code goes into this field. address1: type: string description: Street address. address2: type: string description: Street address 2. city: type: string state: type: string zipCode: type: string description: Zip / Postal code. country: type: string lat: type: - string - 'null' description: Latitude. lon: type: - string - 'null' description: Longitude. landmark: type: string description: Landmark name for the address. FBO: type: string description: Set to True if the airport is an FBO; blank otherwise. specialInstructions: type: string description: Notes and instructions for this location. pointOnLocation: type: string description: Point-on-location instructions (e.g. call 10 minutes out). meetAndGreet: type: - string - 'null' description: Meet and greet instructions. stopNumber: type: string description: Order of the stop (stops only). flightInfo: $ref: '#/components/schemas/FlightInfo' Phone: type: object required: - number - type properties: number: type: string example: '+12122221212' type: type: string enum: - mobile - landline attributes: type: - object - 'null' properties: sendNotification: type: string description: Whether to send notifications to this phone. visibleToPassenger: type: string description: Whether the phone is visible to the passenger. FlightInfo: type: - object - 'null' description: Flight information. Required for airport trips. properties: airlineCode: type: string description: 2-character IATA airline code. Code 00 indicates an FBO. example: UA flightNumber: type: string description: Flight number. Leave empty if unknown — do not use TBD. example: '2323' responses: Unauthorized: description: Unauthorized — missing or invalid `token` header securitySchemes: tokenAuth: type: apiKey in: header name: token description: Security token obtained from `getToken2`. ````