Resources

These are the 84 resource types of the registry the MCP server uses, which is checked against the services’ controllers. The operations and actions are the ones the MCP server offers; a few services have more (3 types are read-only through MCP, such as Identity’s clients, which the API can create and change). For request and response bodies, see the API reference of the launch services in the sidebar.

• Routes are https://api.nimles.com/{service}/api/tenant/{tenantId}/{Route}; an item is {Route}/{id} with a GUID id.
• Operations: list is GET {Route}, get is GET {Route}/{id}, create is POST {Route}, put and patch are PUT/PATCH {Route}/{id}, delete is DELETE {Route}/{id}.
• Actions: item actions are {Route}/{id}/{action}, collection actions {Route}/{action} (marked collection). Most are PUT; the API reference has the method of each.
• List filters are query parameters of GET {Route}. Lists are not paged: use GraphQL for paging.
• Accessibility, resource group and organization are set at create. The only move between resource groups is directory.profiles move.
• PATCH changes what PUT changes. The platform members (id, tenantId, resourceGroupId, organizationId, version, accessibility, …) cannot be patched.

Identity

Base URL: https://api.nimles.com/identity/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
identity.tenants	Tenants	list, get, put, patch	–	–	Tenants (platforms). Lists only the current tenant; settings such as host names, domains, languages and login providers.
identity.users	Users	list, get, put, patch, delete	me (collection)	onlyCurrentUser, username	Users of the tenant: names, emails, phone, role. The me action returns the signed-in user.
identity.resourceGroups	ResourceGroups	list, get, create, put, patch, delete	–	ids, organizationId, parentId	Resource groups (workspaces): the tree that scopes content and access. Create with parentId or organizationId.
identity.organizations	Organizations	list, get, create, put, patch, delete	add-member, remove-member, ssoDefaultAccess	ids, memberId, name, uniqueName	Organizations (companies) in the tenant, with members, domains and SSO login providers.
identity.groups	Groups	list, get, create, put, patch, delete	add-member, remove-member	ids	User groups, used as principals in role assignments.
identity.roleDefinitions	RoleDefinitions	list, get, create, put, patch, delete	builtIn (collection)	–	Role definitions: named sets of allowed and denied actions (e.g. Nimles.Pim/products/write).
identity.roleAssignments	RoleAssignments	list, get, create, delete	–	principalId	Role assignments: a role definition given to a user or group at a tenant, organization or resource group scope.
identity.invites	Invites	list, get, create, delete	approve	organizationId, requiresApproval	Invites that give an email address a role at a scope once accepted; also join requests to approve.
identity.clients	Clients	list, get	–	ids	Read-only through MCP. OAuth/OIDC clients (applications) of the tenant: grant types, scopes, redirect URIs.

Directory

Base URL: https://api.nimles.com/directory/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
directory.profiles	Profiles	list, get, create, put, patch, delete	publish, unpublish, publication-requests (collection), request-publication, reject-publication, move	ids	Directory profiles: businesses or people with contact details, address, categories, logo and opening hours.
directory.sites	Sites	list, get, create, put, patch, delete	–	ids	Sites: physical or web locations with address, sections, sales points and opening hours.
directory.categories	Categories	list, get, create, put, patch, delete	publish, unpublish	ids	Directory categories (a tree via parentId) that profiles are listed under.
directory.contacts	Contacts	list, get, create, put, patch, delete	–	ids, profileId	Contact persons of a directory profile.

Media

Base URL: https://api.nimles.com/media/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
media.files	Files	list, get, create, put, patch, delete	–	resourceGroupId, ids, folderId	Media files (images, documents). Create with uri: a data URI uploads the bytes, any other URL is linked.
media.folders	Folders	list, get, create, put, patch, delete	–	resourceGroupId, ids, parentId	Media folders (a tree; create with parentId).

Work management

