Introduction

Welcome to the YouLi Travel API! You can use our API to access YouLi API endpoints, which can get information on various trips.

Authentication

curl -X POST \
  https://youli.io/token \
  -d 'grant_type=password&username=your_username&password=your_password'

{
    "access_token": "meowmeowmeow",
    "token_type": "bearer",
    "expires_in": 1209599,
    "userName": "your_username",
    ".issued": "Thu, 22 Feb 2018 00:22:59 GMT",
    ".expires": "Thu, 08 Mar 2018 00:22:59 GMT"
}

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: bearer meowmeowmeow"

YouLi uses Bearer authentication (also called token authentication) to authorize access to the system.

To gain a token, send a POST request to (see example code for parameters):

POST https://youli.io/token

YouLi then expects the provided token to be included in all API requests to the server in a header that looks like the following:

Authorization: bearer meowmeowmeow

Tokens will expire after 1 hour, at which time a new token must be requested.

You must replace meowmeowmeow with your acquired token.

Pagination Headers

Additional pagination information is returned in the response headers.

The X-Paging-Per-Page and X-Paging-Total headers give the number of elements returned on each page and the total number of elements respectively.

Error reporting note

In the case of an error due to a malformed or invalid input (400 Bad Request response), an email will be sent to the registered API Alert Email on the account.

Open a Support Request if you are not already receiving these alerts.

Trips

Get All Trips

curl "https://youli.io/api/trip/gettrips"
  -H "Authorization: bearer meowmeowmeow"

{
  "Total": 2,
  "Results":
  [
    {
      "TripName": "Saturn In The Summertime",
      "TripLink": "https://youli.io/t/mystic-adventures/saturn-trip",
      "TripPrimaryLocation": "Paris, France",
      "TripBannerURL": "https://ylt-images.imgix.net/b25b6ceb-7b8c-47db-b403-8a5ff4b7988f%2F899e3c52-a676-ec11-94f6-00155d69ec04%2F2ae91d79-4681-4e55-8337-bf69a42d9351Epic Destination Wedding - 2016-05-14 22.54.28 (jenahmadwe...).jpeg?fit=crop&crop=entropy&h=525&w=1500&auto=format&dpr=2&q=40",
      "TripStartDateUTC": null, 
      "TripEndDateUTC": null, 
      "TripDates": "",
      "TripDuration": "1 Saturn Year",
      "TripCurrencyCode": "AUD",
      "TripCost": "A$1",
      "TripParticipantsCount": 2,
      "TripShareSummary": "Lorem ipsum dolor sit amet, consec tetur adipiscing elit.",
      "ShowItineraryLink": false,
      "ItineraryLabel": "Travel Itinerary",
      "CTAText": "YES",
      "PlannerProfileLinkURL": "https://web.youli.io/u/mystic-adventures",
      "PlannerFullName": "Mystic Adventures",
      "PlannerAvatarURL": "https://ylt-images.imgix.net/app/landscape-two@2x.jpg?fit=crop&crop=faces&h=150&w=150",
      "BusinessPrimaryColour": "#ff0000",
      "BusinessPrimaryTextColour": "#000000",
      "BusinessPrimaryFont": "Montserrat",
      "TripLastUpdateDateUTC": "2017-11-27T10:11:26.88",
      "TripID": "7749446b-f787-ec11-a507-0050f222899f",
      "TourSeries": null,
      "TourType": "Trip",
      "LinkedTrips": {
        "MainTripID": null,
        "PreTripID": null,
        "PostTripID": null
      },
      "TripPackages": [
        {
          "Id": "ca7f107d-4202-4e74-87af-26af4b3d83d8",
          "Price": 1400.00,
          "FeesAndTaxesAmount": 0.00,
          "Label": "Suite",
          "MaxNumberBookings": 0,
          "RequiredGroupSize": 0,
          "NumTravellers": 0,
          "Visibility": "published",
          "Description": null,
          "UrgencyLabel": null,
          "Rooms": [
              {
                  "Id": "2c9b6a9a-aaa5-487e-8ce6-1dace84ffb4d",
                  "Name": "409"
              },
              {
                  "Id": "ab223421-785d-409a-9aef-c56a8f6e370c",
                  "Name": "410"
              },
              {
                  "Id": "4af16d49-122a-447f-93bc-9ffa59cb46c6",
                  "Name": "411"
              },
              {
                  "Id": "b61e9dc4-f634-4e83-bd4b-ff8d14a293f6",
                  "Name": "412"
              }
          ],
          "PerPersonPrice": 1400.00,
          "BookingNumbers": 0,
          "IsAvailable": true
        },
      ],
      "Installments": []
    },
    {
      "TripName": "Summer is the best",
      "TripLink": "https://youli.io/t/mystic-adventures/summer-is-the-best",
      "TripPrimaryLocation": "summer",
      "TripBannerURL": "https://ylt-images.imgix.net/b25b6ceb-7b8c-47db-b403-8a5ff4b7988f%2F899e3c52-a676-ec11-94f6-00155d69ec04%2F2ae91d79-4681-4e55-8337-bf69a42d9351Epic Destination Wedding - 2016-05-14 22.54.28 (jenahmadwe...).jpeg?fit=crop&crop=entropy&h=525&w=1500&auto=format&dpr=2&q=40",
      "TripStartDateUTC": "2022-03-11T13:00:00",
      "TripEndDateUTC": "2022-03-15T13:00:00",
      "TripDates": "Sat 12 Mar 2022 <span class=\"time\"> </span> - Fri 8 Apr  <span class=\"time\"></span>",
      "TripDuration": "28 days",
      "TripCurrencyCode": "JPY",
      "TripCost": "¥30,000",
      "TripParticipantsCount": 1,
      "TripShareSummary": null,
      "ShowItineraryLink": true,
      "ItineraryLabel": "Itinerary",
      "CTAText": "Yes please",
      "PlannerProfileLinkURL": "https://web.youli.io/u/mystic-adventures",
      "PlannerFullName": "Mystic Adventures",
      "PlannerAvatarURL": "https://ylt-images.imgix.net/app/landscape-two@2x.jpg?fit=crop&crop=faces&h=150&w=150",
      "BusinessPrimaryColour": "#ff0000",
      "BusinessPrimaryTextColour": "#000000",
      "BusinessPrimaryFont": "Montserrat",
      "TripLastUpdateDateUTC": "2017-11-07T07:21:35.573",
      "TripID": "7a32048e-9f88-ec11-a507-0050f222899f",
      "TourSeries": {
        "Id": "0d005ac6-48a6-ec11-8716-c4236085fe66",
        "Name": "Season Tours"
      },
      "TourType": "Main",
      "LinkedTrips": {
        "MainTripID": "7a32048e-9f88-ec11-a507-0050f222899f",
        "PreTripID": "3f1e71a2-489f-e711-8305-985fd3437709",
        "PostTripID": null
      },
      "TripPackages": [
        {
          "Id": "e4eac556-7d35-4f7c-acc5-636b62139357",
          "Price": 800.00,
          "FeesAndTaxesAmount": 0.00,
          "Label": "Standard package",
          "MaxNumberBookings": 4,
          "RequiredGroupSize": 0,
          "NumTravellers": 0,
          "Visibility": "published",
          "Description": null,
          "UrgencyLabel": null,
          "Rooms": [],
          "PerPersonPrice": 800.00,
          "BookingNumbers": 4,
          "IsAvailable": false
        },
      ],
      "Installments": [
        {
          "Id": "9b1e71a2-489f-e711-8305-985fd3437709",
          "Label": "Deposit",
          "IsRemindersEnabled": true,
          "Type": "fixed",
          "DueDateType": "specific",
          "DueDateUTC": "2022-01-15T00:00:00"
        },
        {
          "Id": "1c2e71a2-489f-e711-8305-985fd3437709",
          "Label": "Balance",
          "IsRemindersEnabled": true,
          "Type": "fixed",
          "DueDateType": "relative",
          "DueDateUTC": null
        }
      ]
    }
  ]
}

This authenticated endpoint retrieves all public + listed (not archived) trips, which have have a start date in the future or have estimated dates, based on the provided query parameters.

See the Usage Guide for more information.

HTTP Request

GET https://youli.io/api/trip/gettrips

URL Parameters

Parameter	Default	Is Optional	Description
start_date	One day ago	Yes	Start date in UTC time zone (UTC). Will match +/- 1 day
end_date		Yes	End date in UTC time zone (UTC). Will match +/- 1 day
location		Yes	Direct match against primary location
price_start	0	Yes	Lower limit on price range to search. If provided, will only return trips with final prices (not ranges)
price_end	no limit	Yes	Upper limit on price range to search. If provided, will only return trips with final prices (not ranges)
tag		Yes	Comma separated list of trip tags - ALL of them must match for a trip to be returned (ie., "AND" logic)
currency		Yes	If provided, will only return trips priced in the chosen currency (e.g. AUD, USD, GBP)
page	1	Yes	Page number to retrieve
page_size	10	Yes	Number of items per page

Results

Returns a list of Trip objects.

Visibility on TripPackage objects returns the following values:

Visibility	Description
published	Published
disabled	Disabled
hiddenfrompublic	Hidden From Travellers

