v1

latestOpenAPI 3.1.02026-08-0630894634.3 KB
Trips

Get trip

Retrieves trip info by ID. {% admonition type="warning" name="Deprecation notice" %} The Get Trip /v2/trips/{tripId} endpoint has been deprecated. Use the new Get trip details /v3/trips/{tripId}/detail endpoint instead. {% /admonition %}

get/v2/trips/{tripId}

Response

OK

tripIdstring required

Spotnana trip Id

tripNamestring required

Name of the trip

tripDescriptionstring

Trip description

applicationIdstring uuid

Application id used for the trip.

stealthType'STEALTH_TYPE_1' | 'STEALTH_TYPE_2' | 'STEALTH_TYPE_3'

Stealth type.

Example response

{
  "tripId": "6926658168",
  "tripName": "JFK SFO Trip",
  "tripDescription": "JFK SFO Business Trip",
  "startDate": {
    "iso8601": "2017-07-21"
  },
  "endDate": {
    "iso8601": "2017-07-21"
  },
  "tripMetadata": {
    "hasTripOverride": true,
    "preferredCurrency": "USD",
    "tripContacts": [
      {
        "label": "Coordinator",
        "name": "Himani Jain",
        "email": "himani@spotnana.com",
        "phoneNumber": {
          "countryCode": 91,
          "countryCodeSource": "FROM_NUMBER_WITH_PLUS_SIGN",
          "extension": "222",
          "isoCountryCode": "IN",
          "italianLeadingZero": true,
          "nationalNumber": 8150,
          "numberOfLeadingZeros": 1,
          "preferredDomesticCarrierCode": "7",
          "rawInput": "77777",
          "type": "MOBILE"
        },
        "isPrimary": true,
        "restrictVisibility": true
      }
    ],
    "tripCommunicationPreferences": {
      "tripEmailPreferences": {
        "bucketEmailPreferences": {
          "bucketTypes": [
            "BOOKING_CONFIRMATIONS"
          ],
          "toEmails": [
            "example@email.com"
          ],
          "ccEmails": [
            "example@email.com"
          ],
          "bccEmails": [
            "example@email.com"
          ]
        }
      }
    }
  },
  "stealthType": "STEALTH_TYPE_1",
  "stealthMode": {
    "stealthType": "STEALTH_TYPE_1"
  },
  "tripLocations": [
    {
      "metroAreaName": "San Francisco"
    }
  ]
}