Base URL: https://api.nimles.com/work-management/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
workManagement.workItems	WorkItems	list, get, create, put, patch, delete	history	resourceGroupId, ids	Work items (epics, features, stories, tasks, bugs…) with title, status, assignees and typed custom fields.
workManagement.workItemTypes	WorkItemTypes	list, get, create, put, patch, delete	–	resourceGroupId, ids	Work item types: field definitions, default fields and the states a work item moves through.
workManagement.boards	Boards	list, get, create, put, patch, delete	–	resourceGroupId, ids, parentId	Boards with columns of work items (kanban, roadmap…).
workManagement.links	Links	list, get, create, put, patch, delete	–	resourceGroupId, ids	Links between work items (parent/child, related, blocks…).
workManagement.comments	Comments	list, get, create, put, patch, delete	–	resourceGroupId, workItemId	Comments on work items.
workManagement.areas	Areas	list, get, create, put, patch, delete	–	resourceGroupId, ids, parentId	Areas of a workspace: the teams or parts of the product that own work. They nest through parentId; a work item’s areaId points at one.
workManagement.iterations	Iterations	list, get, create, put, patch, delete	–	resourceGroupId, ids, parentId	Iterations of a workspace (sprints, releases) with optional startDate and finishDate. They nest through parentId; a work item’s iterationId points at one.
workManagement.teams	Teams	list, get, create, put, patch, delete	–	resourceGroupId, ids, memberId	Teams of a workspace: the areas they work in (areaIds), the iterations they plan in (iterationIds), their current iteration and their members (users or groups).
workManagement.personas	Personas	list, get, create, put, patch, delete	–	resourceGroupId, ids	Personas (target users) with goals, pain points and behaviours.
workManagement.votes	Votes	list, get, create, delete	–	resourceGroupId, workItemId	Votes on work items (one per user and item).

CMS

Base URL: https://api.nimles.com/cms/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
cms.pages	Pages	list, get, create, put, patch, delete	publish, unpublish	ids	CMS pages: title, unique name (the URL slug), elements tree, template and SEO texts.
cms.posts	Posts	list, get, create, put, patch, delete	publish, unpublish	ids	CMS posts (blog posts, news): title, content, author, tags, image and start date.
cms.layouts	Layouts	list, get, create, put, patch, delete	publish, unpublish	ids	CMS layouts: the frame (header, footer, theme, host name) that pages render in.
cms.texts	Texts	list, get, create, put, patch, delete	publish, unpublish	ids	CMS texts: named translation sets used by sites.
cms.themes	Themes	list, get, create, put, patch, delete	publish, unpublish	ids	CMS themes: styles and CSS that layouts use.
cms.elementTemplates	ElementTemplates	list, get, create, put, patch, delete	publish, unpublish	ids	CMS element templates: reusable page elements.

E-commerce