Get Trip Invitees

curl "https://youli.io/api/trip/getinvitees"
  -H "Authorization: bearer meowmeowmeow"

{
  "Total": 2,
  "Results":
  [
    {
        "Id": "dbc0945e-43fe-e611-82bb-985fd335920c",
        "FullName": "Example Invitee",
        "FirstName": "Example",
        "LastName": "Invitee",
        "Email": "example@example.com",
        "PhoneNumber": "44443333",
        "BillToFirstName": "Example",
        "BillToLastName": "Invitee",
        "BillToStreetLine1": "100 Some Street",
        "BillToStreetLine2": null,
        "BillToCity": "Melbourne",
        "BillToCountry": "Australia",
        "BillToState": "Victoria",
        "BillToPostCode": "3000",
        "AvatarURL": "https://ylt-images.imgix.net/app/invitees-icon@2x.png?fit=crop&crop=faces&h=150&w=150",
        "MiniBio": "Bio sample",
        "RegistrationStatus": 1,
        "RegistrationDateReceivedUTC": "2025-08-12T23:14:03.007",
        "RegistrationNote": "Example registration note",
        "ResponseDietaryRequirement": "Vegetarian",
        "PlannerNote": "Planner notes may be here",
        "TransferredFromInviteeId": "26e5179e-4ea7-47ac-b53c-9bdcd61a38d3",
        "InvitationGroup": "groupname",
        "InvitationGroupMembers": [
          {
            "FullName": "Sample Friend",
            "FirstName": "Sample",
            "LastName": "Friend",
            "Email": "friend@example.com"
          },
          {
            "FullName": "Second Friend",
            "FirstName": "Second",
            "LastName": "Friend",
            "Email": "second@example.com"
          }
        ],
        "NumberInGroup": 2,
        "Category": "Invitee Category",
        "ReferenceCode": "TNSHYVC8Y6",
        "PackageName": "Standard Package",
        "PackageCode": "Deluxe",
        "PackageFeesAndTaxesAmount": 20.00,
        "BasePrice": 1256.25,
        "Room": null,
        "AmountOwing": 837.542,
        "TripId": "341e71a2-489f-e711-8305-985fd3437709",
        "TripName": "Saturn In The Summertime",
        "TripAlias": "saturn-trip",
        "TripRegistrationButtonLabel": "OK sure",
        "TripTags": [
          "Culinary",
          "Fundraising"
        ],
        "MagicLink": "https://youli.io/t/ahmad/saturn-trip/06826297-91eb-4e37-806b-70c1a08f657b",
        "TrackingSource": null,
        "TrackingMedium": null,
        "TrackingCampaign": null,
        "Payments": [
            {
                "Id": "8de4ef98-7821-497b-8a9d-916d893f67a2",
                "Amount": 100.0,
                "Currency": "USD",
                "Method": "offline",
                "Description": "Sample payment",
                "Status": "successful",
                "PaymentDateUTC": "2022-06-02T03:16:44.6720722Z",
                "YouLiFeeAmount": 0.0,
                "YouLiFeeCurrency": null,
                "CreditCardSurchargeAmount": 0.0,
                "CreditCardSurchargeCurrency": "USD",
                "RefundProtectSurchargeAmount": 0.0,
                "RefundProtectSurchargeCurrency": "USD",
                "Allocations": [
                    {
                        "Id": "00000000-0000-0000-0000-000000000000",
                        "FullName": "Example Invitee",
                        "FirstName": "Example",
                        "LastName": "Invitee",
                        "Amount": 100.0,
                        "Installment": null
                    }
                ]
            }
        ],
        "TaskResponses": [
            {
                "Id": "9d9d6b45-5156-ed11-8738-c4236085fe66",
                "TaskId": "c6a6ccc0-dc49-ed11-8735-c4236085fe66",
                "TaskName": "Give us more details",
                "TaskResponseType": 8,
                "TaskResponseDateUTC": "2025-11-21T00:52:06.33",
                "TaskResponseReviewRequired": true,
                "TaskResponseReviewedDateUTC": "2025-11-21T01:26:02.9566667",
                "ResponseValue": "",
                "HasFields": true,
                "FieldResponses": [
                    {
                        "APIFieldName": "AGE",
                        "FieldLabel": "How old are you?",
                        "FieldResponseValue": "34"
                    },
                    {
                        "APIFieldName": "DOCTOR_NAME",
                        "FieldLabel": "Who is your doctor?",
                        "FieldResponseValue": "Dr Bond"
                    }
                ]
            }
          ]
    }
  ]
}

This authenticated endpoint retrieves all invitees (people/travelers) on a specified trip. If an invitee ID is provided as well, then it will return just the specified invitee.

If the trip has been archived, a 400 (Bad Request) error will be returned.

HTTP Request

GET https://youli.io/api/trip/getinvitees

URL Parameters

Parameter	Default	Is Optional	Description
tripid		No	Id of a given trip
inviteeid		Yes	Id of an invitee on the given trip
page	1	Yes	Page number to retrieve
page_size	10	Yes	Number of items per page

Results

Returns a list of TripRegistration objects.

RegistrationStatus returns the following values:

RegistrationStatus	Description
0	Invited
1	Registered
3	Declined
4	Transferred
5	Approved
6	Waitlisted

Note: "2" is not currently a valid status.

TaskResponseType returns the following values:

TaskResponseType	Description
0	Radio Button (Yes/No)
1	Checkbox (Done)
2	Select only one value
3	Date picker only
4	Date + time picker
5	Document(s) Upload
6	Input box (Comment)
7	Passport form + Upload
8	Custom form (build your own)
9	Select all that apply
10	Profile & Registration Form

Get Invitee Itinerary Items

curl "https://youli.io/api/trip/getinviteeitineraryitems"
  -H "Authorization: bearer meowmeowmeow"

{
    "Total": 2,
    "Warnings": [],
    "Results": [
        {
            "ItemId": "9d19c374-d7bc-ef11-88cf-00224877e374",
            "AssociatedTripId": "8119c374-d7bc-ef11-88cf-00224877e374",
            "ItemName": "Highlight Item",
            "ItemDescriptionHTML": "<p>Some description might be here</p>",
            "ItemIsHighlight": true,
            "ItemResponseDueDateUTC": null,
            "ItemImageURL": "https://ylt-images.imgix.net/app/default-itinerary-item.jpg&fm=pjpg?auto=format",
            "StartDateTimeUTC": null,
            "EndDateTimeUTC": null,
            "HasTimeComponent": false,
            "LocationDetails": null,
            "IsCancelled": false,
            "IsArchived": false,
            "ItemVisibilityType": 1,
            "ItemVisibilityList": "dbc0945e-43fe-e611-82bb-985fd335920c",
            "StartDay": null,
            "EndDay": null,
            "Latitude": null,
            "Longitude": null,
            "ItemSortOrder": 1,
            "StartTimeZone": null,
            "EndTimeZone": null,
            "PricingModel": 1,
            "PriceLabel": "",
            "AddOnPrice": 30.00,
            "ItemDueRelativeToDate": false,
            "ItemRelativeDateSelection": null,
            "ItemDaysDueRelative": null,
            "Responses": [
                {
                    "ItemResponseId": "6f035e3d-dbbc-ef11-88cf-00224877e374",
                    "RespondByInviteeId": "dbc0945e-43fe-e611-82bb-985fd335920c",
                    "InviteeResponseValue": 1
                }
            ]
        },
        {
            "ItemId": "9e19c374-d7bc-ef11-88cf-00224877e374",
            "AssociatedTripId": "8119c374-d7bc-ef11-88cf-00224877e374",
            "ItemName": "Itinerary item",
            "ItemDescriptionHTML": "<p>Anoher item description</p>",
            "ItemIsHighlight": false,
            "ItemResponseDueDateUTC": null,
            "ItemImageURL": "https://ylt-images.imgix.net/app/default-itinerary-item.jpg&fm=pjpg?auto=format",
            "StartDateTimeUTC": "2025-05-23T14:00:00",
            "EndDateTimeUTC": "2025-05-23T14:00:00",
            "HasTimeComponent": false,
            "LocationDetails": null,
            "IsCancelled": false,
            "IsArchived": false,
            "ItemVisibilityType": 0,
            "ItemVisibilityList": "",
            "StartDay": null,
            "EndDay": null,
            "Latitude": null,
            "Longitude": null,
            "ItemSortOrder": null,
            "StartTimeZone": null,  
            "EndTimeZone": null,
            "PriceLabel": "",
            "PricingModel": 1,
            "AddOnPrice": 10.00,
            "ItemDueRelativeToDate": false,
            "ItemRelativeDateSelection": null,
            "ItemDaysDueRelative": null,
            "Responses": [
                {
                    "ItemResponseId": "71035e3d-dbbc-ef11-88cf-00224877e374",
                    "RespondByInviteeId": "dbc0945e-43fe-e611-82bb-985fd335920c",
                    "InviteeResponseValue": 1
                }
            ]
        }
    ]
}

This authenticated endpoint retrieves all highlights and itinerary items to which a specified invitee has responded "Registered" or "Declined". If an itineraryitemid value is provided as well, then it will return just the specified item, with the specified invitee's response.

