# Ekso Documentation ## Docs - [Creates a new access control area with default roles (View, Add, Manage, Change, Delete).](https://ekso.dev/api-reference/adminaccesscontrol/creates-a-new-access-control-area-with-default-roles-view-add-manage-change-delete.md) - [Deletes an access control rule by its identifier.](https://ekso.dev/api-reference/adminaccesscontrol/deletes-an-access-control-rule-by-its-identifier.md) - [Lists all access control rules for the current tenant.](https://ekso.dev/api-reference/adminaccesscontrol/lists-all-access-control-rules-for-the-current-tenant.md) - [Retrieves a single access control rule by its identifier.](https://ekso.dev/api-reference/adminaccesscontrol/retrieves-a-single-access-control-rule-by-its-identifier.md) - [Updates an existing access control rule.](https://ekso.dev/api-reference/adminaccesscontrol/updates-an-existing-access-control-rule.md) - [Adds a domain or subject to the mail block list.](https://ekso.dev/api-reference/adminmailgeneral/adds-a-domain-or-subject-to-the-mail-block-list.md) - [Replaces the general mail settings with the provided configuration.](https://ekso.dev/api-reference/adminmailgeneral/replaces-the-general-mail-settings-with-the-provided-configuration.md) - [Retrieves the general mail settings including signature and stop lists.](https://ekso.dev/api-reference/adminmailgeneral/retrieves-the-general-mail-settings-including-signature-and-stop-lists.md) - [Creates a new mailbox configuration, encrypting credentials before storage.](https://ekso.dev/api-reference/adminmailmailbox/creates-a-new-mailbox-configuration-encrypting-credentials-before-storage.md) - [Deletes a mailbox configuration by identifier.](https://ekso.dev/api-reference/adminmailmailbox/deletes-a-mailbox-configuration-by-identifier.md) - [Lists all mailbox configurations with decrypted credentials.](https://ekso.dev/api-reference/adminmailmailbox/lists-all-mailbox-configurations-with-decrypted-credentials.md) - [Retrieves a single mailbox configuration by identifier with decrypted credentials.](https://ekso.dev/api-reference/adminmailmailbox/retrieves-a-single-mailbox-configuration-by-identifier-with-decrypted-credentials.md) - [Tests connectivity to the mail server for the specified mailbox.](https://ekso.dev/api-reference/adminmailmailbox/tests-connectivity-to-the-mail-server-for-the-specified-mailbox.md) - [Updates an existing mailbox configuration, encrypting credentials before storage.](https://ekso.dev/api-reference/adminmailmailbox/updates-an-existing-mailbox-configuration-encrypting-credentials-before-storage.md) - [Creates a new ticketing configuration for processing incoming email into tickets.](https://ekso.dev/api-reference/adminmailticketing/creates-a-new-ticketing-configuration-for-processing-incoming-email-into-tickets.md) - [Deletes a ticketing configuration by identifier.](https://ekso.dev/api-reference/adminmailticketing/deletes-a-ticketing-configuration-by-identifier.md) - [Lists all ticketing configurations for the current tenant.](https://ekso.dev/api-reference/adminmailticketing/lists-all-ticketing-configurations-for-the-current-tenant.md) - [Retrieves a single ticketing configuration by identifier.](https://ekso.dev/api-reference/adminmailticketing/retrieves-a-single-ticketing-configuration-by-identifier.md) - [Runs a test ticketing cycle for the specified configuration to verify end-to-end processing.](https://ekso.dev/api-reference/adminmailticketing/runs-a-test-ticketing-cycle-for-the-specified-configuration-to-verify-end-to-end-processing.md) - [Updates an existing ticketing configuration.](https://ekso.dev/api-reference/adminmailticketing/updates-an-existing-ticketing-configuration.md) - [Creates a new user (super admin only).](https://ekso.dev/api-reference/adminuser/creates-a-new-user-super-admin-only.md) - [Deletes a user by their identifier (super admin only).](https://ekso.dev/api-reference/adminuser/deletes-a-user-by-their-identifier-super-admin-only.md) - [Lists all users for the current tenant.](https://ekso.dev/api-reference/adminuser/lists-all-users-for-the-current-tenant.md) - [Retrieves a single user by their identifier (non-admins can only retrieve their own record).](https://ekso.dev/api-reference/adminuser/retrieves-a-single-user-by-their-identifier-non-admins-can-only-retrieve-their-own-record.md) - [Updates an existing user (non-admins can only update their own record).](https://ekso.dev/api-reference/adminuser/updates-an-existing-user-non-admins-can-only-update-their-own-record.md) - [Creates a new custom user group (super admin only).](https://ekso.dev/api-reference/adminusergroup/creates-a-new-custom-user-group-super-admin-only.md) - [Deletes a custom user group by its identifier (super admin only, system groups cannot be deleted).](https://ekso.dev/api-reference/adminusergroup/deletes-a-custom-user-group-by-its-identifier-super-admin-only-system-groups-cannot-be-deleted.md) - [Lists all user groups for the current tenant, ordered by name.](https://ekso.dev/api-reference/adminusergroup/lists-all-user-groups-for-the-current-tenant-ordered-by-name.md) - [Retrieves a single user group by its identifier.](https://ekso.dev/api-reference/adminusergroup/retrieves-a-single-user-group-by-its-identifier.md) - [Updates an existing user group (super admin only, system groups cannot be deleted via update).](https://ekso.dev/api-reference/adminusergroup/updates-an-existing-user-group-super-admin-only-system-groups-cannot-be-deleted-via-update.md) - [Creates a new annotation on the specified owner entity.](https://ekso.dev/api-reference/annotation/creates-a-new-annotation-on-the-specified-owner-entity.md) - [Deletes an annotation by its identifier.](https://ekso.dev/api-reference/annotation/deletes-an-annotation-by-its-identifier.md) - [Lists all annotations belonging to a specific owner, ordered by creation date ascending.](https://ekso.dev/api-reference/annotation/lists-all-annotations-belonging-to-a-specific-owner-ordered-by-creation-date-ascending.md) - [Retrieves a single annotation by its identifier.](https://ekso.dev/api-reference/annotation/retrieves-a-single-annotation-by-its-identifier.md) - [Returns the list of supported annotation content types.](https://ekso.dev/api-reference/annotation/returns-the-list-of-supported-annotation-content-types.md) - [Updates an existing annotation by its identifier.](https://ekso.dev/api-reference/annotation/updates-an-existing-annotation-by-its-identifier.md) - [Lists all API keys for the current tenant (most recently created first). Hashes are stripped from the returned records; only the display prefix and metadata are visible.](https://ekso.dev/api-reference/apikey/lists-all-api-keys-for-the-current-tenant-most-recently-created-first-hashes-arestripped-from-the-returned-records;-only-the-display-prefix-and-metadata-are-visible.md) - [Mints a new API key. The full plaintext key is returned in the response EXACTLY ONCE. The caller must capture and store it immediately -- there is no way to retrieve it later.](https://ekso.dev/api-reference/apikey/mints-a-new-api-key-the-full-plaintext-key-is-returned-in-the-response-exactly-oncethe-caller-must-capture-and-store-it-immediately--there-is-no-way-to-retrieve-it-later.md) - [Revokes an API key. Soft-delete -- the row is preserved for audit; the key stops working immediately. Idempotent: revoking an already-revoked key is a no-op.](https://ekso.dev/api-reference/apikey/revokes-an-api-key-soft-delete--the-row-is-preserved-for-audit;-the-key-stopsworking-immediately-idempotent:-revoking-an-already-revoked-key-is-a-no-op.md) - [Creates a new application setting.](https://ekso.dev/api-reference/appsetting/creates-a-new-application-setting.md) - [Deletes an application setting by identifier.](https://ekso.dev/api-reference/appsetting/deletes-an-application-setting-by-identifier.md) - [Lists all application settings for the current tenant.](https://ekso.dev/api-reference/appsetting/lists-all-application-settings-for-the-current-tenant.md) - [Retrieves a single application setting by identifier.](https://ekso.dev/api-reference/appsetting/retrieves-a-single-application-setting-by-identifier.md) - [Updates an existing application setting.](https://ekso.dev/api-reference/appsetting/updates-an-existing-application-setting.md) - [Creates a new area (super admin only).](https://ekso.dev/api-reference/area/creates-a-new-area-super-admin-only.md) - [Deletes an area by its identifier (super admin only).](https://ekso.dev/api-reference/area/deletes-an-area-by-its-identifier-super-admin-only.md) - [Lists all areas for the current tenant.](https://ekso.dev/api-reference/area/lists-all-areas-for-the-current-tenant.md) - [Retrieves a single area by its identifier.](https://ekso.dev/api-reference/area/retrieves-a-single-area-by-its-identifier.md) - [Updates an existing area.](https://ekso.dev/api-reference/area/updates-an-existing-area.md) - [Creates a new board.](https://ekso.dev/api-reference/board/creates-a-new-board.md) - [Deletes a board by ID.](https://ekso.dev/api-reference/board/deletes-a-board-by-id.md) - [Lists all boards visible to the current user.](https://ekso.dev/api-reference/board/lists-all-boards-visible-to-the-current-user.md) - [Retrieves a single board by ID.](https://ekso.dev/api-reference/board/retrieves-a-single-board-by-id.md) - [Returns a portfolio-level summary across all boards: aggregate metrics and per-board health, financials, item counts, cycle counts, and status distribution.](https://ekso.dev/api-reference/board/returns-a-portfolio-level-summary-across-all-boards:-aggregate-metrics-and-per-boardhealth-financials-item-counts-cycle-counts-and-status-distribution.md) - [Returns item count statistics grouped by board.](https://ekso.dev/api-reference/board/returns-item-count-statistics-grouped-by-board.md) - [Updates an existing board.](https://ekso.dev/api-reference/board/updates-an-existing-board.md) - [Creates a new budget reason code.](https://ekso.dev/api-reference/budgetreason/creates-a-new-budget-reason-code.md) - [Deletes a budget reason code by its identifier.](https://ekso.dev/api-reference/budgetreason/deletes-a-budget-reason-code-by-its-identifier.md) - [Lists all budget reason codes for the current tenant.](https://ekso.dev/api-reference/budgetreason/lists-all-budget-reason-codes-for-the-current-tenant.md) - [Retrieves a single budget reason code by its identifier.](https://ekso.dev/api-reference/budgetreason/retrieves-a-single-budget-reason-code-by-its-identifier.md) - [Updates an existing budget reason code.](https://ekso.dev/api-reference/budgetreason/updates-an-existing-budget-reason-code.md) - [Deletes an AI chat conversation by ID.](https://ekso.dev/api-reference/chat/deletes-an-ai-chat-conversation-by-id.md) - [Lists all AI chat conversations belonging to the current user.](https://ekso.dev/api-reference/chat/lists-all-ai-chat-conversations-belonging-to-the-current-user.md) - [Performs a semantic vector search across indexed content using the provided phrase.](https://ekso.dev/api-reference/chat/performs-a-semantic-vector-search-across-indexed-content-using-the-provided-phrase.md) - [Sends a question to the AI assistant and returns the response, persisting the conversation history.](https://ekso.dev/api-reference/chat/sends-a-question-to-the-ai-assistant-and-returns-the-response-persisting-the-conversation-history.md) - [Creates a new business clock configuration.](https://ekso.dev/api-reference/clock/creates-a-new-business-clock-configuration.md) - [Deletes a business clock configuration by identifier.](https://ekso.dev/api-reference/clock/deletes-a-business-clock-configuration-by-identifier.md) - [Lists all business clock configurations for the current tenant.](https://ekso.dev/api-reference/clock/lists-all-business-clock-configurations-for-the-current-tenant.md) - [Retrieves a single business clock configuration by identifier.](https://ekso.dev/api-reference/clock/retrieves-a-single-business-clock-configuration-by-identifier.md) - [Updates an existing business clock configuration.](https://ekso.dev/api-reference/clock/updates-an-existing-business-clock-configuration.md) - [Retrieves the forms-based authentication configuration for the current tenant.](https://ekso.dev/api-reference/config/retrieves-the-forms-based-authentication-configuration-for-the-current-tenant.md) - [Retrieves the Microsoft Entra ID authentication configuration for the current tenant.](https://ekso.dev/api-reference/config/retrieves-the-microsoft-entra-id-authentication-configuration-for-the-current-tenant.md) - [Updates the forms-based authentication configuration for the current tenant.](https://ekso.dev/api-reference/config/updates-the-forms-based-authentication-configuration-for-the-current-tenant.md) - [Updates the Microsoft Entra ID authentication configuration for the current tenant.](https://ekso.dev/api-reference/config/updates-the-microsoft-entra-id-authentication-configuration-for-the-current-tenant.md) - [Creates a new constraint.](https://ekso.dev/api-reference/constraint/creates-a-new-constraint.md) - [Deletes a constraint by its identifier.](https://ekso.dev/api-reference/constraint/deletes-a-constraint-by-its-identifier.md) - [Lists all constraints for the current tenant.](https://ekso.dev/api-reference/constraint/lists-all-constraints-for-the-current-tenant.md) - [Lists all constraints that belong to a specific container.](https://ekso.dev/api-reference/constraint/lists-all-constraints-that-belong-to-a-specific-container.md) - [Retrieves a single constraint by its identifier.](https://ekso.dev/api-reference/constraint/retrieves-a-single-constraint-by-its-identifier.md) - [Updates an existing constraint.](https://ekso.dev/api-reference/constraint/updates-an-existing-constraint.md) - [Creates a new container.](https://ekso.dev/api-reference/container/creates-a-new-container.md) - [Creates a new filter within a container.](https://ekso.dev/api-reference/container/creates-a-new-filter-within-a-container.md) - [Deletes a container by its identifier.](https://ekso.dev/api-reference/container/deletes-a-container-by-its-identifier.md) - [Deletes a filter from a container.](https://ekso.dev/api-reference/container/deletes-a-filter-from-a-container.md) - [Lists all containers the current user has view permission for.](https://ekso.dev/api-reference/container/lists-all-containers-the-current-user-has-view-permission-for.md) - [Lists all filters for a container.](https://ekso.dev/api-reference/container/lists-all-filters-for-a-container.md) - [Re-sequences item numbers within a container.](https://ekso.dev/api-reference/container/re-sequences-item-numbers-within-a-container.md) - [Retrieves a single container by its identifier.](https://ekso.dev/api-reference/container/retrieves-a-single-container-by-its-identifier.md) - [Retrieves a single filter within a container.](https://ekso.dev/api-reference/container/retrieves-a-single-filter-within-a-container.md) - [Updates an existing container.](https://ekso.dev/api-reference/container/updates-an-existing-container.md) - [Updates an existing filter within a container.](https://ekso.dev/api-reference/container/updates-an-existing-filter-within-a-container.md) - [Creates a new content template.](https://ekso.dev/api-reference/contenttemplate/creates-a-new-content-template.md) - [Deletes a content template by its identifier.](https://ekso.dev/api-reference/contenttemplate/deletes-a-content-template-by-its-identifier.md) - [Lists all content templates for the current tenant.](https://ekso.dev/api-reference/contenttemplate/lists-all-content-templates-for-the-current-tenant.md) - [Retrieves a single content template by its identifier.](https://ekso.dev/api-reference/contenttemplate/retrieves-a-single-content-template-by-its-identifier.md) - [Updates an existing content template.](https://ekso.dev/api-reference/contenttemplate/updates-an-existing-content-template.md) - [Creates a new cost center.](https://ekso.dev/api-reference/costcenter/creates-a-new-cost-center.md) - [Deletes a cost center by its identifier.](https://ekso.dev/api-reference/costcenter/deletes-a-cost-center-by-its-identifier.md) - [Lists all cost centers for the current tenant.](https://ekso.dev/api-reference/costcenter/lists-all-cost-centers-for-the-current-tenant.md) - [Retrieves a single cost center by its identifier.](https://ekso.dev/api-reference/costcenter/retrieves-a-single-cost-center-by-its-identifier.md) - [Updates an existing cost center.](https://ekso.dev/api-reference/costcenter/updates-an-existing-cost-center.md) - [Creates a new CRM record.](https://ekso.dev/api-reference/crm/creates-a-new-crm-record.md) - [Deletes a CRM record by its identifier.](https://ekso.dev/api-reference/crm/deletes-a-crm-record-by-its-identifier.md) - [Lists all CRM records for the current tenant.](https://ekso.dev/api-reference/crm/lists-all-crm-records-for-the-current-tenant.md) - [Retrieves a single CRM record by its identifier.](https://ekso.dev/api-reference/crm/retrieves-a-single-crm-record-by-its-identifier.md) - [Updates an existing CRM record.](https://ekso.dev/api-reference/crm/updates-an-existing-crm-record.md) - [Creates a new cycle on the specified board.](https://ekso.dev/api-reference/cycle/creates-a-new-cycle-on-the-specified-board.md) - [Deletes a cycle by ID, only if it belongs to the specified board.](https://ekso.dev/api-reference/cycle/deletes-a-cycle-by-id-only-if-it-belongs-to-the-specified-board.md) - [Lists all cycles across all boards.](https://ekso.dev/api-reference/cycle/lists-all-cycles-across-all-boards.md) - [Lists all cycles for a specific board.](https://ekso.dev/api-reference/cycle/lists-all-cycles-for-a-specific-board.md) - [Lists all items assigned to a specific cycle within a board.](https://ekso.dev/api-reference/cycle/lists-all-items-assigned-to-a-specific-cycle-within-a-board.md) - [Retrieves a single cycle by ID within a board.](https://ekso.dev/api-reference/cycle/retrieves-a-single-cycle-by-id-within-a-board.md) - [Returns item count statistics grouped by cycle.](https://ekso.dev/api-reference/cycle/returns-item-count-statistics-grouped-by-cycle.md) - [Updates an existing cycle, and automatically approves all item time entries if the cycle is being closed.](https://ekso.dev/api-reference/cycle/updates-an-existing-cycle-and-automatically-approves-all-item-time-entries-if-the-cycle-is-being-closed.md) - [Creates a new document and initializes its empty content record.](https://ekso.dev/api-reference/docs/creates-a-new-document-and-initializes-its-empty-content-record.md) - [Creates a new document folder.](https://ekso.dev/api-reference/docs/creates-a-new-document-folder.md) - [Deletes a document by its identifier.](https://ekso.dev/api-reference/docs/deletes-a-document-by-its-identifier.md) - [Deletes a document folder by its identifier.](https://ekso.dev/api-reference/docs/deletes-a-document-folder-by-its-identifier.md) - [Lists all active documents within a specific folder, filtered by user permissions.](https://ekso.dev/api-reference/docs/lists-all-active-documents-within-a-specific-folder-filtered-by-user-permissions.md) - [Lists all document folders visible to the current user.](https://ekso.dev/api-reference/docs/lists-all-document-folders-visible-to-the-current-user.md) - [Retrieves a single document by its identifier.](https://ekso.dev/api-reference/docs/retrieves-a-single-document-by-its-identifier.md) - [Retrieves a single document folder by its identifier.](https://ekso.dev/api-reference/docs/retrieves-a-single-document-folder-by-its-identifier.md) - [Retrieves the content body of a document.](https://ekso.dev/api-reference/docs/retrieves-the-content-body-of-a-document.md) - [Updates an existing document by its identifier.](https://ekso.dev/api-reference/docs/updates-an-existing-document-by-its-identifier.md) - [Updates an existing document folder by its identifier.](https://ekso.dev/api-reference/docs/updates-an-existing-document-folder-by-its-identifier.md) - [Updates the content body of a document.](https://ekso.dev/api-reference/docs/updates-the-content-body-of-a-document.md) - [Returns the public Entra ID configuration (tenant ID, app ID) needed by the front-end MSAL login flow.](https://ekso.dev/api-reference/entrameta/returns-the-public-entra-id-configuration-tenant-id-app-id-needed-by-the-front-end-msal-login-flow.md) - [Creates a new custom date field.](https://ekso.dev/api-reference/field/creates-a-new-custom-date-field.md) - [Creates a new custom decimal field.](https://ekso.dev/api-reference/field/creates-a-new-custom-decimal-field.md) - [Creates a new custom integer field.](https://ekso.dev/api-reference/field/creates-a-new-custom-integer-field.md) - [Creates a new custom list (dropdown) field.](https://ekso.dev/api-reference/field/creates-a-new-custom-list-dropdown-field.md) - [Creates a new custom percent field.](https://ekso.dev/api-reference/field/creates-a-new-custom-percent-field.md) - [Creates a new custom picker field.](https://ekso.dev/api-reference/field/creates-a-new-custom-picker-field.md) - [Creates a new custom text field.](https://ekso.dev/api-reference/field/creates-a-new-custom-text-field.md) - [Creates a new custom time field.](https://ekso.dev/api-reference/field/creates-a-new-custom-time-field.md) - [Creates a new custom toggle (boolean) field.](https://ekso.dev/api-reference/field/creates-a-new-custom-toggle-boolean-field.md) - [Returns the complete collection of core and custom fields for the current tenant.](https://ekso.dev/api-reference/field/returns-the-complete-collection-of-core-and-custom-fields-for-the-current-tenant.md) - [Updates an existing custom date field.](https://ekso.dev/api-reference/field/updates-an-existing-custom-date-field.md) - [Updates an existing custom decimal field.](https://ekso.dev/api-reference/field/updates-an-existing-custom-decimal-field.md) - [Updates an existing custom integer field.](https://ekso.dev/api-reference/field/updates-an-existing-custom-integer-field.md) - [Updates an existing custom list (dropdown) field.](https://ekso.dev/api-reference/field/updates-an-existing-custom-list-dropdown-field.md) - [Updates an existing custom percent field.](https://ekso.dev/api-reference/field/updates-an-existing-custom-percent-field.md) - [Updates an existing custom picker field.](https://ekso.dev/api-reference/field/updates-an-existing-custom-picker-field.md) - [Updates an existing custom text field.](https://ekso.dev/api-reference/field/updates-an-existing-custom-text-field.md) - [Updates an existing custom time field.](https://ekso.dev/api-reference/field/updates-an-existing-custom-time-field.md) - [Updates an existing custom toggle (boolean) field.](https://ekso.dev/api-reference/field/updates-an-existing-custom-toggle-boolean-field.md) - [Updates the list values (and default-value pointer) of a list field.](https://ekso.dev/api-reference/field/updates-the-list-values-and-default-value-pointer-of-a-list-field.md): Designed as the CLI/SDK escape hatch for system fields like Priority — the broader `PUT /api/field/list` rejects `IsCore=true` mutations from CLI/SDK callers, but admins still need to add "Critical" to Priority via script. Allowed for any caller. All other field properties (name, description, multi-… - [Deletes a file and removes its blob from cloud storage.](https://ekso.dev/api-reference/file/deletes-a-file-and-removes-its-blob-from-cloud-storage.md) - [Downloads a file's binary content from cloud storage.](https://ekso.dev/api-reference/file/downloads-a-files-binary-content-from-cloud-storage.md) - [Lists all files attached to a specific owner, filtered by the current user's view permissions.](https://ekso.dev/api-reference/file/lists-all-files-attached-to-a-specific-owner-filtered-by-the-current-users-view-permissions.md) - [Retrieves a single file's metadata by its identifier. Useful when you have the file id (e.g. from an upload response) and want to verify existence or fetch metadata without listing the owner's full file list.](https://ekso.dev/api-reference/file/retrieves-a-single-files-metadata-by-its-identifier-useful-when-you-have-thefile-id-eg-from-an-upload-response-and-want-to-verify-existence-or-fetchmetadata-without-listing-the-owners-full-file-list.md) - [Uploads a single file and attaches it to the specified owner entity. Returns the created DataFile record so callers (CLI / SDK / migration scripts) can capture the new file id without a follow-up list-and-filter call.](https://ekso.dev/api-reference/file/uploads-a-single-file-and-attaches-it-to-the-specified-owner-entity-returns-thecreated-datafile-record-so-callers-cli-sdk-migration-scriptscan-capture-the-new-file-id-without-a-follow-up-list-and-filter-call.md) - [Retrieves the webhook configuration for the current tenant.](https://ekso.dev/api-reference/hook/retrieves-the-webhook-configuration-for-the-current-tenant.md) - [Updates the webhook configuration for the current tenant.](https://ekso.dev/api-reference/hook/updates-the-webhook-configuration-for-the-current-tenant.md) - [Introduction](https://ekso.dev/api-reference/introduction.md): Ekso REST API reference — authentication, error handling, versioning, and rate limits. - [Adds a parent-child dependency between two items.](https://ekso.dev/api-reference/item/adds-a-parent-child-dependency-between-two-items.md) - [Creates a new item within a container.](https://ekso.dev/api-reference/item/creates-a-new-item-within-a-container.md) - [Deletes an item by its identifier.](https://ekso.dev/api-reference/item/deletes-an-item-by-its-identifier.md) - [Duplicates an existing item within the same container.](https://ekso.dev/api-reference/item/duplicates-an-existing-item-within-the-same-container.md) - [Executes a filter query against items and returns paginated results.](https://ekso.dev/api-reference/item/executes-a-filter-query-against-items-and-returns-paginated-results.md) - [Finds items by container ID and/or sequence number.](https://ekso.dev/api-reference/item/finds-items-by-container-id-andor-sequence-number.md) - [Lists items assigned to a specific resource (user or job role).](https://ekso.dev/api-reference/item/lists-items-assigned-to-a-specific-resource-user-or-job-role.md) - [Lists items in a container with optional filtering and pagination.](https://ekso.dev/api-reference/item/lists-items-in-a-container-with-optional-filtering-and-pagination.md) - [Removes an item from its dependency tree, making it a standalone item that retains its children.](https://ekso.dev/api-reference/item/removes-an-item-from-its-dependency-tree-making-it-a-standalone-item-that-retains-its-children.md) - [Retrieves a single item by its identifier, returning an empty item if the user lacks permission.](https://ekso.dev/api-reference/item/retrieves-a-single-item-by-its-identifier-returning-an-empty-item-if-the-user-lacks-permission.md) - [Retrieves the full dependency tree for an item, filtered to items the user can see.](https://ekso.dev/api-reference/item/retrieves-the-full-dependency-tree-for-an-item-filtered-to-items-the-user-can-see.md) - [Searches for items matching a keyword across one or more containers, filtered by user permissions.](https://ekso.dev/api-reference/item/searches-for-items-matching-a-keyword-across-one-or-more-containers-filtered-by-user-permissions.md) - [Sends an outbound ticket reply as an annotation on an item.](https://ekso.dev/api-reference/item/sends-an-outbound-ticket-reply-as-an-annotation-on-an-item.md) - [Updates an existing item.](https://ekso.dev/api-reference/item/updates-an-existing-item.md) - [Creates a new job role.](https://ekso.dev/api-reference/jobrole/creates-a-new-job-role.md) - [Deletes a job role by its identifier.](https://ekso.dev/api-reference/jobrole/deletes-a-job-role-by-its-identifier.md) - [Lists all job roles for the current tenant.](https://ekso.dev/api-reference/jobrole/lists-all-job-roles-for-the-current-tenant.md) - [Retrieves a single job role by its identifier.](https://ekso.dev/api-reference/jobrole/retrieves-a-single-job-role-by-its-identifier.md) - [Updates an existing job role.](https://ekso.dev/api-reference/jobrole/updates-an-existing-job-role.md) - [Creates a new label (super admin only).](https://ekso.dev/api-reference/label/creates-a-new-label-super-admin-only.md) - [Deletes a label by its identifier (super admin only).](https://ekso.dev/api-reference/label/deletes-a-label-by-its-identifier-super-admin-only.md) - [Lists all labels for the current tenant.](https://ekso.dev/api-reference/label/lists-all-labels-for-the-current-tenant.md) - [Retrieves a single label by its identifier.](https://ekso.dev/api-reference/label/retrieves-a-single-label-by-its-identifier.md) - [Updates an existing label (super admin only).](https://ekso.dev/api-reference/label/updates-an-existing-label-super-admin-only.md) - [Creates a new link between two entities.](https://ekso.dev/api-reference/link/creates-a-new-link-between-two-entities.md) - [Deletes a link by its identifier.](https://ekso.dev/api-reference/link/deletes-a-link-by-its-identifier.md) - [Retrieves all resolved links for a given entity, including linked item details.](https://ekso.dev/api-reference/link/retrieves-all-resolved-links-for-a-given-entity-including-linked-item-details.md) - [Returns the list of supported ISO country codes.](https://ekso.dev/api-reference/meta/returns-the-list-of-supported-iso-country-codes.md) - [Returns the list of supported ISO currency codes.](https://ekso.dev/api-reference/meta/returns-the-list-of-supported-iso-currency-codes.md) - [Returns the list of supported timezones with display names.](https://ekso.dev/api-reference/meta/returns-the-list-of-supported-timezones-with-display-names.md) - [Creates a new non-billable code.](https://ekso.dev/api-reference/nonbillable/creates-a-new-non-billable-code.md) - [Deletes a non-billable code by its identifier.](https://ekso.dev/api-reference/nonbillable/deletes-a-non-billable-code-by-its-identifier.md) - [Lists all non-billable codes for the current tenant.](https://ekso.dev/api-reference/nonbillable/lists-all-non-billable-codes-for-the-current-tenant.md) - [Retrieves a single non-billable code by its identifier.](https://ekso.dev/api-reference/nonbillable/retrieves-a-single-non-billable-code-by-its-identifier.md) - [Updates an existing non-billable code.](https://ekso.dev/api-reference/nonbillable/updates-an-existing-non-billable-code.md) - [Creates a new scheduled notification configuration.](https://ekso.dev/api-reference/notification/creates-a-new-scheduled-notification-configuration.md) - [Deletes a notification configuration by identifier.](https://ekso.dev/api-reference/notification/deletes-a-notification-configuration-by-identifier.md) - [Lists all scheduled notification configurations for the current tenant.](https://ekso.dev/api-reference/notification/lists-all-scheduled-notification-configurations-for-the-current-tenant.md) - [Retrieves a single notification configuration by identifier.](https://ekso.dev/api-reference/notification/retrieves-a-single-notification-configuration-by-identifier.md) - [Updates an existing scheduled notification configuration.](https://ekso.dev/api-reference/notification/updates-an-existing-scheduled-notification-configuration.md) - [AI planning assistant. Accepts a question and returns suggestions for item planning. Uses read-only MCP tools — cannot mutate data.](https://ekso.dev/api-reference/plan/ai-planning-assistant-accepts-a-question-and-returns-suggestions-for-item-planninguses-read-only-mcp-tools-—-cannot-mutate-data.md) - [Batch-plans items into a cycle. All-or-nothing: if any item fails validation, none are saved.](https://ekso.dev/api-reference/plan/batch-plans-items-into-a-cycle-all-or-nothing:-if-any-item-fails-validation-none-are-saved.md) - [Calculates capacity for a board cycle: per-resource hours, utilization, and aggregates.](https://ekso.dev/api-reference/plan/calculates-capacity-for-a-board-cycle:-per-resource-hours-utilization-and-aggregates.md) - [Moves an item from one cycle to another within the same board. Updates ordering in both source and target cycles.](https://ekso.dev/api-reference/plan/moves-an-item-from-one-cycle-to-another-within-the-same-boardupdates-ordering-in-both-source-and-target-cycles.md) - [NOT USED: Auto-schedule frontend has been removed as part of the Board Revamp. This endpoint is retained for potential future use. Suggests optimal resource assignments for backlog items using greedy capacity balancing. Read-only — does not mutate data.](https://ekso.dev/api-reference/plan/not-used:-auto-schedule-frontend-has-been-removed-as-part-of-the-board-revampthis-endpoint-is-retained-for-potential-future-usesuggests-optimal-resource-assignments-for-backlog-items-using-greedy-capacity-balancingread-only-—-does-not-mutate-data.md) - [Removes an item from a board and cycle, returning it to the backlog.](https://ekso.dev/api-reference/plan/removes-an-item-from-a-board-and-cycle-returning-it-to-the-backlog.md) - [Replaces the item ordering within a cycle.](https://ekso.dev/api-reference/plan/replaces-the-item-ordering-within-a-cycle.md) - [Returns a resource-by-cycle utilization heatmap for a board.](https://ekso.dev/api-reference/plan/returns-a-resource-by-cycle-utilization-heatmap-for-a-board.md) - [Returns the count of unplanned items per board the user can view. Lightweight endpoint for badge display.](https://ekso.dev/api-reference/plan/returns-the-count-of-unplanned-items-per-board-the-user-can-viewlightweight-endpoint-for-badge-display.md) - [Returns unplanned items across the board's whitelisted containers. Items without a board/cycle assignment that the user can see.](https://ekso.dev/api-reference/plan/returns-unplanned-items-across-the-boards-whitelisted-containersitems-without-a-boardcycle-assignment-that-the-user-can-see.md) - [Creates a new workflow process configuration.](https://ekso.dev/api-reference/process/creates-a-new-workflow-process-configuration.md) - [Deletes a workflow process and removes it from all containers.](https://ekso.dev/api-reference/process/deletes-a-workflow-process-and-removes-it-from-all-containers.md) - [Lists all workflow process configurations for the current tenant.](https://ekso.dev/api-reference/process/lists-all-workflow-process-configurations-for-the-current-tenant.md) - [Retrieves a single workflow process configuration by identifier.](https://ekso.dev/api-reference/process/retrieves-a-single-workflow-process-configuration-by-identifier.md) - [Returns item count statistics grouped by process type.](https://ekso.dev/api-reference/process/returns-item-count-statistics-grouped-by-process-type.md) - [Updates an existing workflow process and synchronizes field removals across all containers.](https://ekso.dev/api-reference/process/updates-an-existing-workflow-process-and-synchronizes-field-removals-across-all-containers.md) - [Returns a per-user summary of logged time for the specified reporting period.](https://ekso.dev/api-reference/reporting/returns-a-per-user-summary-of-logged-time-for-the-specified-reporting-period.md) - [Returns a weekly summary of logged time for the specified reporting period.](https://ekso.dev/api-reference/reporting/returns-a-weekly-summary-of-logged-time-for-the-specified-reporting-period.md) - [Returns billable item data for the specified reporting period.](https://ekso.dev/api-reference/reporting/returns-billable-item-data-for-the-specified-reporting-period.md) - [Returns board cycle time risk analysis for the specified reporting period.](https://ekso.dev/api-reference/reporting/returns-board-cycle-time-risk-analysis-for-the-specified-reporting-period.md) - [Returns detailed profitability drilldown data for a specific item or grouping.](https://ekso.dev/api-reference/reporting/returns-detailed-profitability-drilldown-data-for-a-specific-item-or-grouping.md) - [Returns detailed timesheet entries for a specific user and reporting period.](https://ekso.dev/api-reference/reporting/returns-detailed-timesheet-entries-for-a-specific-user-and-reporting-period.md) - [Returns profitability data for the specified reporting period.](https://ekso.dev/api-reference/reporting/returns-profitability-data-for-the-specified-reporting-period.md) - [Returns time code distribution data for the specified reporting period.](https://ekso.dev/api-reference/reporting/returns-time-code-distribution-data-for-the-specified-reporting-period.md) - [Returns work estimate versus time logged risk data for the specified reporting period.](https://ekso.dev/api-reference/reporting/returns-work-estimate-versus-time-logged-risk-data-for-the-specified-reporting-period.md) - [Creates a new automation rule configuration.](https://ekso.dev/api-reference/rule/creates-a-new-automation-rule-configuration.md) - [Deletes an automation rule configuration by identifier.](https://ekso.dev/api-reference/rule/deletes-an-automation-rule-configuration-by-identifier.md) - [Lists all automation rule configurations for the current tenant.](https://ekso.dev/api-reference/rule/lists-all-automation-rule-configurations-for-the-current-tenant.md) - [Retrieves a single automation rule configuration by identifier.](https://ekso.dev/api-reference/rule/retrieves-a-single-automation-rule-configuration-by-identifier.md) - [Updates an existing automation rule configuration.](https://ekso.dev/api-reference/rule/updates-an-existing-automation-rule-configuration.md) - [Returns the screen layout definition for adding or updating an item, including field definitions and workflow states.](https://ekso.dev/api-reference/screen/returns-the-screen-layout-definition-for-adding-or-updating-an-item-including-field-definitions-and-workflow-states.md) - [Creates a new SKU.](https://ekso.dev/api-reference/sku/creates-a-new-sku.md) - [Deletes a SKU by its identifier.](https://ekso.dev/api-reference/sku/deletes-a-sku-by-its-identifier.md) - [Lists all SKUs for the current tenant.](https://ekso.dev/api-reference/sku/lists-all-skus-for-the-current-tenant.md) - [Retrieves a single SKU by its identifier.](https://ekso.dev/api-reference/sku/retrieves-a-single-sku-by-its-identifier.md) - [Updates an existing SKU.](https://ekso.dev/api-reference/sku/updates-an-existing-sku.md) - [Retrieves the AI provider configuration for the current tenant. Hidden from the SDK/CLI because the response shape carries provider API keys; AI config is tenant infrastructure, not customer data ops or migration scope.](https://ekso.dev/api-reference/tenant/retrieves-the-ai-provider-configuration-for-the-current-tenant-hidden-from-thesdkcli-because-the-response-shape-carries-provider-api-keys;-ai-config-is-tenantinfrastructure-not-customer-data-ops-or-migration-scope.md) - [Updates the AI provider configuration for the current tenant. Hidden from the SDK/CLI because the payload carries provider API keys; AI config is tenant infrastructure, not customer data ops or migration scope. Configure AI through the admin UI instead.](https://ekso.dev/api-reference/tenant/updates-the-ai-provider-configuration-for-the-current-tenant-hidden-from-thesdkcli-because-the-payload-carries-provider-api-keys;-ai-config-is-tenantinfrastructure-not-customer-data-ops-or-migration-scope-configure-ai-throughthe-admin-ui-instead.md) - [Updates the current tenant's profile information such as name, locale, and admin contact details.](https://ekso.dev/api-reference/tenant/updates-the-current-tenants-profile-information-such-as-name-locale-and-admin-contact-details.md) - [Creates a new non-billable time entry.](https://ekso.dev/api-reference/time/creates-a-new-non-billable-time-entry.md) - [Deletes a non-billable time entry by its identifier.](https://ekso.dev/api-reference/time/deletes-a-non-billable-time-entry-by-its-identifier.md) - [Lists items with billable time logged by a user within a date range.](https://ekso.dev/api-reference/time/lists-items-with-billable-time-logged-by-a-user-within-a-date-range.md) - [Lists non-billable time entries for a user within a date range.](https://ekso.dev/api-reference/time/lists-non-billable-time-entries-for-a-user-within-a-date-range.md) - [Updates an existing non-billable time entry.](https://ekso.dev/api-reference/time/updates-an-existing-non-billable-time-entry.md) - [Creates a new watch (pin or subscription) on an entity for a watcher.](https://ekso.dev/api-reference/watch/creates-a-new-watch-pin-or-subscription-on-an-entity-for-a-watcher.md) - [Deletes a watch by its identifier.](https://ekso.dev/api-reference/watch/deletes-a-watch-by-its-identifier.md) - [Lists all watches created by a specific watcher (e.g. User, Email, User Group).](https://ekso.dev/api-reference/watch/lists-all-watches-created-by-a-specific-watcher-eg-user-email-user-group.md) - [Lists all watches for a specific owner entity (e.g. Container, Board, Item).](https://ekso.dev/api-reference/watch/lists-all-watches-for-a-specific-owner-entity-eg-container-board-item.md) - [Retrieves a single watch by its identifier.](https://ekso.dev/api-reference/watch/retrieves-a-single-watch-by-its-identifier.md) - [Updates an existing watch by its identifier.](https://ekso.dev/api-reference/watch/updates-an-existing-watch-by-its-identifier.md) - [Authentication](https://ekso.dev/cli/authentication.md): Sign in via OAuth 2.0 device flow for interactive use, or pass an API key for non-interactive automation. - [Command branches](https://ekso.dev/cli/branches.md): Every top-level CLI branch at a glance. Each branch maps to a resource in the Ekso API. - [Configuration](https://ekso.dev/cli/configuration.md): Global flags, environment variables, output formats, and POSIX exit codes. - [Installation](https://ekso.dev/cli/installation.md): Install the Ekso CLI — one self-contained binary, no runtime needed. - [Before you start](https://ekso.dev/cli/migrate/before-you-start.md): Prerequisites, secrets policy, and token rotation for ekso migrate. - [Command reference](https://ekso.dev/cli/migrate/command-reference.md): Every ekso migrate command and flag, in one place. - [Migrate from Azure DevOps](https://ekso.dev/cli/migrate/devops.md): Move Azure DevOps work items, comments, attachments, links, and iterations into Ekso — in two commands. - [Field mapping](https://ekso.dev/cli/migrate/field-mapping.md): Map source-platform custom fields to Ekso process fields with a migration.fields.yaml file. - [Migrate from Countersoft Gemini](https://ekso.dev/cli/migrate/gemini.md): Move Countersoft Gemini projects, issues, time entries, attachments, sprints, and versions into Ekso — in two commands. - [Identity resolution](https://ekso.dev/cli/migrate/identity-resolution.md): How ekso migrate maps source-platform users to Ekso users — match-or-create, match-only, migration-bot. - [Migrate from Jira](https://ekso.dev/cli/migrate/jira.md): Move Atlassian Jira projects, issues, comments, attachments, links, and worklogs into Ekso — in two commands. - [Migrate from Linear](https://ekso.dev/cli/migrate/linear.md): Move Linear teams, issues, comments, attachments, cycles, and labels into Ekso — in two commands. - [Migrate](https://ekso.dev/cli/migrate/overview.md): Move projects, issues, comments, attachments, and time history from Jira, Linear, Azure DevOps, Zendesk, or Countersoft Gemini into Ekso — in two commands. - [Troubleshooting](https://ekso.dev/cli/migrate/troubleshooting.md): Exit codes, common errors per source, and how to recover from a partial migration. - [Migrate from Zendesk](https://ekso.dev/cli/migrate/zendesk.md): Move Zendesk organisations, tickets, comments, and attachments into Ekso — in two commands. - [Ekso CLI](https://ekso.dev/cli/overview.md): Drive Ekso from the command line — automation, scripting, CI integrations, and one-off admin tasks. - [ekso access-control](https://ekso.dev/cli/reference/access-control.md): Access-control entries (permission grants). - [ekso annotation](https://ekso.dev/cli/reference/annotation.md): Append-only annotations attached to items and other entities. - [ekso api-key](https://ekso.dev/cli/reference/api-key.md): API keys for non-interactive auth (CI / agents / server-to-server). - [ekso area](https://ekso.dev/cli/reference/area.md): Sub-organizational areas (departments, teams, sub-orgs). - [ekso auth](https://ekso.dev/cli/reference/auth.md): Sign in / out and inspect the current session. - [ekso board](https://ekso.dev/cli/reference/board.md): Boards (project / cycle containers). - [ekso budget-reason](https://ekso.dev/cli/reference/budget-reason.md): Budget / spend reason codes. - [ekso clock](https://ekso.dev/cli/reference/clock.md): Business clocks (read-only). - [ekso constraint](https://ekso.dev/cli/reference/constraint.md): Field validation constraints. - [ekso container](https://ekso.dev/cli/reference/container.md): Work containers (projects / queues) and their saved filters. - [ekso content-template](https://ekso.dev/cli/reference/content-template.md): Reusable content templates with name, description, and variant array. - [ekso cost-center](https://ekso.dev/cli/reference/cost-center.md): Cost centres (finance org). - [ekso crm](https://ekso.dev/cli/reference/crm.md): Customer / account records. - [ekso cycle](https://ekso.dev/cli/reference/cycle.md): Board cycles (sprints / iterations). - [ekso docs](https://ekso.dev/cli/reference/docs.md): Knowledge-base folders, documents, and doc content. - [ekso field](https://ekso.dev/cli/reference/field.md): Custom and system field definitions. - [ekso file](https://ekso.dev/cli/reference/file.md): File attachments on items and annotations. - [ekso hook](https://ekso.dev/cli/reference/hook.md): Tenant-wide outbound webhook configuration. - [ekso item](https://ekso.dev/cli/reference/item.md): Create, read, update, and delete items (tickets / tasks). - [ekso job-role](https://ekso.dev/cli/reference/job-role.md): Job-role definitions. - [ekso label](https://ekso.dev/cli/reference/label.md): Item labels (tags). - [ekso link](https://ekso.dev/cli/reference/link.md): Entity-to-entity links / relationships. - [ekso mail-general](https://ekso.dev/cli/reference/mail-general.md): Singleton tenant mail config (signatures, banners, defaults). - [ekso mail-mailbox](https://ekso.dev/cli/reference/mail-mailbox.md): Mailbox (IMAP/SMTP) configuration. - [ekso mail-ticketing](https://ekso.dev/cli/reference/mail-ticketing.md): Mail-ticketing configuration (incoming-email-to-tickets). - [ekso mcp](https://ekso.dev/cli/reference/mcp.md): Helpers to wire Ekso into Claude Code, Cursor, Windsurf, etc. - [ekso meta](https://ekso.dev/cli/reference/meta.md): Reference data lookups (read-only). - [ekso non-billable](https://ekso.dev/cli/reference/non-billable.md): Non-billable categories (time-entry classification). - [ekso notification](https://ekso.dev/cli/reference/notification.md): Notification channels and recipient lists. - [ekso process](https://ekso.dev/cli/reference/process.md): Workflow processes — states, transitions, fields. - [ekso reporting](https://ekso.dev/cli/reference/reporting.md): Read-only finance / time / risk reports (POST + filter body). - [ekso rule](https://ekso.dev/cli/reference/rule.md): Automation rules — triggers, conditions, actions. - [ekso screen](https://ekso.dev/cli/reference/screen.md): Compute the item screen (form / UI shape) for an item. - [ekso sku](https://ekso.dev/cli/reference/sku.md): Revenue / billing SKUs. - [ekso time](https://ekso.dev/cli/reference/time.md): Time tracking entries. - [ekso user](https://ekso.dev/cli/reference/user.md): Tenant users. - [ekso user-group](https://ekso.dev/cli/reference/user-group.md): Security groups (membership + role assignments). - [ekso watch](https://ekso.dev/cli/reference/watch.md): Pins and follow subscriptions on entities. - [ConfigAccessControl](https://ekso.dev/data-model/config-access-control.md): Sample shape for ConfigAccessControl. - [ConfigAI](https://ekso.dev/data-model/config-ai.md): Sample shape for ConfigAI. - [ConfigApplicationSetting](https://ekso.dev/data-model/config-application-setting.md): Sample shape for ConfigApplicationSetting. - [ConfigBudgetReason](https://ekso.dev/data-model/config-budget-reason.md): Sample shape for ConfigBudgetReason. - [ConfigClock](https://ekso.dev/data-model/config-clock.md): Sample shape for ConfigClock. - [ConfigCondition](https://ekso.dev/data-model/config-condition.md): Sample shape for ConfigCondition. - [ConfigConditionGroup](https://ekso.dev/data-model/config-condition-group.md): Sample shape for ConfigConditionGroup. - [ConfigContentTemplate](https://ekso.dev/data-model/config-content-template.md): Sample shape for ConfigContentTemplate. - [ConfigContentTemplateVariant](https://ekso.dev/data-model/config-content-template-variant.md): Sample shape for ConfigContentTemplateVariant. - [ConfigCostCenter](https://ekso.dev/data-model/config-cost-center.md): Sample shape for ConfigCostCenter. - [ConfigHook](https://ekso.dev/data-model/config-hook.md): Sample shape for ConfigHook. - [ConfigJobRole](https://ekso.dev/data-model/config-job-role.md): Sample shape for ConfigJobRole. - [ConfigLabel](https://ekso.dev/data-model/config-label.md): Sample shape for ConfigLabel. - [ConfigMailGeneral](https://ekso.dev/data-model/config-mail-general.md): Sample shape for ConfigMailGeneral. - [ConfigMailbox](https://ekso.dev/data-model/config-mailbox.md): Sample shape for ConfigMailbox. - [ConfigNonBillable](https://ekso.dev/data-model/config-non-billable.md): Sample shape for ConfigNonBillable. - [ConfigNotification](https://ekso.dev/data-model/config-notification.md): Sample shape for ConfigNotification. - [ConfigProcess](https://ekso.dev/data-model/config-process.md): Sample shape for ConfigProcess. - [ConfigProcessField](https://ekso.dev/data-model/config-process-field.md): Sample shape for ConfigProcessField. - [ConfigProcessWorkflow](https://ekso.dev/data-model/config-process-workflow.md): Sample shape for ConfigProcessWorkflow. - [ConfigRule](https://ekso.dev/data-model/config-rule.md): Sample shape for ConfigRule. - [ConfigRuleActionEndpoint](https://ekso.dev/data-model/config-rule-action-endpoint.md): Sample shape for ConfigRuleActionEndpoint. - [ConfigRuleActionValue](https://ekso.dev/data-model/config-rule-action-value.md): Sample shape for ConfigRuleActionValue. - [ConfigSku](https://ekso.dev/data-model/config-sku.md): Sample shape for ConfigSku. - [ConfigTicket](https://ekso.dev/data-model/config-ticket.md): Sample shape for ConfigTicket. - [ConfigUserGroup](https://ekso.dev/data-model/config-user-group.md): Sample shape for ConfigUserGroup. - [Constants](https://ekso.dev/data-model/constants.md): Every enum and constant value referenced by Ekso's data models, in one place. - [DataAnnotation](https://ekso.dev/data-model/data-annotation.md): Append-only annotation attached to an item, container, or another annotation. - [DataArea](https://ekso.dev/data-model/data-area.md): Sample shape for DataArea. - [DataBoard](https://ekso.dev/data-model/data-board.md): Sample shape for DataBoard. - [DataChat](https://ekso.dev/data-model/data-chat.md): Sample shape for DataChat. - [DataConstraint](https://ekso.dev/data-model/data-constraint.md): Sample shape for DataConstraint. - [DataContainer](https://ekso.dev/data-model/data-container.md): Top-level work container — a project, queue, product line, or service queue. - [DataCrm](https://ekso.dev/data-model/data-crm.md): Sample shape for DataCrm. - [DataCrmContact](https://ekso.dev/data-model/data-crm-contact.md): Sample shape for DataCrmContact. - [DataCycle](https://ekso.dev/data-model/data-cycle.md): Cycle (sprint, iteration, version, release) — a time-boxed grouping of items. - [DataDoc](https://ekso.dev/data-model/data-doc.md): Sample shape for DataDoc. - [DataDocContent](https://ekso.dev/data-model/data-doc-content.md): Sample shape for DataDocContent. - [DataDocFolder](https://ekso.dev/data-model/data-doc-folder.md): Sample shape for DataDocFolder. - [DataFieldDate](https://ekso.dev/data-model/data-field-date.md): Sample shape for DataFieldDate. - [DataFieldDecimal](https://ekso.dev/data-model/data-field-decimal.md): Sample shape for DataFieldDecimal. - [DataFieldInteger](https://ekso.dev/data-model/data-field-integer.md): Sample shape for DataFieldInteger. - [DataFieldList](https://ekso.dev/data-model/data-field-list.md): Sample shape for DataFieldList. - [DataFieldListData](https://ekso.dev/data-model/data-field-list-data.md): Sample shape for DataFieldListData. - [DataFieldPercent](https://ekso.dev/data-model/data-field-percent.md): Sample shape for DataFieldPercent. - [DataFieldPicker](https://ekso.dev/data-model/data-field-picker.md): Sample shape for DataFieldPicker. - [DataFieldText](https://ekso.dev/data-model/data-field-text.md): Sample shape for DataFieldText. - [DataFieldTime](https://ekso.dev/data-model/data-field-time.md): Sample shape for DataFieldTime. - [DataFieldToggle](https://ekso.dev/data-model/data-field-toggle.md): Sample shape for DataFieldToggle. - [DataFile](https://ekso.dev/data-model/data-file.md): File attachment on an item or annotation. - [DataFilter](https://ekso.dev/data-model/data-filter.md): Sample shape for DataFilter. - [DataItem](https://ekso.dev/data-model/data-item.md): Work item — a ticket, task, story, change request, or any unit of work. - [DataItemFieldValue](https://ekso.dev/data-model/data-item-field-value.md): Sample shape for DataItemFieldValue. - [DataLink](https://ekso.dev/data-model/data-link.md): Entity-to-entity relationship. - [DataProcess](https://ekso.dev/data-model/data-process.md): Sample shape for DataProcess. - [DataProcessField](https://ekso.dev/data-model/data-process-field.md): Sample shape for DataProcessField. - [DataRole](https://ekso.dev/data-model/data-role.md): Sample shape for DataRole. - [DataTime](https://ekso.dev/data-model/data-time.md): Sample shape for DataTime. - [DataUser](https://ekso.dev/data-model/data-user.md): Tenant user. - [DataWatch](https://ekso.dev/data-model/data-watch.md): Sample shape for DataWatch. - [Data Models](https://ekso.dev/data-model/overview.md): Reference for every shape that crosses the API, SDK, and CLI boundaries — copy-pasteable JSON examples, field tables, and constants in one place. - [Agent onboarding](https://ekso.dev/guide/agent-onboarding.md): Programmatically create Ekso workspaces via API — designed for AI agents acting on behalf of users. - [Items and fields](https://ekso.dev/guide/api/items-and-fields.md): Understand the DataItem schema, field system, and permission model — discover available fields and build API requests. - [API overview](https://ekso.dev/guide/api/overview.md): Understand the Ekso REST API — base URL, OAuth 2.0 authentication, error handling, and response conventions. - [Quickstart](https://ekso.dev/guide/api/quickstart.md): Authenticate and make your first Ekso API call — list boards, create an item, and handle errors. - [Access control](https://ekso.dev/guide/concepts/access-control.md): Manage permissions across your tenant with application-level access control areas, roles, and user groups. - [AI](https://ekso.dev/guide/concepts/ai.md): Use the built-in AI assistant to ask questions, search by meaning, and get context-aware answers from your workspace data. - [Authentication](https://ekso.dev/guide/concepts/authentication.md): Configure login methods — forms-based authentication with password policies, Microsoft Entra ID SSO, and two-factor verification. - [Boards](https://ekso.dev/guide/concepts/boards.md): Plan delivery with boards — set budgets, manage resources, approve containers, and organize work into cycles. - [Clock](https://ekso.dev/guide/concepts/clock.md): Enforce SLA targets with clocks — set working calendars, track elapsed time, detect breaches, and send notifications. - [Constraints](https://ekso.dev/guide/concepts/constraints.md): Enforce data integrity with include and exclude rules that control which field values are allowed on items. - [Containers](https://ekso.dev/guide/concepts/containers.md): Organize work into containers with areas, labels, processes, saved filters, and role-based access control. - [Cycles](https://ekso.dev/guide/concepts/cycles.md): Run time-boxed iterations — plan items into cycles, assign resources, track status zones, approve time, and close sprints. - [Docs](https://ekso.dev/guide/concepts/docs.md): Build a knowledge base with folders, user group visibility controls, and AI assistant integration for context-aware answers. - [Fields](https://ekso.dev/guide/concepts/fields.md): Configure system fields and custom field types to capture structured data on items, controlled by processes. - [Finance](https://ekso.dev/guide/concepts/finance.md): Set up financial tracking — configure job roles, cost centers, SKUs, CRM records, and budget reason codes for profitability analysis. - [Insights](https://ekso.dev/guide/concepts/insights.md): Analyze profitability, time distribution, per-user summaries, item financials, and risk with built-in reports. - [Items](https://ekso.dev/guide/concepts/items.md): Track work with items — fields, annotations, attachments, links, dependencies, time entries, and cycle planning. - [Mailbox connections](https://ekso.dev/guide/concepts/mailbox.md): Connect IMAP or Microsoft 365 mailboxes to Ekso for email-based ticketing. - [Notifications](https://ekso.dev/guide/concepts/notifications.md): Configure scheduled notifications that alert user groups, email addresses, Slack, Teams, or HTTP endpoints when items match your conditions. - [Overview](https://ekso.dev/guide/concepts/overview.md): Learn how Ekso's core concepts fit together — containers, items, fields, boards, cycles, time tracking, and more. - [Process](https://ekso.dev/guide/concepts/processes.md): Define item types with configurable fields, features, workflow transitions, and field-level permissions. - [Rules](https://ekso.dev/guide/concepts/rules.md): Automate workflows with event and timer triggers that update fields, send notifications, and enforce business logic. - [Ticketing](https://ekso.dev/guide/concepts/ticketing.md): Turn inbound emails into tickets, reply from within Ekso, manage conversations, and block spam. - [Time tracking](https://ekso.dev/guide/concepts/time-tracking.md): Log billable and non-billable time with the weekly timesheet, manage approval workflows, and track work estimates. - [Webhooks](https://ekso.dev/guide/concepts/webhooks.md): Push real-time event notifications to external systems when items, users, containers, or boards change. - [Workspace settings](https://ekso.dev/guide/concepts/workspace.md): Configure your tenant profile, AI provider, welcome message, and email filtering defaults. - [Rule endpoints](https://ekso.dev/guide/integrations/rule-endpoints.md): Send rule-fire events to external URLs — envelope shape, URL restrictions, and receiver examples in Node and C#. - [Ekso Documentation](https://ekso.dev/index.md): API reference, MCP tools, and concept guides for Ekso — ticketing, project management, resource planning, and time tracking. - [Access Control](https://ekso.dev/mcp-tools/access-control.md): MCP tools for viewing access control rules and permissions. - [Annotation](https://ekso.dev/mcp-tools/annotation.md): MCP tools for managing comments and annotations on entities. - [Area](https://ekso.dev/mcp-tools/area.md): MCP tools for creating, updating, and deleting areas within containers. - [Board](https://ekso.dev/mcp-tools/board.md): MCP tools for querying and managing boards, budgets, cycle items, and portfolio-level insights. - [Clock](https://ekso.dev/mcp-tools/clock.md): MCP tools for viewing business clock configurations. - [Config](https://ekso.dev/mcp-tools/config.md): MCP tools for querying post-event hooks and configuration. - [Constraint](https://ekso.dev/mcp-tools/constraint.md): MCP tools for managing field-level validation constraints on items. - [Container](https://ekso.dev/mcp-tools/container.md): MCP tools for querying containers, their processes, and filtering items by conditions. - [Cycle](https://ekso.dev/mcp-tools/cycle.md): MCP tools for creating and managing cycles (sprints/iterations) within boards. - [Doc](https://ekso.dev/mcp-tools/doc.md): MCP tools for managing document folders, documents, and document content. - [Field](https://ekso.dev/mcp-tools/field.md): MCP tools for discovering fields, their metadata, list values, picker entities, and filterable field definitions. - [Finance](https://ekso.dev/mcp-tools/finance.md): MCP tools for profitability reporting, time tracking summaries, and finance metadata. - [MCP Tools](https://ekso.dev/mcp-tools/introduction.md): Connect AI agents to Ekso via Model Context Protocol (MCP) — manage items, boards, cycles, and more. - [Item](https://ekso.dev/mcp-tools/item.md): MCP tools for creating, reading, updating, deleting, copying, and managing work item dependencies. - [Label](https://ekso.dev/mcp-tools/label.md): MCP tools for querying, creating, updating, and deleting labels. - [Link](https://ekso.dev/mcp-tools/link.md): MCP tools for managing links between work items. - [Notification](https://ekso.dev/mcp-tools/notification.md): MCP tools for managing scheduled notification configurations. - [Process](https://ekso.dev/mcp-tools/process.md): MCP tools for querying process definitions and their workflow transitions. - [Prompts](https://ekso.dev/mcp-tools/prompts.md): MCP Prompts — conversation templates that guide AI agents through multi-step planning workflows. - [Resources](https://ekso.dev/mcp-tools/resources.md): AI-optimized domain knowledge served via MCP Resources — read-only guides covering every area of Ekso. - [Rule](https://ekso.dev/mcp-tools/rule.md): MCP tools for viewing automation rules and attaching webhook-style endpoint actions. - [Ticketing](https://ekso.dev/mcp-tools/ticketing.md): MCP tools for searching, viewing, and replying to email-based ticket conversations. - [Time](https://ekso.dev/mcp-tools/time.md): MCP tools for managing time entries and resource time logs. - [User](https://ekso.dev/mcp-tools/user.md): MCP tools for querying user profiles. - [User Group](https://ekso.dev/mcp-tools/user-group.md): MCP tools for managing user groups. - [Watch](https://ekso.dev/mcp-tools/watch.md): MCP tools for managing pins and subscriptions on entities. - [Authentication](https://ekso.dev/sdk/authentication.md): Pick ApiKeyAuth for non-interactive callers or RefreshableBearerAuth for OAuth-issued tokens. - [Installation](https://ekso.dev/sdk/installation.md): Add Ekso.Sdk to your .NET project via NuGet. - [Ekso SDK](https://ekso.dev/sdk/overview.md): The official C# SDK for Ekso. Type-safe access to every public API operation, with auth, retry, and error handling built in. - [Quickstart](https://ekso.dev/sdk/quickstart.md): Your first authenticated call against the Ekso API. Five minutes from new project to listing items. - [Admin.AccessControl](https://ekso.dev/sdk/reference/admin-access-control.md): Typed SDK access to the Admin.AccessControl resource — methods and HTTP routes. - [Admin.Mail.General](https://ekso.dev/sdk/reference/admin-mail-general.md): Typed SDK access to the Admin.Mail.General resource — methods and HTTP routes. - [Admin.Mail.Mailbox](https://ekso.dev/sdk/reference/admin-mail-mailbox.md): Typed SDK access to the Admin.Mail.Mailbox resource — methods and HTTP routes. - [Admin.Mail.Ticketing](https://ekso.dev/sdk/reference/admin-mail-ticketing.md): Typed SDK access to the Admin.Mail.Ticketing resource — methods and HTTP routes. - [Admin.User](https://ekso.dev/sdk/reference/admin-user.md): Typed SDK access to the Admin.User resource — methods and HTTP routes. - [Admin.UserGroup](https://ekso.dev/sdk/reference/admin-user-group.md): Typed SDK access to the Admin.UserGroup resource — methods and HTTP routes. - [Annotation](https://ekso.dev/sdk/reference/annotation.md): Typed SDK access to the Annotation resource — methods and HTTP routes. - [ApiKey](https://ekso.dev/sdk/reference/api-key.md): Typed SDK access to the ApiKey resource — methods and HTTP routes. - [Area](https://ekso.dev/sdk/reference/area.md): Typed SDK access to the Area resource — methods and HTTP routes. - [Board](https://ekso.dev/sdk/reference/board.md): Typed SDK access to the Board resource — methods and HTTP routes. - [BudgetReason](https://ekso.dev/sdk/reference/budget-reason.md): Typed SDK access to the BudgetReason resource — methods and HTTP routes. - [Clock](https://ekso.dev/sdk/reference/clock.md): Typed SDK access to the Clock resource — methods and HTTP routes. - [Constraint](https://ekso.dev/sdk/reference/constraint.md): Typed SDK access to the Constraint resource — methods and HTTP routes. - [Container](https://ekso.dev/sdk/reference/container.md): Typed SDK access to the Container resource — methods and HTTP routes. - [ContentTemplate](https://ekso.dev/sdk/reference/content-template.md): Typed SDK access to the ContentTemplate resource — methods and HTTP routes. - [CostCenter](https://ekso.dev/sdk/reference/cost-center.md): Typed SDK access to the CostCenter resource — methods and HTTP routes. - [Crm](https://ekso.dev/sdk/reference/crm.md): Typed SDK access to the Crm resource — methods and HTTP routes. - [Cycle](https://ekso.dev/sdk/reference/cycle.md): Typed SDK access to the Cycle resource — methods and HTTP routes. - [Docs](https://ekso.dev/sdk/reference/docs.md): Typed SDK access to the Docs resource — methods and HTTP routes. - [Field](https://ekso.dev/sdk/reference/field.md): Typed SDK access to the Field resource — methods and HTTP routes. - [File](https://ekso.dev/sdk/reference/file.md): Typed SDK access to the File resource — methods and HTTP routes. - [Hook](https://ekso.dev/sdk/reference/hook.md): Typed SDK access to the Hook resource — methods and HTTP routes. - [Item](https://ekso.dev/sdk/reference/item.md): Typed SDK access to the Item resource — methods and HTTP routes. - [JobRole](https://ekso.dev/sdk/reference/job-role.md): Typed SDK access to the JobRole resource — methods and HTTP routes. - [Label](https://ekso.dev/sdk/reference/label.md): Typed SDK access to the Label resource — methods and HTTP routes. - [Link](https://ekso.dev/sdk/reference/link.md): Typed SDK access to the Link resource — methods and HTTP routes. - [Meta](https://ekso.dev/sdk/reference/meta.md): Typed SDK access to the Meta resource — methods and HTTP routes. - [NonBillable](https://ekso.dev/sdk/reference/non-billable.md): Typed SDK access to the NonBillable resource — methods and HTTP routes. - [Notification](https://ekso.dev/sdk/reference/notification.md): Typed SDK access to the Notification resource — methods and HTTP routes. - [Process](https://ekso.dev/sdk/reference/process.md): Typed SDK access to the Process resource — methods and HTTP routes. - [Reporting](https://ekso.dev/sdk/reference/reporting.md): Typed SDK access to the Reporting resource — methods and HTTP routes. - [Rule](https://ekso.dev/sdk/reference/rule.md): Typed SDK access to the Rule resource — methods and HTTP routes. - [Screen](https://ekso.dev/sdk/reference/screen.md): Typed SDK access to the Screen resource — methods and HTTP routes. - [Sku](https://ekso.dev/sdk/reference/sku.md): Typed SDK access to the Sku resource — methods and HTTP routes. - [Time](https://ekso.dev/sdk/reference/time.md): Typed SDK access to the Time resource — methods and HTTP routes. - [Watch](https://ekso.dev/sdk/reference/watch.md): Typed SDK access to the Watch resource — methods and HTTP routes. ## OpenAPI Specs - [openapi](https://ekso.dev/api-reference/openapi.json) ## Optional - [Documentation](https://ekso.dev)