Base URL: https://api.nimles.com/e-commerce/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
ecommerce.orders	Orders	list, get, create, put, patch, delete	addmessage, submit, withdraw, reject, approve, reserve, confirm, startpreparing, finishpreparing, startprocessing, finishprocessing, initializedelivery, completedelivery, close, archive, unarchive	buyerResourceGroupId, buyerSiteId, buyerUserId, excludeArchived, excludeCompleted, excludeDraft, format, sellerResourceGroupId, sellerSiteId, sellerUserId, onlyPrivate	Orders between a buyer and a seller: head (number, status, totals, parties), lines and events.
ecommerce.quoteRequests	QuoteRequests	list, get, create, put, patch, delete	addmessage, submit, withdraw, reject, close, approve, archive, unarchive	buyerResourceGroupId, buyerSiteId, buyerUserId, excludeArchived, excludeCompleted, excludeDraft, format, sellerResourceGroupId, sellerSiteId, sellerUserId, onlyIndividuals, onlyPublic	Quote requests: a buyer asks sellers for a quote.
ecommerce.quotes	Quotes	list, get, create, put, patch, delete	addmessage, submit, withdraw, reject, close, accept, archive, unarchive	buyerResourceGroupId, buyerSiteId, buyerUserId, excludeArchived, excludeCompleted, excludeDraft, format, sellerResourceGroupId, sellerSiteId, sellerUserId, includePublic, onlyPrivate	Quotes: a seller’s offer, often answering a quote request.
ecommerce.carts	Carts	list, get, create, put, patch	item, inactivate	resourceGroupId, cartUser, isActive	Shopping carts with items (product, variant, quantity) and a discount.
ecommerce.customers	Customers	list, get, create, put, patch, delete	–	ids	Customers of a seller: buyer/seller details, references and payment methods.
ecommerce.deliveries	Deliveries	list, get, create, put, patch, delete	initialize, execute, complete	ids, buyerResourceGroupId, orderId, sellerResourceGroupId	Deliveries of orders: number, status, delivery option, items and amounts.
ecommerce.deliveryOptions	DeliveryOptions	list, get, create, put, patch, delete	activate, deactivate	resourceGroupId, ids	Delivery options a seller offers (pickup, shipping…), with price and delivery time.
ecommerce.discounts	Discounts	list, get, create, put, patch, delete	deactivate, redeem, validate (collection)	resourceGroupId	Discounts and discount codes with value, validity period and redemption limits.
ecommerce.logisticsOptions	LogisticsOptions	list, get, create, put, patch, delete	activate, deactivate	resourceGroupId, ids	Logistics options (warehouses, carriers) used for stock and delivery.
ecommerce.payments	Payments	list, get, create, put, patch, delete	initialize, execute, complete	ids, buyerResourceGroupId, orderId, sellerResourceGroupId	Payments of orders: number, status, payment option, processor and amounts.
ecommerce.paymentOptions	PaymentOptions	list, get, create, put, patch, delete	activate, deactivate, connect, onboarding	resourceGroupId, ids	Payment options a seller offers (card, invoice…), with processor, price and terms.
ecommerce.pricelists	Pricelists	list, get, create, put, patch, delete	–	resourceGroupId, ids, limit, order, start	Price lists: prices per product and variant, currency and countries.
ecommerce.productStocks	ProductStocks	list, get, create, put, patch, delete	–	resourceGroupId, ids	Stock levels per product variant and logistics option.
ecommerce.schedules	Schedules	list, get, create, put, patch	–	resourceGroupId	Schedules: bookable sessions for a site, item, product or user.
ecommerce.subscriptions	Subscriptions	list, get	–	ids, organizationId, workspaceId	Read-only through MCP. Plan subscriptions of workspaces (plan, status, seats, period); billing runs through Stripe.

PIM

Base URL: https://api.nimles.com/pim/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
pim.products	Products	list, get, create, put, patch, delete	publish, unpublish, add-variant, update-variant, remove-variant	productGroupId	Products: names, descriptions, SKU/GTIN, prices, images, properties, product groups and variants.
pim.productGroups	ProductGroups	list, get, create, put, patch, delete	publish, unpublish	–	Product groups (a tree via parentId) that organize products and define their properties.
pim.productProperties	ProductProperties	list, get, create, put, patch, delete	–	–	Product properties: typed attributes (with options and unit) that products in a group can have.
pim.productMenus	ProductMenus	list, get, create, put, patch, delete	publish, unpublish	–	Product menus (e.g. a weekly lunch menu) that group product groups into menu groups.
pim.reviews	Reviews	list, get, create, put, patch, delete	publish, unpublish	–	Reviews of a target (product, profile…) with pros, cons, scores and texts.
pim.reviewGroups	ReviewGroups	list, get, create, put, patch, delete	publish, unpublish	–	Review groups that collect reviews (a tree via parentId).

CRM

Base URL: https://api.nimles.com/crm/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
crm.relationships	Relationships	list, get, create, put, patch, delete	–	ids, parentId	CRM relationships: a contact (person or company) with email, phones and address, optionally under a parent.
crm.pipelines	Pipelines	list, get, create, put, patch, delete	–	ids	Sales pipelines with stages.
crm.deals	Deals	list, get, create, put, patch, delete	–	ids, pipelineId, relationshipId	Deals (sales opportunities) with a name and notes, optionally in a pipeline stage and for a relationship.
crm.forms	Forms	list, get, create, put, patch, delete	–	ids	Forms (field definitions in groups) that visitors submit.
crm.formSubmissions	FormSubmissions	list, get, create, put, patch, delete	–	ids, formId	Submissions of a form, with the submitted field values.
crm.messages	Messages	list, get, create	–	ids, conversationId	CRM messages (emails in a conversation). Messages cannot be changed or deleted.