If the Tripid or InviteeId are missing, a 404 (Not Found) error will be returned.

If invalid values are provided for the Guid parameters, a 500 (Server Error) error will be returned

HTTP Request

GET https://youli.io/api/trip/getinviteeitineraryitems

URL Parameters

Parameter	Is Optional	Description
tripid	No	Id of a given trip
inviteeid	No	Id of an invitee on the given trip
itineraryitemid	Yes	Id of an itinerary or highlight item on the trip

Results

Returns a list of ItineraryItem objects.

PricingModel returns the following values:

PricingModel	Description
0	Included
1	Add-on
2	Optional

AddOnRelativeType returns the following values:

AddOnRelativeType	Description
0	After Booking

InviteeResponseValue in Responses objects returns the following values:

InviteeResponseValue	Description
0	Invited
1	Registered
3	Declined

Note: "2" is not currently a valid status.

ItemVisibilityType on returns the following values:

Visibility	Description
0	Everyone
1	Show only to selected invitees (see `ItemVisibilityList` for list)
2	Show everyone except selected People (see `ItemVisibilityList` for list)

ItemVisibilityList is a list of invitee Ids to include/exclude, depending on visibility type. If the item's visibility is set to "Show only to selected Categories" then the list of invitee Ids returned in this property will be all those who are in one of the given categories.

Future Trips Lookup

curl "https://youli.io/api/trip/futuretripslookup"
  -H "Authorization: bearer meowmeowmeow"

[
  {
    "id": "341e71a2-489f-e711-8305-985fd3437709",
    "name": "Saturn In The Summertime"
  },
  {
    "id": "81421fbc-dfb9-e711-8309-985fd3437709",
    "name": "Summer is the best"
  }
]

This authenticated endpoint retrieves all future trips (public or private) for the authenticated user.

HTTP Request

GET https://youli.io/api/trip/futuretripslookup

Results

Returns a lookup style list of future trips, simply providing the Id and Name (for use in dropdowns and the like).

Recent Invitees

curl "https://youli.io/api/trip/getrecentinviteesorexample"
  -H "Authorization: bearer meowmeowmeow"

[
    {
        "Id": "dbc0945e-43fe-e611-82bb-985fd335920c",
        "FullName": "Example Invitee",
        "FirstName": "Example",
        "LastName": "Invitee",
        "Email": "example@example.com",
        "PhoneNumber": "44443333",
        "BillToFirstName": "Example",
        "BillToLastName": "Invitee",
        "BillToStreetLine1": "100 Some Street",
        "BillToStreetLine2": null,
        "BillToCity": "Melbourne",
        "BillToCountry": "Australia",
        "BillToState": "Victoria",
        "BillToPostCode": "3000",
        "AvatarURL": "https://ylt-images.imgix.net/app/invitees-icon@2x.png?fit=crop&crop=faces&h=150&w=150",
        "MiniBio": "Bio sample",
        "RegistrationStatus": 1,
        "RegistrationDateReceivedUTC": "2025-08-12T23:14:03.007",
        "RegistrationNote": "Example registration note",
        "ResponseDietaryRequirement": "Vegetarian",
        "PlannerNote": "Planner notes may be here",
        "TransferredFromInviteeId": null,
        "InvitationGroup": "groupname",
        "InvitationGroupMembers": [
          {
            "FullName": "Sample Friend",
            "FirstName": "Sample",
            "LastName": "Friend",
            "Email": "friend@example.com"
          },
          {
            "FullName": "Second Friend",
            "FirstName": "Second",
            "LastName": "Friend",
            "Email": "second@example.com"
          }
        ],
        "NumberInGroup": 2,
        "Category": "Invitee Category",
        "ReferenceCode": "TNSHYVC8Y6",
        "PackageName": "Standard Package",
        "PackageCode": "Deluxe",
        "PackageFeesAndTaxesAmount": 20.00,
        "BasePrice": 1256.25,
        "Room": null,
        "AmountOwing": 837.542,
        "TripId": "341e71a2-489f-e711-8305-985fd3437709",
        "TripName": "Saturn In The Summertime",
        "TripAlias": "saturn-trip",
        "TripRegistrationButtonLabel": "OK sure",
        "MagicLink": "https://youli.io/t/ahmad/saturn-trip/06826297-91eb-4e37-806b-70c1a08f657b",
        "TrackingSource": null,
        "TrackingMedium": null,
        "TrackingCampaign": null,
        "Payments": [
            {
                "Id": "8de4ef98-7821-497b-8a9d-916d893f67a2",
                "Amount": 100.0,
                "Currency": "USD",
                "Method": "offline",
                "Description": "Sample payment",
                "Status": "successful",
                "PaymentDateUTC": "2022-06-02T03:16:44.6720722Z",
                "YouLiFeeAmount": 0.0,
                "YouLiFeeCurrency": null,
                "CreditCardSurchargeAmount": 0.0,
                "CreditCardSurchargeCurrency": "USD",
                "RefundProtectSurchargeAmount": 0.0,
                "RefundProtectSurchargeCurrency": "USD",
                "Allocations": [
                    {
                        "Id": "00000000-0000-0000-0000-000000000000",
                        "FullName": "Example Invitee",
                        "FirstName": "Example",
                        "LastName": "Invitee",
                        "Amount": 100.0,
                        "Installment": null
                    }
                ]
            }
        ],
        "TaskResponses": [
            {
                "Id": "9d9d6b45-5156-ed11-8738-c4236085fe66",
                "TaskId": "c6a6ccc0-dc49-ed11-8735-c4236085fe66",
                "TaskName": "Give us more details",
                "TaskResponseType": 8,
                "TaskResponseDateUTC": "2025-11-21T00:52:06.33",
                "TaskResponseReviewRequired": true,
                "TaskResponseReviewedDateUTC": "2025-11-21T01:26:02.9566667",
                "ResponseValue": "",
                "HasFields": true,
                "FieldResponses": [
                    {
                        "APIFieldName": "AGE",
                        "FieldLabel": "How old are you?",
                        "FieldResponseValue": "34"
                    },
                    {
                        "APIFieldName": "DOCTOR_NAME",
                        "FieldLabel": "Who is your doctor?",
                        "FieldResponseValue": "Dr Bond"
                    }
                ]
            }
          ]
    }
]

This authenticated endpoint retrieves the last 10 invitees who registered for a given trip, or an example ("dummy") invitee if there are no invitees yet on the trip. If no Trip ID parameter is provided, it will return the last 10 invitees from the most recently updated trip. It can be used for testing other API endpoints (e.g. by Zapier).

HTTP Request

GET https://youli.io/api/trip/getrecentinviteesorexample

URL Parameters

Parameter	Default	Is Optional	Description
tripid		Yes	Id of a given trip

Results

Returns a list of TripRegistration objects.

RegistrationStatus returns the following values:

RegistrationStatus	Description
0	Invited
1	Registered
3	Declined
4	Transferred
5	Approved
6	Waitlisted

Note: "2" is not currently a valid status.

TaskResponseType returns the following values:

TaskResponseType	Description
0	Radio Button (Yes/No)
1	Checkbox (Done)
2	Select only one value
3	Date picker only
4	Date + time picker
5	Document(s) Upload
6	Input box (Comment)
7	Passport form + Upload
8	Custom form (build your own)
9	Select all that apply
10	Profile & Registration Form

Recent Payments

curl "https://youli.io/api/trip/getpaymentsorexample"
  -H "Authorization: bearer meowmeowmeow"

