Overview
App
Items
- POSTCreates a new item within a container.
- POSTRetrieves a single item by its identifier, returning an empty item if the user lacks permission.
- PUTUpdates an existing item.
- DELDeletes an item by its identifier.
- POSTLists items in a container with optional filtering and pagination.
- POSTExecutes a filter query against items and returns paginated results.
- POSTSearches for items matching a keyword across one or more containers, filtered by user permissions.
- POSTDuplicates an existing item within the same container.
- POSTLists items assigned to a specific resource (user or job role).
- POSTReturns the screen layout definition for adding or updating an item, including field definitions and workflow states.
- GETRetrieves the full dependency tree for an item, filtered to items the user can see.
- POSTAdds a parent-child dependency between two items.
- POSTRemoves an item from its dependency tree, making it a standalone item that retains its children.
- POSTSends an outbound ticket reply as an annotation on an item.
Boards
- GETLists all boards visible to the current user.
- POSTCreates a new board.
- GETRetrieves a single board by ID.
- PUTUpdates an existing board.
- GETReturns item count statistics grouped by board.
- GETLists all cycles for a specific board.
- POSTCreates a new cycle on the specified board.
- GETRetrieves a single cycle by ID within a board.
- PUTUpdates an existing cycle, and automatically approves all item time entries if the cycle is being closed.
- GETLists all items assigned to a specific cycle within a board.
- GETLists all cycles across all boards.
- GETReturns item count statistics grouped by cycle.
Containers
- GETLists all containers the current user has view permission for.
- POSTCreates a new container.
- GETRetrieves a single container by its identifier.
- DELDeletes a container by its identifier.
- POSTRe-sequences item numbers within a container.
- GETLists all filters for a container.
- POSTCreates a new filter within a container.
- PUTUpdates an existing filter within a container.
- DELDeletes a filter from a container.
- GETLists all areas for the current tenant.
- POSTCreates a new area (super admin only).
- GETRetrieves a single area by its identifier.
- DELDeletes an area by its identifier (super admin only).
- GETLists all labels for the current tenant.
- POSTCreates a new label (super admin only).
- GETRetrieves a single label by its identifier.
- DELDeletes a label by its identifier (super admin only).
Users
- GETLists all users for the current tenant.
- POSTCreates a new user (super admin only).
- GETRetrieves a single user by their identifier (non-admins can only retrieve their own record).
- DELDeletes a user by their identifier (super admin only).
- GETLists all user groups for the current tenant, ordered by name.
- POSTCreates a new custom user group (super admin only).
- GETRetrieves a single user group by its identifier.
- DELDeletes a custom user group by its identifier (super admin only, system groups cannot be deleted).
Time
Finance
- GETLists all cost centers for the current tenant.
- POSTCreates a new cost center.
- GETRetrieves a single cost center by its identifier.
- DELDeletes a cost center by its identifier.
- GETLists all job roles for the current tenant.
- POSTCreates a new job role.
- GETRetrieves a single job role by its identifier.
- DELDeletes a job role by its identifier.
- GETLists all budget reason codes for the current tenant.
- POSTCreates a new budget reason code.
- GETRetrieves a single budget reason code by its identifier.
- DELDeletes a budget reason code by its identifier.
- GETLists all non-billable codes for the current tenant.
- POSTCreates a new non-billable code.
- PUTUpdates an existing non-billable code.
- DELDeletes a non-billable code by its identifier.
- GETLists all SKUs for the current tenant.
- POSTCreates a new SKU.
- GETRetrieves a single SKU by its identifier.
- DELDeletes a SKU by its identifier.
- GETLists all CRM records for the current tenant.
- POSTCreates a new CRM record.
- GETRetrieves a single CRM record by its identifier.
- DELDeletes a CRM record by its identifier.
Data & Fields
- GETReturns the complete collection of core and custom fields for the current tenant.
- POSTCreates a new custom text field.
- POSTCreates a new custom integer field.
- POSTCreates a new custom decimal field.
- POSTCreates a new custom percent field.
- POSTCreates a new custom date field.
- POSTCreates a new custom time field.
- POSTCreates a new custom toggle (boolean) field.
- POSTCreates a new custom list (dropdown) field.
- POSTCreates a new custom picker field.
- GETLists all constraints for the current tenant.
- POSTCreates a new constraint.
- PUTUpdates an existing constraint.
- DELDeletes a constraint by its identifier.
- GETLists all constraints that belong to a specific container.
- GETLists all content templates for the current tenant.
- POSTCreates a new content template.
- GETRetrieves a single content template by its identifier.
- DELDeletes a content template by its identifier.
Workflow
- GETLists all automation rule configurations for the current tenant.
- POSTCreates a new automation rule configuration.
- GETRetrieves a single automation rule configuration by identifier.
- DELDeletes an automation rule configuration by identifier.
- GETLists all workflow process configurations for the current tenant.
- POSTCreates a new workflow process configuration.
- PUTUpdates an existing workflow process and synchronizes field removals across all containers.
- DELDeletes a workflow process and removes it from all containers.
- GETReturns item count statistics grouped by process type.
- GETLists all business clock configurations for the current tenant.
- POSTCreates a new business clock configuration.
- PUTUpdates an existing business clock configuration.
- DELDeletes a business clock configuration by identifier.
Auth
- GETLists all access control rules for the current tenant.
- POSTCreates a new access control area with default roles (View, Add, Manage, Change, Delete).
- GETRetrieves a single access control rule by its identifier.
- DELDeletes an access control rule by its identifier.
- GETRetrieves the forms-based authentication configuration for the current tenant.
- GETRetrieves the Microsoft Entra ID authentication configuration for the current tenant.
Insights & Reports
- POSTReturns billable item data for the specified reporting period.
- POSTReturns a per-user summary of logged time for the specified reporting period.
- POSTReturns detailed timesheet entries for a specific user and reporting period.
- POSTReturns profitability data for the specified reporting period.
- POSTReturns detailed profitability drilldown data for a specific item or grouping.
- POSTReturns board cycle time risk analysis for the specified reporting period.
- POSTReturns work estimate versus time logged risk data for the specified reporting period.
- POSTReturns time code distribution data for the specified reporting period.
- POSTReturns a weekly summary of logged time for the specified reporting period.
Notifications
Mailbox
- GETRetrieves the general mail settings including signature and stop lists.
- PUTAdds a domain or subject to the mail block list.
- GETLists all ticketing configurations for the current tenant.
- POSTCreates a new ticketing configuration for processing incoming email into tickets.
- PUTUpdates an existing ticketing configuration.
- GETRuns a test ticketing cycle for the specified configuration to verify end-to-end processing.
- GETLists all mailbox configurations with decrypted credentials.
- POSTCreates a new mailbox configuration, encrypting credentials before storage.
- PUTUpdates an existing mailbox configuration, encrypting credentials before storage.
- GETTests connectivity to the mail server for the specified mailbox.
Docs
- GETLists all document folders visible to the current user.
- POSTCreates a new document folder.
- GETRetrieves a single document folder by its identifier.
- PUTUpdates an existing document folder by its identifier.
- GETLists all active documents within a specific folder, filtered by user permissions.
- GETRetrieves a single document by its identifier.
- POSTCreates a new document and initializes its empty content record.
- DELDeletes a document by its identifier.
- PUTUpdates an existing document by its identifier.
- PUTUpdates the content body of a document.
Files & Storage
- GETLists all files attached to a specific owner, filtered by the current user's view permissions.
- POSTUploads a single file and attaches it to the specified owner entity.
- GETDownloads a file's binary content from cloud storage.
- DELDeletes a file and removes its blob from cloud storage.
- GETReturns all installation-level icons used for list field values (e.g. priority icons).
Links, Annotations & Watch
- POSTCreates a new link between two entities.
- DELDeletes a link by its identifier.
- GETReturns the list of supported annotation content types.
- GETLists all annotations belonging to a specific owner, ordered by creation date ascending.
- POSTCreates a new annotation on the specified owner entity.
- PUTUpdates an existing annotation by its identifier.
- DELDeletes an annotation by its identifier.
- GETLists all watches for a specific owner entity (e.g. Container, Board, Item).
- GETLists all watches created by a specific watcher (e.g. User, Email, User Group).
- POSTCreates a new watch (pin or subscription) on an entity for a watcher.
- DELDeletes a watch by its identifier.
Tenant & Settings
- PUTUpdates the current tenant's profile information such as name, locale, and admin contact details.
- GETRetrieves the AI provider configuration for the current tenant.
- GETLists all application settings for the current tenant.
- POSTCreates a new application setting.
- GETRetrieves a single application setting by identifier.
- DELDeletes an application setting by identifier.
- GETRetrieves the webhook configuration for the current tenant.
- PUTUpdates the webhook configuration for the current tenant.
Returns the complete collection of core and custom fields for the current tenant.
Copy
Ask AI
curl --request GET \
--url https://{tenant}.ekso.app/api/field \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"typeDate": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": "2023-11-07T05:31:56Z",
"maximum": "2023-11-07T05:31:56Z",
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeDecimal": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeInteger": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeList": [
{
"entity": "<string>",
"fieldType": "<string>",
"multiSelect": true,
"data": [
{
"id": "<string>",
"value": "<string>",
"image": "<string>",
"metadata": "<string>",
"active": true
}
],
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typePercent": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typePicker": [
{
"entity": "<string>",
"fieldType": "<string>",
"scope": "<string>",
"multiSelect": true,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeText": [
{
"entity": "<string>",
"fieldType": "<string>",
"contentType": "<string>",
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeTime": [
{
"entity": "<string>",
"fieldType": "<string>",
"allowDay": true,
"allowHour": true,
"allowMinute": true,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeToggle": [
{
"entity": "<string>",
"fieldType": "<string>",
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
]
}Data & Fields
Returns the complete collection of core and custom fields for the current tenant.
GET
/
api
/
field
Returns the complete collection of core and custom fields for the current tenant.
Copy
Ask AI
curl --request GET \
--url https://{tenant}.ekso.app/api/field \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"typeDate": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": "2023-11-07T05:31:56Z",
"maximum": "2023-11-07T05:31:56Z",
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeDecimal": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeInteger": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeList": [
{
"entity": "<string>",
"fieldType": "<string>",
"multiSelect": true,
"data": [
{
"id": "<string>",
"value": "<string>",
"image": "<string>",
"metadata": "<string>",
"active": true
}
],
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typePercent": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typePicker": [
{
"entity": "<string>",
"fieldType": "<string>",
"scope": "<string>",
"multiSelect": true,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeText": [
{
"entity": "<string>",
"fieldType": "<string>",
"contentType": "<string>",
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeTime": [
{
"entity": "<string>",
"fieldType": "<string>",
"allowDay": true,
"allowHour": true,
"allowMinute": true,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeToggle": [
{
"entity": "<string>",
"fieldType": "<string>",
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
]
}Authorizations
JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.
Response
The field collection.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Assistant
Responses are generated using AI and may contain mistakes.