← API Reference
Konfiguration API
Users, rights, settings, notifications, i18n, credentials
Base URL: https://config-api.ayoune.app — 205 entities — Maschinenlesbare Beschreibung (JSON · YAML)
Beispiel
cURL
curl -H "Authorization: Bearer pat_your_token" \
https://config-api.ayoune.app/adaccounts?limit=10TypeScript SDK
import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');
const result = await ay.config.adAccounts.find().limit(10).exec();
console.log(result.payload());Entities
| Entity | REST Path | SDK | Zugriff | Right | |
|---|---|---|---|---|---|
| AdAccounts | /adaccounts |
ay.config.adAccounts |
CRUD | config.adaccounts |
|
| AdvertiserDomainMetas | /advertiserdomainmetas |
ay.config.advertiserDomainMetas |
CRUD | config.advertiserdomainmetas |
|
| AdvisorProfiles | /advisorprofiles |
ay.config.advisorProfiles |
CRUD | config.advisorprofiles |
|
| Affiliates | /affiliates |
ay.config.affiliates |
CRUD | config.affiliates |
|
| Airfields | /airfields |
ay.config.airfields |
CRUD | config.airfields |
|
| AlertCategories | /alertcategories |
ay.config.alertCategories |
CRUD | config.alertcategories |
|
| AlertSnoozes | /alertsnoozes |
ay.config.alertSnoozes |
CRUD | config.alertsnoozes |
|
| ApiKeys | /apikeys |
ay.config.apiKeys |
CRUD | config.apikeys |
|
| APIs | /apis |
ay.config.aPIs |
CRUD | config.apis |
|
| ApiUsageQuotas | /apiusagequotas |
ay.config.apiUsageQuotas |
CRUD | config.apiusagequotas |
|
| AppConfigs | /appconfigs |
ay.config.appConfigs |
CRUD | config.appconfigs |
|
| ApplicationLinks | /applicationlinks |
ay.config.applicationLinks |
CRUD | config.applicationlinks |
|
| Apps | /apps |
ay.config.apps |
CRUD | config.apps |
|
| Attachments | /attachments |
ay.config.attachments |
CRUD | config.attachments |
|
| AttributeGroups | /attributegroups |
ay.config.attributeGroups |
CRUD | config.attributegroups |
|
| Attributes | /attributes |
ay.config.attributes |
CRUD | config.attributes |
|
| aYOUneMenuOverrides | /ayounemenuoverrides |
ay.config.aYOUneMenuOverrides |
read-only | config.menuoverrides |
|
| Blacklists | /blacklists |
ay.config.blacklists |
CRUD | config.blacklists |
|
| BuildingSpaces | /buildingspaces |
ay.config.buildingSpaces |
CRUD | config.buildingspaces |
|
| BuildingSpaceStates | /buildingspacestates |
ay.config.buildingSpaceStates |
read-only | config.buildingspacestates |
|
| BusinessLocations | /businesslocations |
ay.config.businessLocations |
CRUD | config.businesslocations |
|
| CalculationGroups | /calculationgroups |
ay.config.calculationGroups |
CRUD | config.calculationgroups |
|
| CalculationRules | /calculationrules |
ay.config.calculationRules |
CRUD | config.calculationrules |
|
| CalculationSchemas | /calculationschemas |
ay.config.calculationSchemas |
CRUD | config.calculationschemas |
|
| Calendars | /calendars |
ay.config.calendars |
CRUD | config.calendars |
|
| CancelReasons | /cancelreasons |
ay.config.cancelReasons |
CRUD | config.cancelreasons |
|
| CardReaders | /cardreaders |
ay.config.cardReaders |
CRUD | config.cardreaders |
|
| Cashiers | /cashiers |
ay.config.cashiers |
CRUD | config.cashiers |
|
| ChainStores | /chainstores |
ay.config.chainStores |
CRUD | config.chainstores |
|
| CheckListTemplates | /checklisttemplates |
ay.config.checkListTemplates |
CRUD | config.checklisttemplates |
|
| ColorCodes | /colorcodes |
ay.config.colorCodes |
CRUD | config.colorcodes |
|
| CommissionGroups | /commissiongroups |
ay.config.commissionGroups |
CRUD | config.commissiongroups |
|
| CompanyLocations | /companylocations |
ay.config.companyLocations |
CRUD | config.companylocations |
|
| CompanyMilestones | /companymilestones |
ay.config.companyMilestones |
CRUD | config.companymilestones |
|
| ComputingEntities | /computingentities |
ay.config.computingEntities |
CRUD | config.computingentities |
|
| ComputingEntityTemplates | /computingentitytemplates |
ay.config.computingEntityTemplates |
CRUD | config.computingentitytemplates |
|
| ConfigurationMatchings | /configurationmatchings |
ay.config.configurationMatchings |
CRUD | config.configurationmatchings |
|
| ConfiguratorFields | /configuratorfields |
ay.config.configuratorFields |
CRUD | config.configuratorfields |
|
| Configurators | /configurators |
ay.config.configurators |
CRUD | config.configurators |
|
| ConnectionSubTypes | /connectionsubtypes |
ay.config.connectionSubTypes |
CRUD | config.connectionsubtypes |
|
| ConnectionTypes | /connectiontypes |
ay.config.connectionTypes |
CRUD | config.connectiontypes |
|
| ConsumerAPIs | /consumerapis |
ay.config.consumerAPIs |
CRUD | config.consumerapis |
|
| ContentCategories | /contentcategories |
ay.config.contentCategories |
CRUD | config.contentcategories |
|
| ContentSnippets | /contentsnippets |
ay.config.contentSnippets |
CRUD | config.contentsnippets |
|
| ControlPanels | /controlpanels |
ay.config.controlPanels |
CRUD | config.controlpanels |
|
| CostGroups | /costgroups |
ay.config.costGroups |
CRUD | config.costgroups |
|
| CostingAttributes | /costingattributes |
ay.config.costingAttributes |
CRUD | config.costingattributes |
|
| Counters | /counters |
ay.config.counters |
CRUD | config.counters |
|
| Credentials | /credentials |
ay.config.credentials |
CRUD | config.credentials |
|
| CustomAPIs | /customapis |
ay.config.customAPIs |
CRUD | config.customapis |
|
| CustomButtons | /custombuttons |
ay.config.customButtons |
CRUD | config.custombuttons |
|
| CustomConfigFiles | /customconfigfiles |
ay.config.customConfigFiles |
CRUD | config.customconfigfiles |
|
| CustomerDashboards | /customerdashboards |
ay.config.customerDashboards |
CRUD | config.customerdashboards |
|
| CustomerDatas | /customerdatas |
ay.config.customerDatas |
CRUD | config.customerdatas |
|
| CustomFunctionLogs | /customfunctionlogs |
ay.config.customFunctionLogs |
read-only | config.customfunctionlogs |
|
| CustomVariables | /customvariables |
ay.config.customVariables |
CRUD | config.customvariables |
|
| CustomViews | /customviews |
ay.config.customViews |
CRUD | config.customviews |
|
| DataCollections | /datacollections |
ay.config.dataCollections |
CRUD | config.datacollections |
|
| DataPools | /datapools |
ay.config.dataPools |
CRUD | config.datapools |
|
| DataTargets | /datatargets |
ay.config.dataTargets |
CRUD | config.datatargets |
|
| Departments | /departments |
ay.config.departments |
CRUD | config.departments |
|
| DiscountGroups | /discountgroups |
ay.config.discountGroups |
CRUD | config.discountgroups |
|
| DocumentExchanges | /documentexchanges |
ay.config.documentExchanges |
CRUD | config.documentexchanges |
|
| DocumentRenders | /documentrenders |
ay.config.documentRenders |
read-only | config.documentrenders |
|
| DocumentTemplates | /documenttemplates |
ay.config.documentTemplates |
CRUD | config.documenttemplates |
|
| Dois | /dois |
ay.config.dois |
CRUD | config.dois |
|
| Domains | /domains |
ay.config.domains |
CRUD | config.domains |
|
| DynamicContents | /dynamiccontents |
ay.config.dynamicContents |
CRUD | config.dynamiccontents |
|
| DynamicContentSnippets | /dynamiccontentsnippets |
ay.config.dynamicContentSnippets |
CRUD | config.dynamiccontentsnippets |
|
| EANPools | /eanpools |
ay.config.eANPools |
CRUD | config.eanpools |
|
| EconomicEvents | /economicevents |
ay.config.economicEvents |
CRUD | config.economicevents |
|
| EditeurThemas | /editeurthemas |
ay.config.editeurThemas |
CRUD | config.editeurthemas |
|
| EmailSnippets | /emailsnippets |
ay.config.emailSnippets |
CRUD | config.emailsnippets |
|
| EMailTemplates | /emailtemplates |
ay.config.eMailTemplates |
CRUD | config.emailtemplates |
|
| EmergencyTypes | /emergencytypes |
ay.config.emergencyTypes |
CRUD | config.emergencytypes |
|
| EnergyNodes | /energynodes |
ay.config.energyNodes |
CRUD | config.energynodes |
|
| Environments | /environments |
ay.config.environments |
CRUD | config.environments |
|
| ETIMs | /etims |
ay.config.eTIMs |
read-only | config.etims |
|
| EventMetas | /eventmetas |
ay.config.eventMetas |
CRUD | config.eventmetas |
|
| ExternalConversations | /externalconversations |
ay.config.externalConversations |
CRUD | config.externalconversations |
|
| ExternalMessages | /externalmessages |
ay.config.externalMessages |
CRUD | config.externalmessages |
|
| FamilyNames | /familynames |
ay.config.familyNames |
CRUD | config.familynames |
|
| FBApps | /fbapps |
ay.config.fBApps |
CRUD | config.fbapps |
|
| FBHooks | /fbhooks |
ay.config.fBHooks |
CRUD | config.fbhooks |
|
| Flags | /flags |
ay.config.flags |
CRUD | config.flags |
|
| Forms | /forms |
ay.config.forms |
CRUD | config.forms |
|
| GeneratedBriefings | /generatedbriefings |
ay.config.generatedBriefings |
read-only | config.generatedbriefings |
|
| Generations | /generations |
ay.config.generations |
CRUD | config.generations |
|
| GoogleAssistantIntents | /googleassistantintents |
ay.config.googleAssistantIntents |
CRUD | config.googleassistantintents |
|
| HashTags | /hashtags |
ay.config.hashTags |
CRUD | config.hashtags |
|
| Hooks | /hooks |
ay.config.hooks |
CRUD | config.hooks |
|
| HookTemplates | /hooktemplates |
ay.config.hookTemplates |
CRUD | config.hooktemplates |
|
| IABCategories | /iabcategories |
ay.config.iABCategories |
read-only | config.iabcategories |
|
| IABCategoryMappings | /iabcategorymappings |
ay.config.iABCategoryMappings |
CRUD | config.iabcategorymappings |
|
| ImportAllocations | /importallocations |
ay.config.importAllocations |
CRUD | config.importallocations |
|
| ImportConfigurations | /importconfigurations |
ay.config.importConfigurations |
CRUD | config.importconfigurations |
|
| ImportStatusReports | /importstatusreports |
ay.config.importStatusReports |
CRUD | config.importstatusreports |
|
| Industries | /industries |
ay.config.industries |
read-only | config.industries |
|
| InterestChannels | /interestchannels |
ay.config.interestChannels |
CRUD | config.interestchannels |
|
| Interests | /interests |
ay.config.interests |
CRUD | config.interests |
|
| Intermediaries | /intermediaries |
ay.config.intermediaries |
CRUD | config.intermediaries |
|
| InternalForms | /internalforms |
ay.config.internalForms |
CRUD | config.internalforms |
|
| IoTDevices | /iotdevices |
ay.config.ioTDevices |
CRUD | config.iotdevices |
|
| KPITemplates | /kpitemplates |
ay.config.kPITemplates |
CRUD | config.kpitemplates |
|
| LabelFormats | /labelformats |
ay.config.labelFormats |
CRUD | config.labelformats |
|
| LabelPrintJobs | /labelprintjobs |
ay.config.labelPrintJobs |
CRUD | config.labelprintjobs |
|
| LocalFeeds | /localfeeds |
ay.config.localFeeds |
CRUD | config.localfeeds |
|
| LocalFeedSamples | /localfeedsamples |
ay.config.localFeedSamples |
read-only | config.localfeedsamples |
|
| Localizations | /localizations |
ay.config.localizations |
CRUD | config.localizations |
|
| Locations | /locations |
ay.config.locations |
CRUD | config.locations |
|
| LockChallenges | /lockchallenges |
ay.config.lockChallenges |
read-only | config.lockchallenges |
|
| LogMonitors | /logmonitors |
ay.config.logMonitors |
CRUD | config.logmonitors |
|
| MachineGroups | /machinegroups |
ay.config.machineGroups |
CRUD | config.machinegroups |
|
| MachinePrograms | /machineprograms |
ay.config.machinePrograms |
CRUD | config.machineprograms |
|
| Machines | /machines |
ay.config.machines |
CRUD | config.machines |
|
| MachineTypes | /machinetypes |
ay.config.machineTypes |
CRUD | config.machinetypes |
|
| MailAccounts | /mailaccounts |
ay.config.mailAccounts |
CRUD | config.mailaccounts |
|
| Mailboxes | /mailboxes |
ay.config.mailboxes |
CRUD | config.mailboxes |
|
| Mails | /mails |
ay.config.mails |
CRUD | config.mails |
|
| MailTypes | /mailtypes |
ay.config.mailTypes |
CRUD | config.mailtypes |
|
| Manufacturers | /manufacturers |
ay.config.manufacturers |
CRUD | config.manufacturers |
|
| MeetingGroups | /meetinggroups |
ay.config.meetingGroups |
CRUD | config.meetinggroups |
|
| MessageTemplates | /messagetemplates |
ay.config.messageTemplates |
CRUD | config.messagetemplates |
|
| MicroServices | /microservices |
ay.config.microServices |
CRUD | config.microservices |
|
| Middlewares | /middlewares |
ay.config.middlewares |
CRUD | config.middlewares |
|
| Names | /names |
ay.config.names |
CRUD | config.names |
|
| NewsletterTypes | /newslettertypes |
ay.config.newsletterTypes |
CRUD | config.newslettertypes |
|
| NewsMonitors | /newsmonitors |
ay.config.newsMonitors |
CRUD | config.newsmonitors |
|
| NotificationPolicies | /notificationpolicies |
ay.config.notificationPolicies |
CRUD | config.notificationpolicies |
|
| NotificationPreferences | /notificationpreferences |
ay.config.notificationPreferences |
CRUD | config.notificationpreferences |
|
| OAuthAuthCodes | /oauthauthcodes |
ay.config.oAuthAuthCodes |
read-only | config.oauthauthcodes |
|
| OAuthClients | /oauthclients |
ay.config.oAuthClients |
CRUD | config.oauthclients |
|
| OAuthTokens | /oauthtokens |
ay.config.oAuthTokens |
read-only | config.oauthtokens |
|
| OfferCalculationSchemas | /offercalculationschemas |
ay.config.offerCalculationSchemas |
CRUD | config.offercalculationschemas |
|
| OnboardingTemplates | /onboardingtemplates |
ay.config.onboardingTemplates |
CRUD | config.onboardingtemplates |
|
| OpportunitySchemas | /opportunityschemas |
ay.config.opportunitySchemas |
CRUD | config.opportunityschemas |
|
| OwnDatas | /owndatas |
ay.config.ownDatas |
CRUD | config.owndatas |
|
| OwnDataTemplates | /owndatatemplates |
ay.config.ownDataTemplates |
CRUD | config.owndatatemplates |
|
| OwnValues | /ownvalues |
ay.config.ownValues |
CRUD | config.ownvalues |
|
| PaymentGroups | /paymentgroups |
ay.config.paymentGroups |
CRUD | config.paymentgroups |
|
| PaymentProviders | /paymentproviders |
ay.config.paymentProviders |
CRUD | config.paymentproviders |
|
| PermissionRequests | /permissionrequests |
ay.config.permissionRequests |
CRUD | config.permissionrequests |
|
| PostalCodes | /postalcodes |
ay.config.postalCodes |
CRUD | config.postalcodes |
|
| PreRenderMetas | /prerendermetas |
ay.config.preRenderMetas |
CRUD | config.prerendermetas |
|
| PriceGroups | /pricegroups |
ay.config.priceGroups |
CRUD | config.pricegroups |
|
| PriceRules | /pricerules |
ay.config.priceRules |
CRUD | config.pricerules |
|
| PricingTables | /pricingtables |
ay.config.pricingTables |
CRUD | config.pricingtables |
|
| ProcedureRuns | /procedureruns |
ay.config.procedureRuns |
CRUD | config.procedureruns |
|
| Procedures | /procedures |
ay.config.procedures |
CRUD | config.procedures |
|
| ProcedureSteps | /proceduresteps |
ay.config.procedureSteps |
CRUD | config.proceduresteps |
|
| ProductCats | /productcats |
ay.config.productCats |
CRUD | config.productcats |
|
| ProductDivisions | /productdivisions |
ay.config.productDivisions |
CRUD | config.productdivisions |
|
| ProductGroups | /productgroups |
ay.config.productGroups |
CRUD | config.productgroups |
|
| ProductionLines | /productionlines |
ay.config.productionLines |
CRUD | config.productionlines |
|
| ProductionProcesses | /productionprocesses |
ay.config.productionProcesses |
CRUD | config.productionprocesses |
|
| ProductionRules | /productionrules |
ay.config.productionRules |
CRUD | config.productionrules |
|
| ProductionSchemas | /productionschemas |
ay.config.productionSchemas |
CRUD | config.productionschemas |
|
| ProductRequirements | /productrequirements |
ay.config.productRequirements |
CRUD | config.productrequirements |
|
| ProductRewrites | /productrewrites |
ay.config.productRewrites |
CRUD | config.productrewrites |
|
| ProgrammableVoices | /programmablevoices |
ay.config.programmableVoices |
CRUD | config.programmablevoices |
|
| ProjectRequirements | /projectrequirements |
ay.config.projectRequirements |
CRUD | config.projectrequirements |
|
| ProjectTemplates | /projecttemplates |
ay.config.projectTemplates |
CRUD | config.projecttemplates |
|
| PrometheusConfigs | /prometheusconfigs |
ay.config.prometheusConfigs |
CRUD | config.prometheusconfigs |
|
| PronunciationEntries | /pronunciationentries |
ay.config.pronunciationEntries |
CRUD | config.pronunciationentries |
|
| Properties | /properties |
ay.config.properties |
CRUD | config.properties |
|
| QualityControlTemplates | /qualitycontroltemplates |
ay.config.qualityControlTemplates |
CRUD | config.qualitycontroltemplates |
|
| QualityControlTypes | /qualitycontroltypes |
ay.config.qualityControlTypes |
CRUD | config.qualitycontroltypes |
|
| Queries | /queries |
ay.config.queries |
CRUD | config.queries |
|
| RatingTemplates | /ratingtemplates |
ay.config.ratingTemplates |
CRUD | config.ratingtemplates |
|
| Requirements | /requirements |
ay.config.requirements |
CRUD | config.requirements |
|
| RewardRules | /rewardrules |
ay.config.rewardRules |
CRUD | config.rewardrules |
|
| SalesTemplates | /salestemplates |
ay.config.salesTemplates |
CRUD | config.salestemplates |
|
| SenderBrands | /senderbrands |
ay.config.senderBrands |
CRUD | config.senderbrands |
|
| Sensors | /sensors |
ay.config.sensors |
CRUD | config.sensors |
|
| Serials | /serials |
ay.config.serials |
CRUD | config.serials |
|
| Series | /series |
ay.config.series |
CRUD | config.series |
|
| Services | /services |
ay.config.services |
CRUD | config.services |
|
| Settings | /settings |
ay.config.settings |
CRUD | config.settings |
|
| ShippingBoxesTemplates | /shippingboxestemplates |
ay.config.shippingBoxesTemplates |
CRUD | config.shippingboxestemplates |
|
| ShippingChannels | /shippingchannels |
ay.config.shippingChannels |
CRUD | config.shippingchannels |
|
| Skills | /skills |
ay.config.skills |
CRUD | config.skills |
|
| SLAs | /slas |
ay.config.sLAs |
CRUD | config.slas |
|
| SMSTemplates | /smstemplates |
ay.config.sMSTemplates |
CRUD | config.smstemplates |
|
| States | /states |
ay.config.states |
CRUD | config.states |
|
| StorageAreas | /storageareas |
ay.config.storageAreas |
CRUD | config.storageareas |
|
| Streets | /streets |
ay.config.streets |
CRUD | config.streets |
|
| SubClients | /subclients |
ay.config.subClients |
CRUD | config.subclients |
|
| SubCompanies | /subcompanies |
ay.config.subCompanies |
CRUD | config.subcompanies |
|
| SubIndustries | /subindustries |
ay.config.subIndustries |
read-only | config.subindustries |
|
| SupportPortals | /supportportals |
ay.config.supportPortals |
CRUD | config.supportportals |
|
| Tags | /tags |
ay.config.tags |
CRUD | config.tags |
|
| TaskRequirements | /taskrequirements |
ay.config.taskRequirements |
CRUD | config.taskrequirements |
|
| Teams | /teams |
ay.config.teams |
CRUD | config.teams |
|
| TemplateGroups | /templategroups |
ay.config.templateGroups |
CRUD | config.templategroups |
|
| TerminalRoles | /terminalroles |
ay.config.terminalRoles |
CRUD | config.terminalroles |
|
| Terminals | /terminals |
ay.config.terminals |
CRUD | config.terminals |
|
| TextBlocks | /textblocks |
ay.config.textBlocks |
CRUD | config.textblocks |
|
| TriggerGroups | /triggergroups |
ay.config.triggerGroups |
CRUD | config.triggergroups |
|
| UserDailyBriefingConfigs | /userdailybriefingconfigs |
ay.config.userDailyBriefingConfigs |
CRUD | config.userdailybriefingconfigs |
|
| UserFunctions | /userfunctions |
ay.config.userFunctions |
CRUD | config.userfunctions |
|
| UserSettings | /usersettings |
ay.config.userSettings |
CRUD | config.usersettings |
|
| WageGroups | /wagegroups |
ay.config.wageGroups |
CRUD | config.wagegroups |
|
| Warehouses | /warehouses |
ay.config.warehouses |
CRUD | config.warehouses |
|
| WebReceivers | /webreceivers |
ay.config.webReceivers |
CRUD | config.webreceivers |
|
| Wizards | /wizards |
ay.config.wizards |
CRUD | config.wizards |