[
    {
        "Id": "dbc0945e-43fe-e611-82bb-985fd335920c",
        "FullName": "Example Invitee",
        "FirstName": "Example",
        "LastName": "Invitee",
        "Email": "example@example.com",
        "PhoneNumber": "44443333",
        "BillToFirstName": "Example",
        "BillToLastName": "Invitee",
        "BillToStreetLine1": "100 Some Street",
        "BillToStreetLine2": null,
        "BillToCity": "Melbourne",
        "BillToCountry": "Australia",
        "BillToState": "Victoria",
        "BillToPostCode": "3000",
        "AvatarURL": "https://ylt-images.imgix.net/app/invitees-icon@2x.png?fit=crop&crop=faces&h=150&w=150",
        "MiniBio": "Bio sample",
        "RegistrationStatus": 1,
        "RegistrationDateReceivedUTC": "2025-08-12T23:14:03.007",
        "RegistrationNote": "Example registration note",
        "ResponseDietaryRequirement": "Vegetarian",
        "PlannerNote": "Planner notes may be here",
        "TransferredFromInviteeId": null,
        "InvitationGroup": "groupname",
        "InvitationGroupMembers": [
          {
            "FullName": "Sample Friend",
            "FirstName": "Sample",
            "LastName": "Friend",
            "Email": "friend@example.com"
          },
          {
            "FullName": "Second Friend",
            "FirstName": "Second",
            "LastName": "Friend",
            "Email": "second@example.com"
          }
        ],
        "NumberInGroup": 2,
        "Category": "Invitee Category",
        "ReferenceCode": "TNSHYVC8Y6",
        "PackageName": "Standard Package",
        "PackageCode": "Deluxe",
        "PackageFeesAndTaxesAmount": 20.00,
        "BasePrice": 1256.25,
        "Room": null,
        "AmountOwing": 837.542,
        "TripId": "341e71a2-489f-e711-8305-985fd3437709",
        "TripName": "Saturn In The Summertime",
        "TripAlias": "saturn-trip",
        "TripRegistrationButtonLabel": "OK sure",
        "MagicLink": "https://youli.io/t/ahmad/saturn-trip/06826297-91eb-4e37-806b-70c1a08f657b",
        "TrackingSource": null,
        "TrackingMedium": null,
        "TrackingCampaign": null,
        "Payment": {
            "Id": "8de4ef98-7821-497b-8a9d-916d893f67a2",
            "Amount": 100.0,
            "Currency": "USD",
            "Method": "offline",
            "Description": "Sample payment",
            "Status": "successful",
            "PaymentDateUTC": "2022-06-02T03:16:44.6720722Z",
            "YouLiFeeAmount": 0.0,
            "YouLiFeeCurrency": null,
            "CreditCardSurchargeAmount": 0.0,
            "CreditCardSurchargeCurrency": "USD",
            "RefundProtectSurchargeAmount": 0.0,
            "RefundProtectSurchargeCurrency": "USD",
            "Allocations": [
                {
                    "Id": "00000000-0000-0000-0000-000000000000",
                    "FullName": "Example Invitee",
                    "FirstName": "Example",
                    "LastName": "Invitee",
                    "Amount": 100.0,
                    "Installment": null
                }
            ]
        },
        "TaskResponses": [
            {
                "Id": "9d9d6b45-5156-ed11-8738-c4236085fe66",
                "TaskId": "c6a6ccc0-dc49-ed11-8735-c4236085fe66",
                "TaskName": "Give us more details",
                "TaskResponseType": 8,
                "TaskResponseDateUTC": "2025-11-21T00:52:06.33",
                "TaskResponseReviewRequired": true,
                "TaskResponseReviewedDateUTC": "2025-11-21T01:26:02.9566667",
                "ResponseValue": "",
                "HasFields": true,
                "FieldResponses": [
                    {
                        "APIFieldName": "AGE",
                        "FieldLabel": "How old are you?",
                        "FieldResponseValue": "34"
                    },
                    {
                        "APIFieldName": "DOCTOR_NAME",
                        "FieldLabel": "Who is your doctor?",
                        "FieldResponseValue": "Dr Bond"
                    }
                ]
            }
          ]
    }
]

This authenticated endpoint retrieves the last 10 invitee payments for a given trip, or an example ("dummy") invitee if there are no invitees yet on the trip. If no Trip ID parameter is provided, it will return the last 10 invitee payments from the most recently updated trip. It can be used for testing other API endpoints (e.g. by Zapier).

HTTP Request

GET https://youli.io/api/trip/getpaymentsorexample

URL Parameters

Parameter	Default	Is Optional	Description
tripid		Yes	Id of a given trip

Results

Returns a list of TripRegistrationForSinglePayment objects.

RegistrationStatus returns the following values:

RegistrationStatus	Description
0	Invited
1	Registered
3	Declined
4	Transferred
5	Approved
6	Waitlisted

Note: "2" is not currently a valid status.

TaskResponseType returns the following values:

TaskResponseType	Description
0	Radio Button (Yes/No)
1	Checkbox (Done)
2	Select only one value
3	Date picker only
4	Date + time picker
5	Document(s) Upload
6	Input box (Comment)
7	Passport form + Upload
8	Custom form (build your own)
9	Select all that apply
10	Profile & Registration Form

Recent Task Responses

curl "https://youli.io/api/trip/gettaskresponsesorexample"
  -H "Authorization: bearer meowmeowmeow"

[
    {
        "Id": "dbc0945e-43fe-e611-82bb-985fd335920c",
        "FullName": "Example Invitee",
        "FirstName": "Example",
        "LastName": "Invitee",
        "Email": "example@example.com",
        "PhoneNumber": "44443333",
        "BillToFirstName": "Example",
        "BillToLastName": "Invitee",
        "BillToStreetLine1": "100 Some Street",
        "BillToStreetLine2": null,
        "BillToCity": "Melbourne",
        "BillToCountry": "Australia",
        "BillToState": "Victoria",
        "BillToPostCode": "3000",
        "AvatarURL": "https://ylt-images.imgix.net/app/invitees-icon@2x.png?fit=crop&crop=faces&h=150&w=150",
        "MiniBio": "Bio sample",
        "RegistrationStatus": 1,
        "RegistrationDateReceivedUTC": "2025-08-12T23:14:03.007",
        "RegistrationNote": "Example registration note",
        "ResponseDietaryRequirement": "Vegetarian",
        "PlannerNote": "Planner notes may be here",
        "TransferredFromInviteeId": null,
        "InvitationGroup": "groupname",
        "InvitationGroupMembers": [
          {
            "FullName": "Sample Friend",
            "FirstName": "Sample",
            "LastName": "Friend",
            "Email": "friend@example.com"
          },
          {
            "FullName": "Second Friend",
            "FirstName": "Second",
            "LastName": "Friend",
            "Email": "second@example.com"
          }
        ],
        "NumberInGroup": 2,
        "Category": "Invitee Category",
        "ReferenceCode": "TNSHYVC8Y6",
        "PackageName": "Standard Package",
        "PackageCode": "Deluxe",
        "PackageFeesAndTaxesAmount": 20.00,
        "BasePrice": 1256.25,
        "Room": null,
        "AmountOwing": 837.542,
        "TripId": "341e71a2-489f-e711-8305-985fd3437709",
        "TripName": "Saturn In The Summertime",
        "TripAlias": "saturn-trip",
        "TripRegistrationButtonLabel": "OK sure",
        "MagicLink": "https://youli.io/t/ahmad/saturn-trip/06826297-91eb-4e37-806b-70c1a08f657b",
        "TrackingSource": null,
        "TrackingMedium": null,
        "TrackingCampaign": null,
        "TaskResponse": {
            "Id": "9d9d6b45-5156-ed11-8738-c4236085fe66",
            "TaskId": "c6a6ccc0-dc49-ed11-8735-c4236085fe66",
            "TaskName": "Give us more details",
            "TaskResponseType": 8,
            "TaskResponseDateUTC": "2025-11-21T00:52:06.33",
            "TaskResponseReviewRequired": true,
            "TaskResponseReviewedDateUTC": "2025-11-21T01:26:02.9566667",
            "ResponseValue": "",
            "HasFields": true,
            "FieldResponses": [
                {
                    "APIFieldName": "AGE",
                    "FieldLabel": "How old are you?",
                    "FieldResponseValue": "34"
                },
                {
                    "APIFieldName": "DOCTOR_NAME",
                    "FieldLabel": "Who is your doctor?",
                    "FieldResponseValue": "Dr Bond"
                }
            ]
        }
    }
]

This authenticated endpoint retrieves the last 10 invitee task responses for a given trip, or an example ("dummy") invitee if there are no invitees yet on the trip. If no Trip ID parameter is provided, it will return the last 10 invitee task resposnes from the most recently updated trip. It can be used for testing other API endpoints (e.g. by Zapier).

HTTP Request

GET https://youli.io/api/trip/gettaskresponsesorexample

URL Parameters

Parameter	Default	Is Optional	Description
tripid		Yes	Id of a given trip

Results

Returns a list of TripRegistrationForSingleTaskResponse objects.

RegistrationStatus returns the following values:

RegistrationStatus	Description
0	Invited
1	Registered
3	Declined
4	Transferred
5	Approved
6	Waitlisted

Note: "2" is not currently a valid status.

TaskResponseType returns the following values:

TaskResponseType	Description
0	Radio Button (Yes/No)
1	Checkbox (Done)
2	Select only one value
3	Date picker only
4	Date + time picker
5	Document(s) Upload
6	Input box (Comment)
7	Passport form + Upload
8	Custom form (build your own)
9	Select all that apply
10	Profile & Registration Form

Add Registration

curl "https://youli.io/api/trip/addregistration"
  -X POST
  -H "Authorization: bearer meowmeowmeow"
  -H "Content-Type: application/json"
  -d '{
    "tripid": "341e71a2-489f-e711-8305-985fd3437709",
    "firstname": "Sample",
    "lastname": "Addition",
    "email": "sample@example.com",
    "phonenumber": "577376573",
    "registrationnote": "We will be there",
    "packageid": "4af5dbe5-9fd3-4c19-9cbb-5dfa9155f710",
    "room": 533,
    "categoryname": "Invitee Category",
    "source": "API",
    "sendconfirmation": false,
    "allowincompletetaskresponses": false,
    "forcenewregistration": true,
    "allowemptyemail": true,
    "invitationgroup": "Sample Group",
    "reservationnumber": "R-2025-000000",
    "isnewreservation": true,
    "taskresponses": [
      {
        "apifieldname": "AGE",
        "value": "34"
      },
      {
          "ApiFieldName": "DOCTOR_NAME",
          "Value": "Dr Bond"
      }
    ]
  }'

