Skip to main content

​
Introduction

The Xenia API enables you to integrate your operations platform with external systems, automate workflows, and build custom applications. This guide will help you make your first API call in under 5 minutes.

​
Prerequisites

Before you begin, ensure you have:
  1. A Xenia workspace - An active Xenia account with admin access
  2. Public API feature enabled - Contact your Xenia account manager to enable API access
  3. API credentials - Generated from your workspace settings

​
Step 1: Generate API Credentials

  1. Log in to Xenia Dashboard
  2. Navigate to Workspace Settings (gear icon)
  3. Select API Access from the sidebar
  4. Click Create API Key
  5. Enter a name for your key (e.g., “My Integration”)
  6. Save your credentials securely:
    • Client Key - Your API identifier
    • Client Secret - Your API secret (shown only once)
Store your Client Secret securely. It will only be displayed once during creation.

​
Step 2: Understand Authentication

The Xenia API uses client credentials for authentication. Include these headers with every request:
HeaderDescription
x-client-keyYour API client key
x-client-secretYour API client secret
workspace-idYour workspace UUID

​
Step 3: Make Your First API Call

Let’s verify your credentials by fetching the list of users in your workspace. Request: 
curl -X GET "https://api.xenia.team/api/v1/mgt/users" \
  -H "x-client-key: YOUR_CLIENT_KEY" \
  -H "x-client-secret: YOUR_CLIENT_SECRET" \
  -H "workspace-id: YOUR_WORKSPACE_ID" \
  -H "Content-Type: application/json"
Response: 
{
  "status": true,
  "statusCode": 200,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "firstName": "John",
      "lastName": "Doe",
      "emailId": "[email protected]",
      "status": "Active",
      "Role": {
        "id": "role-uuid",
        "title": "Admin"
      }
    }
  ]
}
If you receive a successful response with user data, your API credentials are working correctly.

​
Step 4: Find Your Workspace ID

If you don’t know your workspace ID, you can retrieve it using the user context endpoint: 
curl -X GET "https://api.xenia.team/api/v1/mgt/user-context" \
  -H "x-client-key: YOUR_CLIENT_KEY" \
  -H "x-client-secret: YOUR_CLIENT_SECRET" \
  -H "Content-Type: application/json"
The response includes your workspace information: 
{
  "status": true,
  "data": {
    "user": {
      "id": "user-uuid",
      "emailId": "[email protected]"
    },
    "workspaces": [
      {
        "id": "workspace-uuid",
        "name": "My Workspace"
      }
    ]
  }
}

​
API Base URL

All API requests should be made to: 
https://api.xenia.team

​
Common API Paths

Path PrefixDescription
/api/v1/mgt/Management APIs (users, roles, workspaces)
/api/v1/ops/Operations APIs (templates, submissions, tasks)

​
Next Steps

Now that you’ve made your first API call, explore these resources:

Core Concepts

Understand the key entities and how they relate

Error Handling

Learn how to handle API errors gracefully

Users API

Manage users in your workspace

Templates API

Work with checklist templates

​
Need Help?