Upland Developers API

{"openapi":"3.0.0","paths":{"/auth/otp/init":{"post":{"operationId":"AuthController_otpInit","summary":"Create Connection Code","description":"Creates a connection code to authenticate Upland Users within a third-party application. The Upland User must submit this code into her Upland Account to complete the authorization flow.","parameters":[],"responses":{"201":{"description":"Connection code response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtpInitResposeDto"}}}},"404":{"description":"Application not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpErrorDto"}}}}},"tags":["Authentication"],"security":[{"basic":[]}]}},"/user/assets/nfts":{"get":{"operationId":"UserController_getNfts","summary":"List user's NFTs","description":"Retrieves a paginated list of user's NFTs.","parameters":[{"name":"currentPage","required":true,"in":"query","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"number"}},{"name":"categories","required":false,"in":"query","description":"Filter by NFT Categories (structure, blkexplorer, essential, memento, structornmt, landvehicle, spirithlwn, outdoordecor, jacktsai, racinglegits, uppie)","schema":{"type":"array","items":{"type":"array","items":{"type":"a"}}}},{"name":"textSearch","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserNftsListResponseDto"}}}}},"tags":["Upland User"],"security":[{"bearer":[]}]}},"/user/assets/properties":{"get":{"operationId":"UserController_getProperties","summary":"List user's properties","description":"Retrieves a paginated list of user's properties.","parameters":[{"name":"currentPage","required":true,"in":"query","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"number"}},{"name":"cityId","required":false,"in":"query","schema":{"type":"number"}},{"name":"textSearch","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPropertiesListResponseDto"}}}}},"tags":["Upland User"],"security":[{"bearer":[]}]}},"/user/balances":{"get":{"operationId":"UserController_getBalances","summary":"Get user's balances","description":"Retrieves user's balances information.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserBalancesResponseDto"}}}}},"tags":["Upland User"],"security":[{"bearer":[]}]}},"/user/join":{"post":{"operationId":"UserController_putAssetsInEscrowContainer","summary":"Join escrow container","description":"Adds user's assets into the container. This action must be approved by the Upland user inside the Upland Application.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserJoinContainerRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinContainerResponseDto"}}}}},"tags":["Upland User"],"security":[{"bearer":[]}]}},"/user/profile":{"get":{"operationId":"UserController_getUserProfile","summary":"Get user's profile","description":"Retrieves user's profile information.","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfileResponseDto"}}}}},"tags":["Upland User"],"security":[{"bearer":[]}]}},"/user/travels":{"get":{"operationId":"UserController_getTravels","summary":"List user's travels","description":"Retrieves a paginated list of user's travels.","parameters":[{"name":"currentPage","required":true,"in":"query","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserTravelsListResponseDto"}}}}},"tags":["Upland User"],"security":[{"bearer":[]}]}},"/containers":{"post":{"operationId":"EscrowController_create","summary":"Create escrow container","description":"Creates a new escrow container to manage the Upland asset transfers in the application context. The application settings will be used to determine the container expiration time and Webhook URL for the container transaction status notifications. In case a dev shop ID is provided, users will be required to be at that specific dev shop in order to transfer their assets to the container; otherwise, they can be at any of the app's dev shops.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContainerRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerResponseDto"}}}}},"tags":["Escrow Containers"],"security":[{"basic":[]}]}},"/containers/{containerId}":{"get":{"operationId":"EscrowController_getContainer","summary":"Get escrow container","description":"Retrieves the escrow container information.","parameters":[{"name":"containerId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerWithAssetsResponseDto"}}}}},"tags":["Escrow Containers"],"security":[{"basic":[]}]}},"/containers/{containerId}/join":{"post":{"operationId":"EscrowController_putAssetsInEscrowContainerWithPermissionDelegation","summary":"Join escrow container (permission delegation required)","description":"Adds developer Upland account assets into the container (no signature required). It is required to activate the permission delegation feature.","parameters":[{"name":"containerId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinContainerRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinContainerResponseDto"}}}}},"tags":["Escrow Containers"],"security":[{"basic":[]}]}},"/containers/{containerId}/lock":{"post":{"operationId":"EscrowController_lockContainer","summary":"Lock escrow container","description":"Locks the escrow container blocking new users from joining it. This action is optional in the escrow container management flow.","parameters":[{"name":"containerId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"204":{"description":""}},"tags":["Escrow Containers"],"security":[{"basic":[]}]}},"/containers/{containerId}/unlock":{"post":{"operationId":"EscrowController_unlockContainer","summary":"Unlock escrow container","description":"Unlocks the escrow container allowing new users from joining it. This action is optional in the escrow container management flow.","parameters":[{"name":"containerId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"204":{"description":""}},"tags":["Escrow Containers"],"security":[{"basic":[]}]}},"/containers/{containerId}/refresh-expiration-time":{"post":{"operationId":"EscrowController_refresh","summary":"Refresh escrow container expiration time","description":"Refreshes the container expiration using the application settings. This action can only be performed once.","parameters":[{"name":"containerId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"204":{"description":""}},"tags":["Escrow Containers"],"security":[{"basic":[]}]}},"/containers/{containerId}/refund":{"post":{"operationId":"EscrowController_refund","summary":"Refund escrow container","description":"Refunds all the assets inside the container to the original owners (no fees) and resolves the container.","parameters":[{"name":"containerId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerResolutionResponseDto"}}}}},"tags":["Escrow Containers"],"security":[{"basic":[]}]}},"/containers/{containerId}/resolve":{"post":{"operationId":"EscrowController_resolve","summary":"Resolve escrow container","description":"Resolves the escrow container transfering the assets according to the provided actions (request body). All container assets must be included.","parameters":[{"name":"containerId","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerResolutionRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContainerResolutionResponseDto"}}}}},"tags":["Escrow Containers"],"security":[{"basic":[]}]}},"/containers/{containerId}/transactions/{transactionId}":{"delete":{"operationId":"EscrowController_removeTransaction","summary":"Remove escrow container transaction","description":"Removes the transaction that has not been signed from escrow container.","parameters":[{"name":"containerId","required":true,"in":"path","schema":{"type":"number"}},{"name":"transactionId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""}},"tags":["Escrow Containers"],"security":[{"basic":[]}]}},"/tracks":{"get":{"operationId":"TracksController_getTracks","summary":"List tracks","description":"Retrieves a list of all available race tracks.","parameters":[{"name":"cityName","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TracksListResponseDto"}}}},"404":{"description":"Tracks not found."}},"tags":["Generic"],"security":[{"basic":[]}]}},"/tracks/{id}":{"get":{"operationId":"TracksController_getTrackById","summary":"Get track","description":"Retrieves the full track information.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackWithDetailsResponseDto"}}}},"400":{"description":"Bad request or invalid query parameters"},"404":{"description":"Track not found."}},"tags":["Generic"],"security":[{"basic":[]}]}},"/tracks/{id}/buildings":{"get":{"operationId":"TracksController_getTrackBuildingsById","summary":"Get track buildings","description":"Retrieves all the buildings along the track.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingsListResponseDto"}}}},"404":{"description":"Buildings not found."}},"tags":["Generic"],"security":[{"basic":[]}]}},"/buildings":{"post":{"operationId":"BuildingsController_getBuildingsByBoundaries","summary":"Search for buildings","description":"Retrieves a list of completed buildings based on a given location (polygon bondaries).","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingsRequestDto"}}}},"responses":{"200":{"description":"Buildings List","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingsListResponseDto"}}}}},"tags":["Generic"],"security":[{"basic":[]}]}},"/cities":{"get":{"operationId":"CitiesController_getCities","summary":"List available cities","description":"Retrieves a list of all the Upland metaverse available cities.","parameters":[],"responses":{"200":{"description":"Cities list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CitiesListResponseDto"}}}}},"tags":["Generic"],"security":[{"basic":[]}]}},"/properties":{"get":{"operationId":"PropertiesController_getProperties","summary":"List properties (Deprecated)","description":"Retrieves a list of properties by filtering query params.","deprecated":true,"parameters":[{"name":"cityId","required":true,"in":"query","schema":{"type":"number"}},{"name":"textSearch","required":false,"in":"query","schema":{"type":"string"}},{"name":"currentPage","required":true,"in":"query","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertiesListResponseDto"}}}}},"tags":["Generic"],"security":[{"basic":[]}]}},"/v2/properties":{"get":{"operationId":"PropertiesController_getPropertiesWithNextPagePagination","summary":"List properties","description":"Retrieves a list of properties by filtering query params using next page token pagination.","parameters":[{"name":"cityId","required":true,"in":"query","schema":{"type":"number"}},{"name":"textSearch","required":false,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","example":10,"schema":{"type":"number"}},{"name":"nextPageToken","required":false,"in":"query","example":"Nzg4NDAwOTkyMDAwMzg=","description":"Token provided after the initial request to fetch subsequent pages","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertiesListWithNextPagePaginationResponseDto"}}}}},"tags":["Generic"],"security":[{"basic":[]}]}},"/properties/{propertyId}":{"get":{"operationId":"PropertiesController_getPropertyById","summary":"Get property","description":"Retrieves the property information.","parameters":[{"name":"propertyId","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyResponseDto"}}}}},"tags":["Generic"],"security":[{"basic":[]}]}},"/neighborhoods":{"get":{"operationId":"NeighborhoodsController_getNeighborhoods","summary":"List neighborhoods","description":"Retrieves a list of neighborhoods by filtering query params.","parameters":[{"name":"cityId","required":false,"in":"query","description":"(Optional) Filter by City ID","example":1,"schema":{"title":"City ID","type":"number"}},{"name":"textSearch","required":false,"in":"query","description":"(Optional) Text search on neighborhood name","example":"South","schema":{"title":"Text Search","type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NeighborhoodsListResponseDto"}}}}},"tags":["Generic"],"security":[{"basic":[]}]}},"/collections":{"get":{"operationId":"CollectionsController_getCollections","summary":"List collections","description":"Retrieves a list of all the Upland available asset collections.","parameters":[],"responses":{"200":{"description":"Collections List","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionsListResponseDto"}}}}},"tags":["Generic"],"security":[{"basic":[]}]}},"/treasures-history":{"get":{"operationId":"TreasuresController_getTreasuresHistory","summary":"List treasures history","description":"Retrieves a paginated list of treasures history.","parameters":[{"name":"currentPage","required":true,"in":"query","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"number"}},{"name":"cityId","required":false,"in":"query","description":"Filter by city ID","example":1,"schema":{"title":"City ID","type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TreasuresHistoryListResponseDto"}}}}},"tags":["Generic"],"security":[{"basic":[]}]}},"/devshops":{"get":{"operationId":"DevShopsController_getDevShopsByApplication","summary":"List dev shops","description":"Retrieves a list of all the authenticated app dev shops.","parameters":[],"responses":{"200":{"description":"Dev Shops List","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DevShopsListResponseDto"}}}}},"tags":["Dev Shops"],"security":[{"basic":[]}]}},"/devshops/{devShopId}/check-user-intersection/{userId}":{"get":{"operationId":"DevShopsController_getUserDevshopIntersectionChecking","summary":"Check user and dev shop intersection","description":"Checks if the user is in the dev shop range.","parameters":[{"name":"devShopId","required":true,"in":"path","schema":{"type":"string"}},{"name":"userId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Check user dev shop intersection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDevShopIntersectionCheckResponseDto"}}}}},"tags":["Dev Shops"],"security":[{"basic":[]}]}},"/app-usage/webhook-calls":{"get":{"operationId":"AppUsageController_findWebhookCalls","summary":"App Webhook calls","description":"Retrieves app webhook calls history. Available for data from the last three months of use.","parameters":[{"name":"startDate","required":true,"in":"query","description":"Start date to filter the history","example":"2023-05-10","schema":{"title":"Start date","format":"date-time","type":"string"}},{"name":"endDate","required":true,"in":"query","description":"End date to filter the history","example":"2023-05-10","schema":{"title":"End date","format":"date-time","type":"string"}},{"name":"notificationType","required":false,"in":"query","description":"(Optional) Available notification type","example":"TransactionFromEscrowFailure","schema":{"title":"Notification type","enum":["AuthenticationSuccess","AuthenticationFailure","ContainerExpired","RumbleTournamentNewParticipantAdded","RumbleTournamentParticipantStatusUpdated","RumbleTournamentClosed","RumbleTournamentCanceled","RumbleTournamentStatusUpdated","TransactionToEscrowCreated","TransactionToEscrowExpired","TransactionToEscrowSigned","TransactionToEscrowRejected","TransactionToEscrowFinal","TransactionToEscrowFailure","TransactionFromEscrowCreated","TransactionFromEscrowFinal","TransactionFromEscrowFailure","UserDisconnectedApplication"],"type":"string"}},{"name":"isSuccess","required":false,"in":"query","description":"(Optional) Usage in case of the attempted was succeeded","example":true,"schema":{"title":"Is Success","type":"boolean"}},{"name":"containerId","required":false,"in":"query","description":"(Optional) Applied only for notification types associated to container actions","example":12,"schema":{"title":"Container Id","type":"number"}},{"name":"currentPage","required":true,"in":"query","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppWebhookCallsResponseDto"}}}}},"tags":["Application Usage"],"security":[{"basic":[]}]}},"/rumble-tournament-settings":{"get":{"operationId":"RumbleTournamentSettingsController_findRumbleTournamentSettings","summary":"List rumble tournament settings","description":"Retrieves a list of rumble tournament settings by filtering query params.","parameters":[{"name":"currentPage","required":true,"in":"query","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"number"}},{"name":"maxParticipants","required":false,"in":"query","schema":{"type":"number"}},{"name":"minParticipants","required":false,"in":"query","schema":{"type":"number"}},{"name":"status","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindRumbleTournamentSettingsListResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]},"post":{"operationId":"RumbleTournamentSettingsController_createRumbleTournamentSettings","summary":"Create rumble tournament settings","description":"Creates a new rumble tournament settings.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRumbleTournamentSettingsRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RumbleTournamentSettingsResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournament-settings/{id}":{"get":{"operationId":"RumbleTournamentSettingsController_getRumbleTournamentSettings","summary":"Get rumble tournament settings","description":"Retrieves the rumble tournament settings informations.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RumbleTournamentSettingsResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]},"patch":{"operationId":"RumbleTournamentSettingsController_editRumbleTournamentSettings","summary":"Edit rumble tournament settings","description":"Edits a rumble tournament settings instance.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditRumbleTournamentSettingsRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RumbleTournamentSettingsResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments":{"post":{"operationId":"RumbleTournamentsController_create","summary":"Create new rumble tournament","description":"Creates a new rumble tournament for the application. It is required to have an active rumble tournament settings in place.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRumbleTournamentRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RumbleTournamentResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments/{id}/start":{"patch":{"operationId":"RumbleTournamentsController_startTournament","summary":"Start a rumble tournament","description":"Start a rumble tournament for the application. Requires the minimum configuration participants.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments/{id}/scores":{"post":{"operationId":"RumbleTournamentsController_registerScores","summary":"Register participant scores for a rumble tournament","description":"Register the scores of a list of participants. It is not required to send all the participant's scores at once.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterRumbleTournamentScoresRequestDto"}}}},"responses":{"204":{"description":""}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments/{id}/resolve":{"post":{"operationId":"RumbleTournamentsController_resolveTournament","summary":"Resolve rumble tournament","description":"Finish the tournament and start the resolution process. You must provide all scores before it or use the forceResolutionWithNullScore flag to force the resolution process.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveRumbleTournamentRequestDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoreboardResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments/{id}/cancel":{"post":{"operationId":"RumbleTournamentsController_cancelTournament","summary":"Cancel rumble tournament","description":"Cancel the tournament and return the assets to each original owner.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments/{id}":{"get":{"operationId":"RumbleTournamentsController_findRumbleTournament","summary":"Find rumble tournament","description":"Find a rumble tournament for the application.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RumbleTournamentResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments/{id}/join":{"post":{"operationId":"RumbleTournamentsController_join","summary":"Join a rumble tournament","description":"Join a specific user into a rumble tournament.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""}},"tags":["Tournaments"],"security":[{"bearer":[]}]}},"/rumble-tournaments/{id}/close-registration":{"patch":{"operationId":"RumbleTournamentsController_closeRumbleTournamentRegistration","summary":"Close a rumble tournament registration","description":"Closes a rumble tournament registration, blocking new users to join into it.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments/{id}/prize-distribution":{"get":{"operationId":"RumbleTournamentsController_getRumbleTournamentCurrentPrizeDistribution","summary":"Find rumble tournament current prize distribution","description":"Find the current prize distribution of a rumble tournament.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRumbleTournamentCurrentPrizeDistributionResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments/{id}/participants":{"get":{"operationId":"RumbleTournamentsController_findRumbleTournamentParticipants","summary":"Get rumble tournament participants list","description":"Gets the rumble tournament participants list.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"currentPage","required":true,"in":"query","schema":{"type":"number"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"number"}},{"name":"status","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindRumbleTournamentParticipantsListResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments/{id}/participants/{userId}":{"get":{"operationId":"RumbleTournamentsController_getRumbleTournamentParticipantInfo","summary":"Find rumble tournament participant information","description":"Find the rumble tournament participant information.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"userId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RumbleTournamentParticipantResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]}},"/rumble-tournaments/{id}/scoreboard":{"get":{"operationId":"RumbleTournamentsController_getRumbleTournamentScoreboard","summary":"Find rumble tournament scoreboard","description":"Find the rumble tournament result with the prize distribution.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScoreboardResponseDto"}}}}},"tags":["Tournaments"],"security":[{"basic":[]}]}}},"info":{"title":"Upland Developers API","description":"You can use the developer API to map user IDs, read information, and manage your app escrow container.","version":"1.0.0","contact":{}},"tags":[],"servers":[{"url":"https://api.prod.upland.me/developers-api"}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic","description":"Basic access authentication is a method to provide a username and password when making a request. In basic HTTP authentication, a request contains a header field in the form of (Authorization: Basic [credential]), where credentials is the Base64 encoding of ID and password joined by a single colon :. For our case, you must consider Username as app ID and password as secret key (this information can be generated in endpoint to create application)."},"bearer":{"type":"http","scheme":"bearer","description":"You must provide a Code to your users generated across the endpoint /auth/opt/init. When Upland User grants access for the developer App, a webhook will be sent with a valid access token."}},"schemas":{"OtpInitResposeDto":{"type":"object","properties":{"code":{"type":"string","description":"Connection code","example":"8JGXBU9G87","title":"Code"},"expireAt":{"format":"date-time","type":"string","description":"Code expiration date","example":"2023-06-14T13:41:22.364Z","title":"Expire At"}},"required":["code","expireAt"]},"HttpErrorDto":{"type":"object","properties":{"message":{"type":"string","title":"Message","description":"The cause of the Error"},"statusCode":{"type":"number","title":"Status Code","description":"Status code of the Error"},"error":{"type":"string","title":"Error","description":"(Optional) Name of the Error"}},"required":["message","statusCode"]},"LandVehicleLODResponseDto":{"type":"object","properties":{"level":{"type":"number","description":"Level of Detail (0, 1, or 2)","example":1,"title":"Level"},"modelUrl":{"type":"string","description":"Vehicle model URL","example":"https://image.upland.me/3d-models/cars/56/225/233/lods/0/model.gltf","title":"Model URL"},"textureUrl":{"type":"string","description":"Vehicle texture URL","example":"https://image.upland.me/3d-models/cars/66/41/21/4/lods/0/texture.jpg","title":"Texture URL"}},"required":["level","modelUrl","textureUrl"]},"LandVehicleAttributeResponseDto":{"type":"object","properties":{"name":{"type":"string","description":"Vehicle Property Name (Weight, Horsepower, Speed Rating, Acceleration, Braking, Handling, Energy Efficiency Rating, Reliability Rating, Durability Rating, Offroad Rating)","example":"Horsepower","title":"Vehicle Property Name"},"value":{"type":"number","description":"Property Value","example":10,"title":"Value"},"unit":{"type":"string","description":"(Optional) Property Unit","example":"hp","title":"Unit"}},"required":["name","value"]},"LandVehicleMetadataResponseDto":{"type":"object","properties":{"textureUrl":{"type":"string","deprecated":true,"description":"Vehicle texture URL (This field will be removed on the future versions. You can use the lods property to get more detailed information)","example":"https://image.upland.me/3d-models/cars/66/41/21/4/lods/0/texture.jpg","title":"Texture URL"},"lods":{"description":"List of Car's LODs","title":"LODs","type":"array","items":{"$ref":"#/components/schemas/LandVehicleLODResponseDto"}},"attributes":{"description":"List of Car's Attributes","title":"Attributes","type":"array","items":{"$ref":"#/components/schemas/LandVehicleAttributeResponseDto"}}},"required":["textureUrl","lods","attributes"]},"UserNftResponseDto":{"type":"object","properties":{"id":{"type":"number","description":"NFT ID","example":1,"title":"ID"},"category":{"type":"string","description":"NFT category","examples":["structure","blkexplorer","essential","memento","structornmt","landvehicle","spirithlwn","outdoordecor","jacktsai","racinglegits","uppie"],"title":"Category"},"name":{"type":"string","description":"NFT name","default":"townhouse"},"displayName":{"type":"string","description":"(Optional) NFT display name","example":"Micro House - Eldritch  Zombie","title":"Display name"},"rarityLevel":{"type":"string","description":"(Optional) NFT rarity level","example":"townhouse","title":"Rarity level"},"thumbnail":{"type":"string","description":"NFT thumbnail URL","example":"https://any-url.upland.me","title":"Thumbnail"},"mintNumber":{"type":"number","description":"NFT mint number","example":1,"title":"Mint number"},"modelUrl":{"type":"string","description":"(Optional) Model URL - applies only to cars","example":"https://image.upland.me/3d-models/cars/56/225/233/lods/0/model.gltf","title":"Model URL"},"metadata":{"description":"(Optional) Metadata object with specific information for each category","oneOf":[{"$ref":"#/components/schemas/LandVehicleMetadataResponseDto"

# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/upland/refs/heads/main/openapi/upland-developers-api-openapi.json