{
  "Total": 1,
  "Results": {
    "Id": "7d6f4d61-7d7f-ea11-b276-2816a850d1f6",
    "FirstName": "Sample",
    "LastName": "Addition",
    "Email": "sample@example.com",
    "PhoneNumber": "577376573",
    "BillToFirstName": null,
    "BillToLastName": null,
    "BillToStreetLine1": null,
    "BillToStreetLine2": null,
    "BillToCity": null,
    "BillToCountry": null,
    "BillToState": null,
    "BillToPostCode": null,
    "AvatarURL": "https://ylt-images.imgix.net/app/invitees-icon@2x.png?fit=crop&crop=faces&h=150&w=150",
    "MiniBio": null,
    "RegistrationStatus": 1,
    "RegistrationDateReceivedUTC": "2025-08-12T23:14:03.007",
    "RegistrationNote": "We will be there",
    "ResponseDietaryRequirement": "Vegetarian",
    "PlannerNote": null,
    "TransferredFromInviteeId": null,
    "InvitationGroup": "Sample Group",
    "InvitationGroupMembers": [
      {
        "InviteeId": "7d6f4d61-7d7f-ea11-b276-2816a850d1f6",
        "FullName": "Sample Addition",
        "FirstName": "Sample",
        "LastName": "Addition",
        "Email": "sample@example.com",
        "InvoiceLineItems": [],
        "ItineraryAddOns": [],
        "BookingAddOnOption": null
      }
    ],
    "NumberInGroup": 1,
    "Category": "Invitee Category",
    "ReferenceCode": "TNSFJKC8Y6",
    "ReservationNumber": "R-2026-AC3F7Y",
    "PackageName": "Sample Package",
    "PackageCode": "Deluxe",
    "PackageFeesAndTaxesAmount": 20.00,
    "BasePrice": 7650,
    "Room": 533,
    "AmountOwing": 7650,
    "TripId": "341e71a2-489f-e711-8305-985fd3437709",
    "TripName": "Saturn In The Summertime",
    "TripAlias": "saturn-trip",
    "TripRegistrationButtonLabel": "Yes please",
    "MagicLink": "https://youli.io/t/ahmad/saturn-trip",
    "TrackingSource": "API",
    "TrackingMedium": "uploaded",
    "TrackingCampaign": null,
    "TaskResponses": [
      {
          "Id": "9d9d6b45-5156-ed11-8738-c4236085fe66",
          "TaskId": "c6a6ccc0-dc49-ed11-8735-c4236085fe66",
          "TaskName": "Give us more details",
          "TaskResponseType": 8,
          "TaskResponseDateUTC": "2025-11-21T00:52:06.33",
          "TaskResponseReviewRequired": true,
          "TaskResponseReviewedDateUTC": "2025-11-21T01:26:02.9566667",
          "ResponseValue": "",
          "HasFields": true,
          "FieldResponses": [
              {
                  "APIFieldName": "AGE",
                  "FieldLabel": "How old are you?",
                  "FieldResponseValue": "34"
              },
              {
                  "APIFieldName": "DOCTOR_NAME",
                  "FieldLabel": "Who is your doctor?",
                  "FieldResponseValue": "Dr Bond"
              },
              {
                  "ApiFieldName": "RICH_TEXT",
                  "Value": "<p>test</p><p>"
              },
              {
                  "ApiFieldName": "SOCIAL_MEDIA",
                  "Value": "facebook-https://www.facebook.com/somepage|instagram-https://www.instagram.com/somepage"
              }
          ]
      }
    ]
  },
  "Warnings": []
}

This authenticated endpoint can be called to add a registration to a given trip. If a registration with the given email already exists, then the first name, last name, phone number, package and room will be updated on the existing registration (if they have changed).

Note that the package can never be cleared via the API. If no Package Id is provided for an update, the package will not be changed.

See the Usage Guide for more information.

HTTP Request

POST https://youli.io/api/trip/addregistration

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
tripid		No	Id of trip to add registration to
firstname		No	First name of registration
lastname		Yes	Last name of registration
email		No	Email of registration
phonenumber		Yes	Phone number of registration
registrationnote		Yes	Registration Note
packageid		Yes	Id of trip package to add registration to. If the specified package requires a change to the number of people in the invitee's group, placeholders will be added/removed correct, as would be done via the Trip Page when changing package
room		Yes	Free text room to set against invitee. If a rooming map is installed for the trip, this value will be ignored
categoryname		No	If enabled, optionally provide a single category name as a string for this registration. If provided, it must be a valid category configured on the trip owner’s account, a 400 will be returned if an invalid value is provided. Parameter will be ignored if the trip owner does not have Traveler Categories enabled. Learn More
source	API	Yes	Can be used to track the source of an added registration
sendconfirmation	false	Yes	If set to `true`, a normal confirmation email will be sent to the registration email regarding their addition in YouLi. Valid values are `true` and `false`.
allowincompletetaskresponses	false	Yes	If set to `true`, allow addition of task responses the resulting response would be considered incomplete (ie., not all required fields are provided). Valid values are `true` and `false`.
forcenewregistration	false	Yes	When `true`, skips matching an existing invitee by email - always adds a new invitee, even if the email already exists on the trip.
allowemptyemail	false	Yes	When `true`, email is not a required field. If email is left blank, the match-by-email lookup is skipped and a new invitee is always added. If an email is provided, normal match/update behavior applies.
invitationgroup		Yes	Invitation Group name. Spaces are trimmed. If existing Invitation Group with the provided name exists on the trip, invitee will be added to it; otherwise creates a new Invitation Group with the provided name, with Invoice Mode set to "Pay Together", and adds the invitee to it. If omitted, the invitee's Invitation Group assignment is left as-is (existing Invitation Group membership is kept; a solo traveller stays solo).
reservationnumber		Yes	Existing reservation number to add the invitee (and their Invitation Group) into. Spaces are trimmed. Reservations are not scoped to a single trip — a reservation can have Invitation Groups across a Main Tour and its linked Pre and/or Post Tours — therefore the lookup for the existing reservation will check the current trip and its linked tours. This field will be ignored if `isnewreservation` is also `true`. Requires the trip owner's subscription to have the Reservations feature enabled.
isnewreservation	false	Yes	Generates a new reservation and attaches the invitee's Invitation Group to it. Takes priority over `reservationnumber` if both are provided. If the invitee is already in an Invitation Group, the entire Invitation Group (all its members) will be moved into the new reservation, not just this invitee. Requires the trip owner's subscription to have the Reservations feature enabled.
taskresponses		Yes	Array of task responses. If provided, tasks responses will be add for the new or updated registration, see below for details

The taskResponses array, if provided, must contain a JSON array in the following format:

Field	Default	Is Optional	Description
apifieldname		No	API Field Name for a custom form field.
value		Yes	Value for the response.

The API Field Name must match the "API Field Name" on a field for one of the "Custom Form Builder" tasks on the given trip. If no such field is found, a warning will be given.

A task response will be created for every "Custom Form Builder" task for which one or more field value responses have been given.

If the API FIELD NAME is provided but the value is empty, and the associated task field is not required, the field response for that custom form field will be set to an empty string. traveler task response will have a field set for that an empty string. However, if the associated field is required, then the task response will not be added at all, and a warning will be given in the response.

If the allowincompletetaskresponses parameter has not been set to true, any tasks that do not have a full set of "required" fields provided in this request will not have a response created/updated. A warning will be given in the response.

If the allowincompletetaskresponses parameter has been set to true, any tasks that do not have a full set of "required" fields provided in this request will have a response created/updated, and a warning will be given in the response.

The value provided for a given task response field must match the given field type. For example:

"Single-line textbox" - simple text
"Multi-line textbox" - longer-format text
"Date picker only" - a valid date in the format yyyy-mm-dd
"Date + time picker" - a valid date in the format yyyy-MM-dd hh:mm:ss
"Select all that apply" - a pipe-separated list of values, where all values match one of the valid options - e.g. "Apples|Bananas"
"Select only one value" - a value that matches one of the valid options
"Checkbox" - true or false
"Radio Button (Yes/No)" - true or false
"Email" - an email address
"Select a country" - a country code (e.g "US", "AU")
"Rich Text Input" - HTML-formatted text
"Social Media Links" - a pipe-separated list that includes all the social media links that need to be provided, using the following format: facebook-<link>|instagram-<link>|etc (replacing <link> with the actual link). The valid social media platforms are: facebook, instagram, twitter, tiktok, youtube, pinterest, linkedin
"Date w/o picker (good for birthdates)" - a valid date in the format yyyy-mm-dd

For date values, the components are:

"yyyy" - year (e.g. 1999)
"MM" - month (01-12)
"dd" - day of month (01-31)
"hh" - hours in 24 hour time (00-23)
"mm" - minutes (00-59)
"ss" - seconds (00-59)

For more information about the "API Field Name", refer to the help documentation available at https://help.youlivetotravel.com/hc/en-us/articles/4415398752911-API-Field-Name

Results

Returns a TripRegistration object.

RegistrationStatus returns the following values:

RegistrationStatus	Description
0	Invited
1	Registered
3	Declined
4	Transferred
5	Approved
6	Waitlisted

Note: "2" is not currently a valid status.

TaskResponseType returns the following values:

