How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lokki Company API

The Company API from Lokki — 104 operation(s) for company.

Lokki Company API is one of 97 APIs that Lokki publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Company. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 107 operations across 104 paths, and defines 196 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against the base URL https://prod.api.eu-west-3.lokki.rent.

107 operations 104 paths 196 schemas 1 DELETE15 GET2 PATCH26 POST63 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://prod.api.eu-west-3.lokki.rent
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Lokki Company API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-access-token (x-access-token). By default, every request must be authenticated.

Paths & Operations 107

Across 104 paths, the API surfaces 107 operations — 1 DELETE, 15 GET, 2 PATCH, 26 POST, 63 PUT. Each is listed below with its method, path, parameters, and response codes.

Company 107
GET
/v2/company/currentCompany
getCurrentCompany → 200
PATCH
/v2/company
updateCompany body → 200
GET
/v2/company/slug/{slug}/{scope}
getCompanyBySlug 4 params → 200
GET
/v2/company/redirect-slug/{slug}
getCompanySlugRedirect 1 param → 200
GET
/v2/company/byID/{id}
getCompanyById 1 param → 200
GET
/v2/company/shopId/{companyId}
getCompanyShopId 1 param → 200
GET
/v2/company/isSlugUnique/{slug}
getIsSlugUnique 1 param → 200
GET
/v2/company/isNameUnique/{name}
getIsNameUnique 1 param → 200
GET
/v2/company/squareLocations
getSquareLocations → 200
GET
/v2/company/squareDevices
getSquareDevices → 200
GET
/v2/company/squareOAuthState
getSquareOAuthState → 200
GET
/v2/company/retro-2022
getRetro2022 → 200
GET
/v2/company/bilan-summer-2023
getSummer2023 → 200
POST
/v2/company/squareRevokeOauthToken
squareRevokeOauthToken → 201
POST
/v2/company/newCompanySquareDevice
createCompanyNewSquareDevice body → 201
POST
/v2/company/currency
updateCurrency body → 201
POST
/v2/company/updateCompanyOnlineStorePayment
updateCompanyOnlineStorePayment body → 201
POST
/v2/company/tulip/updateSettings
updateTulipSettings body → 201
POST
/v2/company/tulip/updateTulipSettingsWording
updateTulipSettingsWording body → 201
POST
/v2/company/tulip/updateTulipSettingsName
updateTulipSettingsName body → 201
POST
/v2/company/tulip/updateTulipSettingsDisplayedOptions
updateTulipSettingsDisplayedOptions body → 201
POST
/v2/company/updateOnlineStoreRentalPointType
updateOnlineStoreRentalPointType body → 201
POST
/v2/company/updateSocialMedia
updateSocialMedia body → 201
POST
/v2/company/timezone
updateTimezone body → 201
POST
/v2/company/opinionBooster
updateOpinionBooster body → 201
POST
/v2/company/onlineStoreSlots
updateOnlineStoreSlots body → 201
POST
/v2/company/orderReminder
updateOrderReminder body → 201
POST
/v2/company/multipleFundsTransfer
updateCompanyMultipleFundsTransfer body → 201
POST
/v2/company/delivery
updateDelivery body → 201
PUT
/v2/company/rentalPlace
updateCompanyRentalPlace body → 200
PUT
/v2/company/eventCGU
updateEventCgu body → 200
PUT
/v2/company/docCustomFields
updateCompanyDocumentCustomFields body → 200
PUT
/v2/company/customerTextRGPD
updateCompanyCustomerTextRGPD body → 200
PUT
/v2/company/documentColor
updateCompanyDocumentColor body → 200
PUT
/v2/company/cancellationPolicy
updateCancellationPolicy body → 200
PUT
/v2/company/newsletterSubscription
updateNewsletterSubscription body → 200
PUT
/v2/company/updateShowPricing
updateShowPricing body → 200
PUT
/v2/company/updateShowStock
updateShowStock body → 200
PUT
/v2/company/updateLLDBilling
updateLLDBilling body → 200
PUT
/v2/company/automatic-internal-start-date-attribution
updateAutomaticInternalStartDateAttribution body → 200
PUT
/v2/company/updateSlug
updateSlug body → 200
PUT
/v2/company/updateVatWorkshop
updateVatWorkshop body → 200
PUT
/v2/company/categoryDiscounts
updateCompanyCategoryDiscounts body → 200
PUT
/v2/company/hideOnlineStoreLCD
updateHideOnlineStoreLCD body → 200
PUT
/v2/company/hideOnlineStoreLLD
updateHideOnlineStoreLLD body → 200
PUT
/v2/company/updateSquareCredentialIsActive
updateSquareCredentialIsActive body → 200
PUT
/v2/company/updateSquareCredentialsLocation
updateSquareCredentialsLocation body → 200
PUT
/v2/company/eventDirectOrder
updateEventDirectOrder body → 200
PUT
/v2/company/toggleRentalPlace
activateRentalPlace body → 200
PUT
/v2/company/activateNewOnlineStoreDesign
activateNewOnlineStoreDesign body → 200
PUT
/v2/company/updateCompanyAccessOnlineContract
updateCompanyAccessOnlineContract body → 200
PUT
/v2/company/partPayment
updateCompanyOnlinePartPayment body → 200
PUT
/v2/company/partPaymentEvent
updateCompanyOnlinePartPaymentEvent body → 200
PUT
/v2/company/bailAccess
updateCompanyAccessBail body → 200
PUT
/v2/company/bailMax
updateCompanyBailMaxValue body → 200
PUT
/v2/company/eventBailMax
updateCompanyEventBailMaxValue body → 200
PUT
/v2/company/internalBailMax
updateInternalCompanyBailMaxValue body → 200
PUT
/v2/company/internalEventBailMax
updateInternalCompanyEventBailMaxValue body → 200
PUT
/v2/company/internalLLDBailMax
updateInternalCompanyLLDBailMaxValue body → 200
PUT
/v2/company/eventTags
updateCompanyEventTags body → 200
PUT
/v2/company/eventUniverses
updateCompanyEventUniverses body → 200
PUT
/v2/company/eventUniversesActivated
updateCompanyEventUniversesActivated body → 200
PUT
/v2/company/eventUniversesTag
updateCompanyEventUniversesTag body → 200
PUT
/v2/company/vat
updateCompanyVat body → 200
PUT
/v2/company/vatName
updateCompanyVatName body → 200
PUT
/v2/company/placeId
updateCompanyPlaceId body → 200
PUT
/v2/company/onlineStoreDescription
updateCompanyOnlineStoreDescription body → 200
PUT
/v2/company/termsConditions
updateCompanyTermsConditions body → 200
PUT
/v2/company/termsConditionsLLD
updateCompanyTermsConditionsLLD body → 200
PUT
/v2/company/onlineStoreFeaturedSectionTitle
updateCompanyOnlineStoreFeaturedSectionTitle body → 200
PUT
/v2/company/updateOnlineStorePhoneNumber
updateCompanyOnlineStorePhoneNumber body → 200
PUT
/v2/company/updateOnlineStoreDisplayPhoneNumber
updateCompanyOnlineStoreDisplayPhoneNumber body → 200
PUT
/v2/company/updateOnlineStoreFeaturedIds
updateCompanyOnlineStoreFeaturedIds body → 200
PUT
/v2/company/onlineStoreCustomFeaturedMode
updateCompanyOnlineStoreCustomFeaturedMode body → 200
PUT
/v2/company/onlineStoreEventsTitle
updateCompanyOnlineStoreEventTitle body → 200
PUT
/v2/company/productStateInfos
updateCompanyProductStateInfos body → 200
PUT
/v2/company/defaultPhoneCode
updateCompanyOnlineStoreDefaultPhoneCode body → 200
PUT
/v2/company/updateProductUnavailability
updateCompanyProductUnavailability body → 200
PUT
/v2/company/updateQuickOrderDefaultMode
updateCompanyQuickOrderDefaultMode body → 200
PUT
/v2/company/updateCompanyMainInfos
updateCompanyMainInfos body → 200
PUT
/v2/company/updateOfflinePin
updateCompanyOfflinePin body → 200
PUT
/v2/company/updateReservationTimes
updateCompanyReservationTimes body → 200
PUT
/v2/company/numberHoursOrder
updateNumberHoursOrderById body → 200
PUT
/v2/company/lowSeasonDates
updateLowSeasonDates body → 200
POST
/v2/company/uploadOnlineStoreImage
uploadOnlineStoreImage body → 201
POST
/v2/company/companyImage/{type}
uploadCompanyImage 1 param body → 201
POST
/v2/company/updateBannerScroll
updateCompanyOnlineStoreImageScroll body → 201
POST
/v2/company/ancv/registerShopID
registerShopID body → 201
GET
/v2/company/tulip/renter
getTulipRenter → 200
POST
/v2/company/tulip/config
updateCompanyTulipConfig body → 201
POST
/v2/company/tulip/link/{tulipId}
linkTulipId 1 param → 201
PUT
/v2/company/updateCompanyRentalPoints
updateCompanyRentalPoints body → 200
PUT
/v2/company/updateCompanyMailSender
updateCompanyMailSender body → 200
PUT
/v2/company/onlineStoreClosedDates
updateClosedDatesById body → 200
PUT
/v2/company/onlineStoreOpeningHours
updateOpeningHoursById body → 200
PUT
/v2/company/onlineStoreTimeLapsBeforeBooking
updateTimeLapsBeforeBookingById body → 200
PUT
/v2/company/csSupportRequested
updateCsSupportRequested body → 200
PUT
/v2/company/dayType
updateCompanyDayType body → 200
PATCH
/v2/company/settings
patchOneCompanySettings body → 200
POST
/v2/company/subscription/add-item
companySubscribeToModule body → 201
POST
/v2/company/subscription/remove-item
removeSubscriptionProduct body → 201
POST
/v2/company/subscription/update-item
updateSubscriptionProductPrice body → 201
GET
/v2/company/periodic-discounts
getManyPeriodicDiscounts → 200
POST
/v2/company/periodic-discounts
createOnePeriodicDiscount body → 201
GET
/v2/company/periodic-discounts/{periodicDiscountId}
getOnePeriodicDiscount 1 param → 200
PUT
/v2/company/periodic-discounts/{periodicDiscountId}
updateOnePeriodicDiscount 1 param body → 200
DELETE
/v2/company/periodic-discounts/{periodicDiscountId}
deleteOnePeriodicDiscount 1 param → 204