LMS

Base URL: https://api.nimles.com/lms/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
lms.courses	Courses	list, get, create, put, patch, delete	sync, provider-course (collection), classroom-courses (collection), classroom-import (collection)	ids, parentId	Courses: title, section, dates, enrollment code and items; optionally synced from a provider.
lms.subjects	Subjects	list, get, create, put, patch, delete	sync, provider-subjects (collection)	ids, parentId	Subjects (syllabus level above courses) with purpose, dates and items.
lms.courseworks	Courseworks	list, get, create, put, patch, delete	–	ids, courseId, topicId	Coursework (assignments) of a course: due date, points, type and status.
lms.topics	Topics	list, get, create, put, patch, delete	–	ids, courseId	Topics that group coursework within a course.
lms.submissions	Submissions	list, get, create, put, patch, delete	–	ids, courseId, courseworkId	Learners’ submissions for coursework.
lms.cohorts	Cohorts	list, get, create, put, patch, delete	–	ids, courseId	Cohorts (classes, groups of learners) of a course with dates and columns.
lms.learners	Learners	list, get, create, put, patch, delete	–	ids, courseId	Learners (students) enrolled in a course.
lms.instructors	Instructors	list, get, create, put, patch, delete	–	ids, courseId	Instructors (teachers) of a course.
lms.assessments	Assessments	list, get, create, put, patch, delete	–	ids, courseId	Assessments (grades, evaluations) of a user in a course.
lms.assertions	Assertions	list, get, create, put, patch, delete	–	ids, courseId	Assertions: badges awarded to a user (Open Badges).
lms.badgeClasses	BadgeClasses	list, get, create, put, patch, delete	–	ids, courseId	Badge classes: the badges that can be awarded in a course.
lms.pointClasses	PointClasses	list, get, create, put, patch, delete	–	ids, courseId	Point classes: kinds of points learners can earn.
lms.pointStatistics	PointStatistics	list, get, create, put, patch, delete	–	ids, courseId	Point statistics: a user’s earned points in a course.

Property management

Base URL: https://api.nimles.com/property-management/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
propertyManagement.realEstates	RealEstates	list, get, create, put, patch, delete	sync, provider-search (collection), provider-at (collection), provider-get (collection)	ids, cadastralReference	Real estates (properties): cadastral reference, address, plot, buildings and owners.
propertyManagement.realEstateRecords	RealEstateRecords	list, get, create, put, patch, delete	–	ids, realEstateId	Records of a real estate (purchases, costs, valuations…) with dates and prices.
propertyManagement.vehicles	Vehicles	list, get, create, put, patch, delete	lookup (collection)	ids, licensePlate, vin	Vehicles: license plate, VIN, brand, model, year, fuel, mileage and owners.
propertyManagement.vehicleRecords	VehicleRecords	list, get, create, put, patch, delete	–	ids, vehicleId	Records of a vehicle (service, repairs, costs) with date, mileage and prices.
propertyManagement.assets	Assets	list, get, create, put, patch, delete	–	ids	Other assets (equipment, machines…) with brand, model, serial number, condition and owners.

Accounting

Base URL: https://api.nimles.com/accounting/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
accounting.books	Books	list, get, create, put, patch, delete	–	ids, organizationId	Accounting books (ledgers) of an organization.
accounting.accounts	Accounts	list, get, create, put, patch, delete	–	ids, organizationId	Accounts in a book (chart of accounts): number, name and type.
accounting.bankAccounts	BankAccounts	list, get, create, put, patch, delete	–	ids, organizationId	Bank accounts of an organization.
accounting.records	Records	list, get, create, put, patch, delete	–	ids, organizationId, bookId, transactionId	Accounting records (bookkeeping entries) on an account in a book, optionally linked to a bank transaction.
accounting.transactions	Transactions	list, get, create, put, patch, delete	–	ids, organizationId, bankAccountId	Bank transactions on a bank account.
accounting.transactionBatches	TransactionBatches	create	–	–	Imports many bank transactions at once (create only).