TaskResponseType	Description
0	Radio Button (Yes/No)
1	Checkbox (Done)
2	Select only one value
3	Date picker only
4	Date + time picker
5	Document(s) Upload
6	Input box (Comment)
7	Passport form + Upload
8	Custom form (build your own)
9	Select all that apply
10	Profile & Registration Form
11	Wanderwell Travel Insurance

Add Manual Payment

curl "https://youli.io/api/trippayment/addmanualpayment/"
  -X POST
  -H "Authorization: bearer meowmeowmeow"
  -H "Content-Type: application/json"
  -d '{
    "tripid": "341e71a2-489f-e711-8305-985fd3437709",
    "inviteeid": "dbc0945e-43fe-e611-82bb-985fd335920c",
    "type": "Payment",
    "currency": "USD",
    "paymentamount": 500.00,
    "datetimepaidutc": "2026-08-10",
    "externalpaymentgatewaychargeid": "BLKAH-1235"
  }'

{
  "Total": 1,
  "Results": {
        "Id": "dbc0945e-43fe-e611-82bb-985fd335920c",
        "FullName": "Example Invitee",
        "FirstName": "Example",
        "LastName": "Invitee",
        "Email": "example@example.com",
        "PhoneNumber": "44443333",
        "BillToFirstName": "Example",
        "BillToLastName": "Invitee",
        "BillToStreetLine1": "100 Some Street",
        "BillToStreetLine2": null,
        "BillToCity": "Melbourne",
        "BillToCountry": "Australia",
        "BillToState": "Victoria",
        "BillToPostCode": "3000",
        "AvatarURL": "https://ylt-images.imgix.net/app/invitees-icon@2x.png?fit=crop&crop=faces&h=150&w=150",
        "MiniBio": "Bio sample",
        "RegistrationStatus": 1,
        "RegistrationDateReceivedUTC": "2025-08-12T23:14:03.007",
        "RegistrationNote": "Example registration note",
        "ResponseDietaryRequirement": "Vegetarian",
        "PlannerNote": "Planner notes may be here",
        "TransferredFromInviteeId": "26e5179e-4ea7-47ac-b53c-9bdcd61a38d3",
        "InvitationGroup": "groupname",
        "InvitationGroupMembers": [
          {
            "FullName": "Sample Friend",
            "FirstName": "Sample",
            "LastName": "Friend",
            "Email": "friend@example.com"
          },
          {
            "FullName": "Second Friend",
            "FirstName": "Second",
            "LastName": "Friend",
            "Email": "second@example.com"
          }
        ],
        "NumberInGroup": 2,
        "Category": "Invitee Category",
        "ReferenceCode": "TNSHYVC8Y6",
        "PackageName": "Standard Package",
        "PackageCode": "Deluxe",
        "PackageFeesAndTaxesAmount": 20.00,
        "BasePrice": 1256.25,
        "Room": null,
        "AmountOwing": 837.542,
        "TripId": "341e71a2-489f-e711-8305-985fd3437709",
        "TripName": "Saturn In The Summertime",
        "TripAlias": "saturn-trip",
        "TripRegistrationButtonLabel": "OK sure",
        "TripTags": [
          "Culinary",
          "Fundraising"
        ],
        "MagicLink": "https://youli.io/t/ahmad/saturn-trip/06826297-91eb-4e37-806b-70c1a08f657b",
        "TrackingSource": null,
        "TrackingMedium": null,
        "TrackingCampaign": null,
        "Payments": [
            {
                "Id": "8de5ef76-7821-497b-8a9d-916d893f67a2",
                "PaymentGatewayChargeId": "BLKAH-1235",
                "Amount": 500.0,
                "Currency": "USD",
                "Method": "offline",
                "Description": "Sample payment",
                "Status": "successful",
                "PaymentDateUTC": "2026-08-10T00:00:00.0000000",
                "YouLiFeeAmount": 0.0,
                "YouLiFeeCurrency": null,
                "CreditCardSurchargeAmount": 0.0,
                "CreditCardSurchargeCurrency": "USD",
                "RefundProtectSurchargeAmount": 0.0,
                "RefundProtectSurchargeCurrency": "USD",
                "Allocations": [
                    {
                        "Id": "dbc0945e-43fe-e611-82bb-985fd335920c",
                        "FullName": "Example Invitee",
                        "FirstName": "Example",
                        "LastName": "Invitee",
                        "Amount": 100.0,
                        "Installment": null
                    }
                ]
            }
        ],
    },
  "Warnings": []
}

This authenticated endpoint can be called to add a manual payment for an invitee.

HTTP Request

POST https://youli.io/api/trippayment/addmanualpayment

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
tripid		Yes	Id of the trip the invitee belongs to (optional, to allow for a more robust integration). If provided and the specified Invitee is not on that trip, a 400 (Bad Request) will be returned
inviteeid		No	Id of the invitee to add the payment for. Required unless `referencecode` is provided.
referencecode		No	Reference Code of the invitee to add the payment for. Required unless `inviteeid` is provided
type	Payment	No	Valid values are `Payment`, `Credit`, or `Refund`
label	Manual Payment	No	Label to be set on payment, max length 100
datetimepaidutc	Current date	No	Payment date in UTC time zone (UTC), defaults to time at the time of the call
currency		No	Three-character ISO currency code. Must match the Trip Currency otherwise a 400 (Bad Request) will be returned
paymentamount		No	Payment amount (numeric). Can be negative (eg for `Refund` type)
installmentname		Yes	If not provided, payment will be allocated dynamically based on what is outstanding. If provided, must match an existing Installment on the provided invitee's trip, otherwise a 400 (Bad Request) will be returned. When matched to an existing installment, payment will be allocated dynamically based on what is oustanding, starting with the specified installment
externalpaymentgatewaychargeid		Yes	Can be used for reference if this payment came from another gateway, and is returned in responses in the `PaymentGatewayChargeId` field
applyto	see note	Yes	Valid values are `onlythisperson`, `invitationgroup` or `reservation`. If not provided, and the invitee is in an invitation group with Invoice Mode set to "Pay Together", defaults to `invitationgroup`, otherwise defaults to `onlythisperson`. For `invitationgroup` or `reservation`, allocations will be applied dynamically across the invitees and installments in the invitation group or reservation
appendNoteToPlannerNote		Yes	Optional string to append to the invitee's Planner Note

Results

Returns a TripRegistration object, containing the list of payments in the Payments array, which in turn contain a list of the Allocations for each payment.

Note that in the Allocations objects, the Id is the InviteeId of the invitee that the allocation is against.

RegistrationStatus returns the following values:

RegistrationStatus	Description
0	Invited
1	Registered
3	Declined
4	Transferred
5	Approved
6	Waitlisted

Note: "2" is not currently a valid status.

TaskResponseType returns the following values:

TaskResponseType	Description
0	Radio Button (Yes/No)
1	Checkbox (Done)
2	Select only one value
3	Date picker only
4	Date + time picker
5	Document(s) Upload
6	Input box (Comment)
7	Passport form + Upload
8	Custom form (build your own)
9	Select all that apply
10	Profile & Registration Form
11	Wanderwell Travel Insurance

Delete Manual Payment

curl "https://youli.io/api/trippayment/deletemanualpayment/8de5ef76-7821-497b-8a9d-916d893f67a2?inviteeid=7d6f5d21-7d7f-ea11-b276-2816a850d1f6"
  -X DELETE
  -H "Authorization: bearer meowmeowmeow"

{
  "Total": 1,
  "Results": {
        "Id": "dbc0945e-43fe-e611-82bb-985fd335920c",
        "FullName": "Example Invitee",
        "FirstName": "Example",
        "LastName": "Invitee",
        "Email": "example@example.com",
        "PhoneNumber": "44443333",
        "BillToFirstName": "Example",
        "BillToLastName": "Invitee",
        "BillToStreetLine1": "100 Some Street",
        "BillToStreetLine2": null,
        "BillToCity": "Melbourne",
        "BillToCountry": "Australia",
        "BillToState": "Victoria",
        "BillToPostCode": "3000",
        "AvatarURL": "https://ylt-images.imgix.net/app/invitees-icon@2x.png?fit=crop&crop=faces&h=150&w=150",
        "MiniBio": "Bio sample",
        "RegistrationStatus": 1,
        "RegistrationDateReceivedUTC": "2025-08-12T23:14:03.007",
        "RegistrationNote": "Example registration note",
        "ResponseDietaryRequirement": "Vegetarian",
        "PlannerNote": "Planner notes may be here",
        "TransferredFromInviteeId": "26e5179e-4ea7-47ac-b53c-9bdcd61a38d3",
        "InvitationGroup": "groupname",
        "InvitationGroupMembers": [
          {
            "FullName": "Sample Friend",
            "FirstName": "Sample",
            "LastName": "Friend",
            "Email": "friend@example.com"
          },
          {
            "FullName": "Second Friend",
            "FirstName": "Second",
            "LastName": "Friend",
            "Email": "second@example.com"
          }
        ],
        "NumberInGroup": 2,
        "Category": "Invitee Category",
        "ReferenceCode": "TNSHYVC8Y6",
        "PackageName": "Standard Package",
        "PackageCode": "Deluxe",
        "PackageFeesAndTaxesAmount": 20.00,
        "BasePrice": 1256.25,
        "Room": null,
        "AmountOwing": 837.542,
        "TripId": "341e71a2-489f-e711-8305-985fd3437709",
        "TripName": "Saturn In The Summertime",
        "TripAlias": "saturn-trip",
        "TripRegistrationButtonLabel": "OK sure",
        "TripTags": [
          "Culinary",
          "Fundraising"
        ],
        "MagicLink": "https://youli.io/t/ahmad/saturn-trip/06826297-91eb-4e37-806b-70c1a08f657b",
        "TrackingSource": null,
        "TrackingMedium": null,
        "TrackingCampaign": null,
        "Payments": [
            {
                "Id": "f0fe66d7-a896-f111-9b32-0022487b4c54",
                "Amount": 50.0,
                "Currency": "USD",
                "Method": "offline",
                "Description": "Existing payment",
                "Status": "successful",
                "PaymentDateUTC": "2026-05-10T00:00:00.0000000",
                "YouLiFeeAmount": 0.0,
                "YouLiFeeCurrency": null,
                "CreditCardSurchargeAmount": 0.0,
                "CreditCardSurchargeCurrency": "USD",
                "RefundProtectSurchargeAmount": 0.0,
                "RefundProtectSurchargeCurrency": "USD",
                "Allocations": [
                    {
                        "Id": "dbc0945e-43fe-e611-82bb-985fd335920c",
                        "FullName": "Example Invitee",
                        "FirstName": "Example",
                        "LastName": "Invitee",
                        "Amount": 100.0,
                        "Installment": null
                    }
                ]
            }
        ],
    },
  "Warnings": []
}