Schemas 196

The contract defines 196 schemas that model the data the API accepts and returns. The most detailed are Company (91 properties), OnlineStoreCompanyDto (81 properties), OnlineStoreConfig (34 properties), CompanyAccess (33 properties). Each schema is shown below with its type and property counts.

UpdateCompanyTulipSettingsWordingDto
object
2 properties 2 required
OpeningHoursRange
object
5 properties 5 required
CompanyRentalPlaceDescriptionsDto
object
2 properties 2 required
RentalPlaceStyle
object
4 properties
UpdateCompanyMainInfosDto
object
10 properties
UpdateVatWorkshopDto
object
1 property 1 required
FileUploadDto
object
1 property 1 required
UpdateCompanyOnlineStorePaymentDto
object
1 property 1 required
PeriodicDiscount
object
6 properties 5 required
RentalPlaceTextStyle
object
4 properties
CompanyAdyenCredentials
object
6 properties 6 required
UpdateCompanyOnlineStoreFeaturedIdsDto
object
1 property 1 required
UpdateSquareIsActiveDto
object
1 property 1 required
CompanyTimezone
object
1 property 1 required
CompanyEventUniversesActivatedDto
object
1 property 1 required
CompanyOrderReminder
object
7 properties 7 required
TulipOptions
object
6 properties 6 required
UpdateSquareCredentialLocationDto
object
2 properties 2 required
LocalizedReview
object
2 properties 1 required
CompanyRentalPlaceDto
object
8 properties 8 required
CompanyUpdateDefaultPhoneCodeDto
object
1 property 1 required
AncvConnectSettings
object
2 properties 2 required
PartPaymentDto
object
1 property 1 required
RentalPlaceFooter
object
5 properties 5 required
TulipTranslation
object
2 properties 2 required
CompanyPlaceIdDto
object
1 property 1 required
UpdateCompanyOnlineStoreSlotsDto
object
1 property 1 required
CompanyUser
object
8 properties 3 required
GetSquareOAuthStateDto
object
2 properties 2 required
CompanyHyperlineSubscriptionData
object
6 properties 6 required
UnsubscribeToModuleDto
object
1 property 1 required
ThemeMainStyles
object
3 properties 3 required
SubscribeToModuleDto
object
1 property 1 required
UpdateCompanyMailSenderDto
object
2 properties 2 required
UpdateCompanyProductAvailabilityDto
object
4 properties 4 required
CompanyActivateNewOnlineStoreDesignDto
object
1 property 1 required
SocialMedia
object
5 properties 5 required
TulipRenter
object
3 properties 3 required
TulipSettings
object
8 properties 8 required
Trackers
object
8 properties
UpdateSubscriptionModulePrice
object
3 properties 2 required
CompanyTrialInfos
object
4 properties 1 required
RegisterShopIdBodyDto
object
1 property 1 required
UpdateCompanyTimezoneDto
object
1 property 1 required
UpdateCsSupportRequestedDto
object
1 property 1 required
ReservationTime
object
3 properties 3 required
RentalPlaceFile
object
3 properties 2 required
CompanyAccess
object
33 properties 33 required
LowSeasonDateRange
object
3 properties 3 required
UpdateCompanyOnlineStorePhoneNumberDto
object
1 property 1 required
EventTag
object
2 properties 2 required
CompanyEventUniversesTagDto
object
1 property 1 required
ThemeCompanyName
object
1 property 1 required
CompanyUpdateDto
object
2 properties
CompanyRetro2022Infos
object
3 properties 3 required
OpeningTimeFrame
object
5 properties 3 required
UpdateCompanyProductStateInfosDto
object
4 properties 4 required
CreateUpdatePeriodicDiscountDto
object
5 properties 4 required
CompanyHideOnlineStoreLCDDto
object
1 property 1 required
UniverseMinimumPrice
object
2 properties 2 required
CompanyBailMaxAmount
object
2 properties 2 required
CompanyRentalPlaceTeamDto
object
4 properties 4 required
ThemeTitle
object
1 property 1 required
CompanyCategoryDiscount
object
2 properties 2 required
CompanyVatNameDto
object
1 property 1 required
CompanyMailSender
object
2 properties 2 required
SquareDevices
object
6 properties 4 required
CompanyCustomerTextRGPDDto
object
1 property 1 required
CompanySkisetInfos
object
9 properties 9 required
CompanyDelivery
object
8 properties 8 required
UpdateLowSeasonDateDto
object
1 property 1 required
UpdateCompanyTulipConfigDto
object
2 properties 2 required
EventUniverse
object
3 properties 3 required
Company
object
91 properties 71 required
MarketingSettings
object
1 property 1 required
ThemeColors
object
9 properties 9 required
EventStatsOnlineStore
object
16 properties 13 required
UpdateClosedDatesDto
object
1 property 1 required
RentalPlaceNetworkUpdatedBy
object
2 properties 2 required
RentalPlaceMainInfo
object
6 properties 6 required
UpdateCompanyOpinionBooster
object
1 property 1 required
UpdateCompanyTulipSettingsNameDto
object
1 property 1 required
ClosedDatesRange
object
3 properties 3 required
CompanyEventTagUpdateDto
object
1 property 1 required
UpdateCompanyQuickOrderDefaultModeDto
object
9 properties 9 required
CompanyUploadImageDto
object
4 properties 4 required
LokkiPaymentTermsConditionsHistory
object
2 properties 2 required
OnlineStoreCompanyDto
object
81 properties 73 required
RentalPlaceNetwork
object
3 properties 3 required
CompanyLLDBillingDto
object
1 property 1 required
CompanyCurrency
object
2 properties 2 required
TagValue
object
4 properties 3 required
UpdateCompanyOnlineStoreEventsTitleDto
object
1 property 1 required
UpdateCompanyBannerScrollDto
object
1 property 1 required
UpdateCompanyOnlineStoreCustomFeaturedModeDto
object
1 property 1 required
CompanySlugDto
object
1 property 1 required
UpdateCompanyTulipSettingsDto
object
4 properties 4 required
GoogleRating
object
6 properties 6 required
CompanyFee
object
4 properties 3 required
CompanyEventDirectOrderDto
object
1 property 1 required
CompanyRentalPlaceUniversesDto
object
3 properties 3 required
PartPayment
object
2 properties 2 required
UpdateCompanyTermsConditionsDto
object
1 property 1 required
AllowedCompanyAccessPropertiesDto
object
3 properties
SquareLocation
object
2 properties 2 required
TulipOptionProductContentSubType
object
2 properties 2 required
OnlineStoreCompanyAccessDto
object
16 properties 16 required
ProductStateInfo
object
5 properties 5 required
CompanyAddressComponentsDto
object
8 properties 8 required
ThemeTextStyle
object
4 properties 4 required
UpdateCompanyOnlineStoreDescriptionDto
object
1 property 1 required
LPTermConditionV0102
object
2 properties 2 required
CompanyCsSupportRequested
object
2 properties 2 required
TulipCompanyInfo
object
9 properties 9 required
Coordinate
object
2 properties 2 required
TulipOptionProduct
object
3 properties 3 required
UpdateCompanyCurrencyDto
object
1 property 1 required
OnlineStoreUniverseDto
object
6 properties 6 required
CompanyOnlineStoreSlot
object
4 properties 4 required
UpdateCompanyOnlineStoreDisplayPhoneNumberDto
object
1 property 1 required
CancellationPolicyDto
object
9 properties 9 required
CompanyTheme
object
6 properties 5 required
PatchCompanySettingsDto
object
8 properties
OnlineStoreMarketingTrackers
object
6 properties
CompanyDefaultQuickOrderMode
object
9 properties 9 required
TulipSettingsWithRenter
object
9 properties 9 required
CompanyShowcaseProductDto
object
2 properties 2 required
CompanyNewsletterSubscriptionDto
object
1 property 1 required
ThemeBlockColor
object
2 properties 2 required
UpdateTimeLapseBeforeBookingDto
object
1 property 1 required
CompanyGlobalFee
object
3 properties 3 required
ReservationRanges
object
2 properties 2 required
CompanyStripeCredentials
object
5 properties 4 required
UpdateNumberHoursOrderDto
object
2 properties 2 required
RentalPlaceFooterLinkSocial
object
5 properties 5 required
CompanyCsInfos
object
25 properties 12 required
UpdateCompanyAddressComponentsDto
object
8 properties 8 required
CompanyVatDto
object
1 property 1 required
CompanyResponseDuration
object
6 properties 6 required
UpdateCompanyRentalPointsDto
object
1 property 1 required
CompanyDocumentCustomFieldsDto
object
1 property 1 required
LocalizedContent
object
CompanyCategoryDiscountRange
object
5 properties 5 required
OnlineStoreConfig
object
34 properties 34 required
Pricing
object
3 properties 3 required
SquareCredentials
object
7 properties 6 required
RentalPoint
object
11 properties 10 required
UpdateCompanyOrderReminderDto
object
1 property 1 required
CompanyDocumentCustomField
object
3 properties 3 required
RentalPlaceFooterLinkCol
object
4 properties 4 required
UpdateOnlineStoreRentalPointTypeDto
object
1 property 1 required
Item
object
3 properties 3 required
UpdateCompanyAccessOnlineContractDto
object
1 property 1 required
MultipleFundsTransfer
object
4 properties 1 required
UpdateCompanyTulipSettingsDisplayedOptionsDto
object
1 property 1 required
CompanyEventUniversesUpdateDto
object
1 property 1 required
UpdateCompanyMultipleFundsTransferDto
object
1 property 1 required
DeliveryRangeSpecificPrice
object
2 properties 2 required
DeliveryRange
object
4 properties 4 required
UpdateCompanyDayTypeDto
object
1 property 1 required
OnlineStoreCompanyAdyenPayment
object
2 properties 2 required
CompanyUpdateCategoryDiscountsDto
object
1 property 1 required
UpdateCompanyDeliveryDto
object
10 properties
BailAccessDto
object
1 property 1 required
CompanyShowPricingDto
object
1 property 1 required
CompanyFeePayment
object
2 properties 2 required
CompanyOnboarding
object
3 properties
UpdateFeaturedSectionTitleDto
object
1 property 1 required
Category
object
3 properties 3 required
CompanyHideOnlineStoreLLDDto
object
1 property 1 required
SelfTestUtmInfos
object
11 properties
CompanyLifecycleEvents
object
1 property
WorkshopLocation
object
6 properties 6 required
BailMaxValueDto
object
2 properties 2 required
DateRange
object
3 properties 3 required
ProposedRentalPlaceCommission
object
3 properties 3 required
UpdateOpeningHoursDto
object
1 property 1 required
CompanyFeePayments
object
5 properties 5 required
LokkiPaymentMethods
object
12 properties 12 required
CompanyActivateRentalPlaceDto
object
1 property 1 required
CompanyShowStockDto
object
1 property 1 required
CompanyAutomaticInternalStartDateAttributionDto
object
1 property 1 required
ReservationRange
object
2 properties 2 required
CompanyOpinionBooster
object
4 properties 4 required
CompanyDocumentColorDto
object
1 property 1 required
UpdateCompanyReservationTimesDto
object
1 property 1 required
OnlineStoreCompanyStripePayment
object
3 properties 3 required
ThemeButtonStyle
object
3 properties 3 required
ThemeButton
object
2 properties 2 required
UpdateSocialMediaDto
object
5 properties 5 required
CompanyDeliveryCity
object
5 properties 5 required
UpdateCompanyRentalPointDto
object
12 properties
ProposedRentalPlaceCommissionDto
object
1 property 1 required
CreateCompanySquareDeviceDto
object
1 property 1 required
GoogleReview
object
5 properties 5 required
UpdateCompanyOfflinePinDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lokki-company-api-openapi.yml Raw ↑

Other APIs Lokki publishes across the network.

Lokki Action Log API
Lokki Admin API
Lokki Ahrefs API
Lokki Ancv API
Lokki Api Key API
Lokki Api Key V2 API
Lokki Auth API
Lokki Aws S3 API
Lokki Bookings API
Lokki Business Registry API
Lokki Cart Suggestion API
Lokki Catalogue API
Where this information came from

This is an independent, third-party profile of Lokki Company API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.