Communication

Base URL: https://api.nimles.com/communication/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
communication.mails	Mails	list, get	–	ids, direction	Read-only through MCP. Mails the platform sent and received; received ones have inbound (envelope, attachments, spam check).

AI

Base URL: https://api.nimles.com/ai/api/tenant/{tenantId}/

Type	Route	Operations	Actions	List filters	Description
ai.agents	Agents	list, get, create, put, patch, delete	chat, suggestions, sessions, create-session, get-session, send-message, clear-session, delete-session	–	AI agents: a slug (agentId), system prompt, model deployment and tools; chat with them in sessions.

Notes per resource

• identity.tenants: Creating and deleting tenants is a platform operation and is not offered. GET Tenants in a tenant returns only that tenant. Host name, identity domain, domains, login providers, default client, allowed origins and unique name are platform settings: only a platform administrator can change them (a patch that does gets 422). Login-provider secrets and tokens are write-only: reads return them empty, with hasClientSecret/hasToken telling whether one is stored. Not created in a resource group. Masked in output: loginProviders.*.clientSecret, loginProviders.*.token.
• identity.users: Users join through invites or sign-up, so create is not offered. Password, email and verification routes are not exposed. Not created in a resource group. Masked in output: password.
• identity.resourceGroups: Accessibility (set_accessibility) takes Public, Private or Inherit and needs resourceGroups/write tenant-wide. Media files with Inherit follow their group: a Public group makes its files public on the content host. Create needs name. Not created in a resource group. organizationId is set at create only.
• identity.organizations: Login providers and domains are set with dedicated endpoints that the MCP does not expose. Login-provider secrets and tokens are never returned: reads carry them empty, with hasClientSecret/hasToken telling whether one is stored. Create needs name, uniqueName. Not created in a resource group. Masked in output: loginProviders.*.clientSecret, loginProviders.*.token.
• identity.groups: Create needs name.
• identity.roleDefinitions: Create needs name, actions.
• identity.roleAssignments: There is no update: delete the assignment and create a new one. principalType is User, Group or Client (the kind of principalId). Create needs principalId, principalType, roleDefinitionId, scope. Not created in a resource group.
• identity.invites: Create needs email, roleDefinitionId, scope. Not created in a resource group. Masked in output: inviteCode.
• identity.clients: Client secrets are stored hashed (secrets.*.value is never the secret). Login-provider secrets and tokens are never returned: reads carry them empty, with hasClientSecret/hasToken telling whether one is stored. Masked in output: secrets.*.value, loginProviders.*.clientSecret, loginProviders.*.token.
• directory.profiles: Publishing needs Nimles.Directory/profiles/publish; without it use request-publication. Create needs name. GraphQL: profiles / profile.
• directory.sites: Create needs name.
• directory.categories: Create needs name. GraphQL: categories / category.
• directory.contacts: A contact joins its profile’s resource group (no resourceGroupId on create); creating one needs write access to that group. Create needs profileId. Create takes the resource group from the parent.
• media.files: The folder must be in the same resource group. Bytes are served at the media content host {tenantId}/{idOrName}. Create needs name, uri.
• media.folders: Create needs name.
• workManagement.workItems: Type-specific values live in fields (see the work item type). Create accepts parentId. Create needs workItemTypeId, title.
• workManagement.workItemTypes: Create needs name.
• workManagement.boards: Create needs name, boardType.
• workManagement.links: Create needs sourceId, targetId, linkType.
• workManagement.comments: Create needs workItemId, content.
• workManagement.areas: Create needs name.
• workManagement.iterations: Create needs name.
• workManagement.teams: Create needs name.
• workManagement.personas: Create needs name.
• workManagement.votes: Create needs workItemId.
• cms.pages: Create needs pageType, title, uniqueName. GraphQL: pages / page.
• cms.posts: Create needs postType, title, uniqueName. GraphQL: posts / post.
• cms.layouts: Create needs layoutType, name, uniqueName. GraphQL: layouts.
• cms.texts: Create needs name, uniqueName.
• cms.themes: Create needs name, uniqueName. GraphQL: themes.
• cms.elementTemplates: Create needs elementTemplateType, name, uniqueName.
• ecommerce.orders: Status changes go through the workflow actions, not through update.
• ecommerce.carts: Route is carts without api/; the tenant goes in the TenantId query or header. No delete. organizationId is set at create only. Route: /carts (no api/tenant/{tenantId}).
• ecommerce.customers: Masked in output: paymentClientReference, paymentMethods.
• ecommerce.deliveries: Create needs deliveryOptionId. organizationId is set at create only.
• ecommerce.deliveryOptions: Create needs name. organizationId is set at create only.
• ecommerce.discounts: organizationId is set at create only.
• ecommerce.logisticsOptions: Create needs name. organizationId is set at create only.
• ecommerce.payments: Create needs paymentOptionId. organizationId is set at create only. Masked in output: clientSecret, credentialReference, htmlSnippet.
• ecommerce.paymentOptions: Create needs name. organizationId is set at create only.
• ecommerce.pricelists: Create needs name, organizationId, currency. organizationId is set at create only. GraphQL: pricelists / pricelist.
• ecommerce.productStocks: GraphQL: productStocks.
• ecommerce.schedules: No delete. organizationId is set at create only.
• ecommerce.subscriptions: organizationId is set at create only. Masked in output: stripeSubscriptionId, stripeCustomerId.
• pim.products: A patch addresses variants by index (/variants/0/sku); add a test on /variants/0/id to be safe. Prices and stock for selling live in E-commerce price lists and product stocks. Create needs productType. organizationId is set at create only. GraphQL: products / product.
• pim.productGroups: Create needs productType. GraphQL: productGroups / productGroup.
• pim.productProperties: Create needs type. organizationId is set at create only. GraphQL: productProperties.
• pim.productMenus: Create needs productMenuType. organizationId is set at create only.
• pim.reviews: Create needs reviewType, targetId. organizationId is set at create only.
• pim.reviewGroups: Create needs reviewType.
• crm.pipelines: Create needs name.
• crm.deals: pipelineId and relationshipId must be in the deal’s resource group; stageId must be a stage of pipelineId and needs it. Create needs name.
• crm.forms: Create needs name.
• crm.formSubmissions: An update must keep formId. Create needs formId.
• lms.courses: Create needs name.
• lms.subjects: Create needs name.
• lms.courseworks: Create needs title.
• lms.topics: Create needs name.
• lms.submissions: Create needs name.
• lms.cohorts: Create needs name.
• lms.learners: Create needs name.
• lms.instructors: Create needs name.
• lms.assessments: Create needs name.
• lms.assertions: Create needs name.
• lms.badgeClasses: Create needs name.
• lms.pointClasses: Create needs name.
• lms.pointStatistics: Create needs name.
• propertyManagement.realEstates: Create needs name.
• propertyManagement.realEstateRecords: Create needs startDate, recordType.
• propertyManagement.vehicleRecords: Create needs vehicleId, recordDate, recordType.
• propertyManagement.assets: Create needs name.
• accounting.books: Create needs name. organizationId is set at create only.
• accounting.accounts: Create needs name. organizationId is set at create only.
• accounting.bankAccounts: organizationId is set at create only.
• accounting.records: Create needs amount. organizationId is set at create only.
• accounting.transactions: Create needs bankAccountId, transactionDate, amount. organizationId is set at create only.
• accounting.transactionBatches: Body: { transactions: [{ resourceGroupId, bankAccountId, transactionDate, amount, ... }] }. Nothing to list or get. Create needs transactions.
• communication.mails: Sending mail is not offered here. A received mail’s raw message (Mails/{id}/raw) and attachments (Mails/{id}/attachments/{index}) are files, not JSON.
• ai.agents: CRUD uses the GUID id; chat and session actions use the slug agentId. Chat replies are not wrapped in { data }. Create needs agentId, name, systemPrompt.