This authenticated endpoint can be called to delete a manual payment from an invitee.

HTTP Request

DELETE https://youli.io/api/trippayment/deletemanualpayment

Route Parameters

The Payment Id must be provided as part of the route. This Id is included in the TripRegistration, within the payment objects in the Payments array.

URL Parameters

Parameter	Default	Is Optional	Description
inviteeid		see note	Required if `referencecode` is not provided
referencecode		see note	Required if `inviteeid` is not provided

Results

Returns a TripRegistration object for the invitee, containing the list of remaining payments in the Payments array, which in turn contain a list of the Allocations for each payment.

Note that in the Allocations objects, the Id is the InviteeId of the invitee that the allocation is against.

RegistrationStatus returns the following values:

RegistrationStatus	Description
0	Invited
1	Registered
3	Declined
4	Transferred
5	Approved
6	Waitlisted

Note: "2" is not currently a valid status.

TaskResponseType returns the following values:

TaskResponseType	Description
0	Radio Button (Yes/No)
1	Checkbox (Done)
2	Select only one value
3	Date picker only
4	Date + time picker
5	Document(s) Upload
6	Input box (Comment)
7	Passport form + Upload
8	Custom form (build your own)
9	Select all that apply
10	Profile & Registration Form
11	Wanderwell Travel Insurance

Webhooks

Webhooks can be used to get automatic notifications when certain events occur within YouLi. Learn more about use cases here.

curl "https://youli.io/api/webooks/subscribe"
  -X POST
  -H "Authorization: bearer meowmeowmeow"

{
  "id": "e05a4ff9-d2f3-ea11-b29f-2816a850d1f6"
}

This authenticated endpoint can be called to add a subscription to a webhook.

The webhook which will trigger every time an invitee is added to the specified future trip with a registration status of "registered" or "waitlisted". It will also trigger whenever an existing invitee is changed to one of those states.

The structure of the data sent when the event triggers will be the same as the data returned from the "Recent Invitees" endpoint.

HTTP Request

POST https://youli.io/api/webhook/subscribe

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
hookUrl		No	Url to be called when a certain given event triggers
tripid		No	Id of trip for which to subscribe for events

Results

Returns an Id of the webhook which can be used by external systems, such as for use with the unsubscribe endpoint.

Triggered Webhook Payload

The payload send out when this webhook is triggered will include a TripRegistration object. For an example of this payload, see the Recent Invitees endpoint.

This object includes a RegistrationStatus, which is provided as a numeric value. The value maps to the invitee registration status as follows:

RegistrationStatus	Description
1	Registered
6	Waitlisted

Unsubscribe (Trip Invitees)

curl "https://youli.io/api/webooks/unsubscribe"
  -X DELETE
  -H "Authorization: bearer meowmeowmeow"

OK

This authenticated endpoint can be called to delete a subscription to a webhook.

HTTP Request

DELETE https://youli.io/api/webhook/unsubscribe

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
HookId		No	Id of webhook, previously provided on subscribe

Results

Deletes the given webook.

curl "https://youli.io/api/webooks/subscribeusertripinvitee"
  -X POST
  -H "Authorization: bearer meowmeowmeow"

{
  "id": "e05a4ff9-d2f3-ea11-b29f-2816a850d1f6"
}

This authenticated endpoint can be called to add a subscription to a webhook.

The webhook which will trigger every time an invitee (registration) is added to any future trip for the authenticated user (or their team owner), with a registration status of "registered" or "waitlisted". It will also trigger whenever an existing invitee is changed to one of those states.

The structure of the data sent when the event triggers will be the same as the data returned from the "Recent Invitees" endpoint.

HTTP Request

POST https://youli.io/api/webhook/subscribeusertripinvitee

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
hookUrl		No	Url to be called when a certain given event triggers

Results

Returns an Id of the webhook which can be used by external systems, such as for use with the unsubscribe endpoint.

Triggered Webhook Payload

The payload send out when this webhook is triggered will include a TripRegistration object. For an example of this payload, see the Recent Invitees endpoint.

This object includes a RegistrationStatus, which is provided as a numeric value. The value maps to the invitee registration status as follows:

RegistrationStatus	Description
1	Registered
6	Waitlisted

Unsubscribe (User Trip Invitees)

curl "https://youli.io/api/webooks/unsubscribeusertripinvitee"
  -X DELETE
  -H "Authorization: bearer meowmeowmeow"

OK

This authenticated endpoint can be called to delete a webhook.

HTTP Request

DELETE https://youli.io/api/webhook/unsubscribeusertripinvitee

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
HookId		No	Id of webhook, previously provided on subscribe

Results

Deletes the given webook.

curl "https://youli.io/api/webooks/subscribetripinviteeregistrationstatuschange"
  -X POST
  -H "Authorization: bearer meowmeowmeow"

{
  "id": "e05a4ff9-d2f3-ea11-b29f-2816a850d1f6"
}

This authenticated endpoint can be called to add a subscription to a webhook.

The webhook will trigger every time an invitee registration status changes for the specified trip.

HTTP Request

POST https://youli.io/api/webhook/subscribetripinviteeregistrationstatuschange

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
hookUrl		No	Url to be called when a certain given event triggers
tripid		No	Id of trip for which to subscribe for events

Results

Returns an Id of the webhook which can be used by external systems, such as for use with the unsubscribe endpoint.

Triggered Webhook Payload

The payload sent when this webhook is triggered will include a TripRegistration object with the same invitee, trip, and Payments data structure as the Recent Invitees endpoint.

This payload includes:

RegistrationStatus (numeric enum value)
RegistrationStatusText (string display value for the current status)
PreviousRegistrationStatusText (string display value for the previous status, always different from RegistrationStatusText)

RegistrationStatus	RegistrationStatusText	Description
0	Invited	Invitee has been invited
1	Registered	Invitee has registered
3	Declined	Invitee is declined when there are no payment allocations on the invitee
3	Canceled	Invitee is canceled when there are payment allocations on the invitee
4	Transferred	Invitee has been transferred
5	Approved	Invitee has been approved
6	Waitlisted	Invitee is waitlisted

Unsubscribe (Trip Invitee Registration Status Change)

curl "https://youli.io/api/webooks/unsubscribetripinviteeregistrationstatuschange"
  -X DELETE
  -H "Authorization: bearer meowmeowmeow"

OK

This authenticated endpoint can be called to delete a webhook subscription.

HTTP Request

DELETE https://youli.io/api/webhook/unsubscribetripinviteeregistrationstatuschange

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
HookId		No	Id of webhook, previously provided on subscribe

Results

Deletes the given webook.

curl "https://youli.io/api/webooks/subscribeusertripinviteeregistrationstatuschange"
  -X POST
  -H "Authorization: bearer meowmeowmeow"

{
  "id": "e05a4ff9-d2f3-ea11-b29f-2816a850d1f6"
}

This authenticated endpoint can be called to add a subscription to a webhook.

The webhook will trigger every time an invitee registration status changes for any trip for the authenticated user (or their team owner).

HTTP Request

POST https://youli.io/api/webhook/subscribeusertripinviteeregistrationstatuschange

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
hookUrl		No	Url to be called when a certain given event triggers

Results

Returns an Id of the webhook which can be used by external systems, such as for use with the unsubscribe endpoint.

Triggered Webhook Payload

The payload sent when this webhook is triggered will include a TripRegistration object with the same invitee, trip, and Payments data structure as the Recent Invitees endpoint.

This payload includes:

RegistrationStatus (numeric enum value)
RegistrationStatusText (string display value for the current status)
PreviousRegistrationStatusText (string display value for the previous status, always different from RegistrationStatusText)

RegistrationStatus	RegistrationStatusText	Description
0	Invited	Invitee has been invited
1	Registered	Invitee has registered
3	Declined	Invitee is declined when there are no payment allocations on the invitee
3	Canceled	Invitee is canceled when there are payment allocations on the invitee
4	Transferred	Invitee has been transferred
5	Approved	Invitee has been approved
6	Waitlisted	Invitee is waitlisted

Unsubscribe (User Trip Invitee Registration Status Change)

curl "https://youli.io/api/webooks/unsubscribeusertripinviteeregistrationstatuschange"
  -X DELETE
  -H "Authorization: bearer meowmeowmeow"

OK

This authenticated endpoint can be called to delete a webhook subscription.

HTTP Request

DELETE https://youli.io/api/webhook/unsubscribeusertripinviteeregistrationstatuschange

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
HookId		No	Id of webhook, previously provided on subscribe

Results

Deletes the given webook.

curl "https://youli.io/api/webooks/subscribetrippayments"
  -X POST
  -H "Authorization: bearer meowmeowmeow"

{
  "id": "e05a4ff9-d2f3-ea11-b29f-2816a850d1f6"
}

This authenticated endpoint can be called to add a subscription to a webhook.

The webhook which will trigger every time an invitee payment is added to the specified trip. The structure of the data sent when the event triggers will be the same as the data returned from the "Recent Payments" endpoint.

HTTP Request

POST https://youli.io/api/webhook/subscribetrippayments

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
hookUrl		No	Url to be called when a certain given event triggers
tripid		No	Id of trip for which to subscribe for events

Results

Returns an Id of the webhook which can be used by external systems, such as for use with the unsubscribe endpoint.

Triggered Webhook Payload

The payload send out when this webhook is triggered will include a TripRegistrationForSinglePayment object. For an example of this payload, see the Recent Payments endpoint.

Unsubscribe (Trip Payments)

curl "https://youli.io/api/webooks/unsubscribetrippayments"
  -X DELETE
  -H "Authorization: bearer meowmeowmeow"

OK

This authenticated endpoint can be called to delete a webhook.

HTTP Request

DELETE https://youli.io/api/webhook/unsubscribetrippayments

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
HookId		No	Id of webhook, previously provided on subscribe

Results

Deletes the given webook.

curl "https://youli.io/api/webooks/subscribeusertrippayments"
  -X POST
  -H "Authorization: bearer meowmeowmeow"

{
  "id": "e05a4ff9-d2f3-ea11-b29f-2816a850d1f6"
}

This authenticated endpoint can be called to add a subscription to a webhook.

The webhook which will trigger every time an invitee payment is added to any trip for the authenticated user (or their team owner). The structure of the data sent when the event triggers will be the same as the data returned from the "Recent Payments" endpoint.

HTTP Request

POST https://youli.io/api/webhook/subscribeusertrippayments

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
hookUrl		No	Url to be called when a certain given event triggers

Results

Returns an Id of the webhook which can be used by external systems, such as for use with the unsubscribe endpoint.

Triggered Webhook Payload

The payload send out when this webhook is triggered will include a TripRegistrationForSinglePayment object. For an example of this payload, see the Recent Payments endpoint.

Unsubscribe (User Trip Payments)

curl "https://youli.io/api/webooks/unsubscribeusertrippayments"
  -X DELETE
  -H "Authorization: bearer meowmeowmeow"

OK

This authenticated endpoint can be called to delete a webhook.

HTTP Request

DELETE https://youli.io/api/webhook/unsubscribeusertrippayments

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
HookId		No	Id of webhook, previously provided on subscribe

Results

Deletes the given webook.

curl "https://youli.io/api/webooks/subscribetriptaskresponses"
  -X POST
  -H "Authorization: bearer meowmeowmeow"

{
  "id": "e05a4ff9-d2f3-ea11-b29f-2816a850d1f6"
}

This authenticated endpoint can be called to add a subscription to a webhook.

The webhook which will trigger every time an invitee task response is added to the specified trip. The structure of the data sent when the event triggers will be the same as the data returned from the "Recent Invitees" endpoint, but with just the single task response, and without any payments.

HTTP Request

POST https://youli.io/api/webhook/subscribetriptaskresponses

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
hookUrl		No	Url to be called when a certain given event triggers
tripid		No	Id of trip for which to subscribe for events

Results

Returns an Id of the webhook which can be used by external systems, such as for use with the unsubscribe endpoint.

Triggered Webhook Payload

The payload send out when this webhook is triggered will include a TripRegistrationForSingleTaskResponse object. For an example of this payload, see the Recent Task Responses endpoint.

Unsubscribe (Trip Task Responses)

curl "https://youli.io/api/webooks/unsubscribetriptaskresponses"
  -X DELETE
  -H "Authorization: bearer meowmeowmeow"

OK

This authenticated endpoint can be called to delete a webhook.

HTTP Request

DELETE https://youli.io/api/webhook/unsubscribetriptaskresponses

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
HookId		No	Id of webhook, previously provided on subscribe

Results

Deletes the given webook.

curl "https://youli.io/api/webooks/subscribeusertriptaskresponses"
  -X POST
  -H "Authorization: bearer meowmeowmeow"

{
  "id": "e05a4ff9-d2f3-ea11-b29f-2816a850d1f6"
}

This authenticated endpoint can be called to add a subscription to a webhook.

The webhook which will trigger every time an invitee task response is added to any trip for the authenticated user (or their team owner). The structure of the data sent when the event triggers will be the same as the data returned from the "Recent Invitees" endpoint, but with just the single task response, and without any payments.

HTTP Request

POST https://youli.io/api/webhook/subscribeusertriptaskresponses

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
hookUrl		No	Url to be called when a certain given event triggers

Results

Returns an Id of the webhook which can be used by external systems, such as for use with the unsubscribe endpoint.

Triggered Webhook Payload

The payload send out when this webhook is triggered will include a TripRegistrationForSingleTaskResponse object. For an example of this payload, see the Recent Task Responses endpoint.

Unsubscribe (User Trip Task Responses)

curl "https://youli.io/api/webooks/unsubscribeusertriptaskresponses"
  -X DELETE
  -H "Authorization: bearer meowmeowmeow"

OK

This authenticated endpoint can be called to delete a webhook.

HTTP Request

DELETE https://youli.io/api/webhook/unsubscribeusertriptaskresponses

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
HookId		No	Id of webhook, previously provided on subscribe

Results

Deletes the given webook.

curl "https://youli.io/api/webooks/subscribeusertripcreated"
  -X POST
  -H "Authorization: bearer meowmeowmeow"

{
  "id": "e05a4ff9-d2f3-ea11-b29f-2816a850d1f6"
}

This authenticated endpoint can be called to add a subscription to a webhook.

The webhook which will trigger every time a trip is created through Platform UI by an authenticated user (or their team owner).

HTTP Request

POST https://youli.io/api/webhook/subscribeusertripcreated

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
hookUrl		No	Url to be called when a certain given event triggers

Results

Returns an Id of the webhook which can be used by external systems, such as for use with the unsubscribe endpoint.

Unsubscribe (Trip Created Webhook)

curl "https://youli.io/api/webooks/unsubscribeusertripcreated"
  -X DELETE
  -H "Authorization: bearer meowmeowmeow"

OK

This authenticated endpoint can be called to delete a webhook.

HTTP Request

DELETE https://youli.io/api/webhook/unsubscribeusertripcreated

Request Body

Accepts JSON data with the following content:

Field	Default	Is Optional	Description
HookId		No	Id of webhook, previously provided on subscribe

Results

Deletes the given webook.

Introduction

Authentication

Pagination Headers

Error reporting note

Trips

Get All Trips

HTTP Request

URL Parameters

Results

Get Trip Invitees

HTTP Request

URL Parameters

Results

Get Invitee Itinerary Items

HTTP Request

URL Parameters

Results

Future Trips Lookup

HTTP Request

Results

Recent Invitees

HTTP Request

URL Parameters

Results

Recent Payments

HTTP Request

URL Parameters

Results

Recent Task Responses

HTTP Request

URL Parameters

Results

Add Registration

HTTP Request

Request Body

Results

Add Manual Payment

HTTP Request

Request Body

Results

Delete Manual Payment

HTTP Request

Route Parameters

URL Parameters

Results

Webhooks

Subscribe to Trip Invitees

HTTP Request

Request Body

Results

Triggered Webhook Payload

Unsubscribe (Trip Invitees)

HTTP Request

Request Body

Results

Subscribe to User Trips Invitees

HTTP Request

Request Body

Results

Triggered Webhook Payload

Unsubscribe (User Trip Invitees)

HTTP Request

Request Body

Results

Subscribe to Trip Invitee Registration Status Change

HTTP Request

Request Body

Results

Triggered Webhook Payload

Unsubscribe (Trip Invitee Registration Status Change)

HTTP Request

Request Body

Results

Subscribe to User Trip Invitee Registration Status Change

HTTP Request

Request Body

Results

Triggered Webhook Payload

Unsubscribe (User Trip Invitee Registration Status Change)

HTTP Request