Getting Started - Xenia Team API

Introduction

The Xenia API lets you read your operational data — users, locations, tasks, and submissions — and pull reporting/analytics into external systems and BI tools. This guide gets you to your first API call in a few minutes.

Prerequisites

Before you begin, ensure you have:

A Xenia workspace with admin/owner access
Public API enabled — this is an add-on capability. If you don’t see Settings → Public Integrations, contact your Xenia representative to enable it.
API credentials — a client key + secret you generate in the workspace settings

Step 1: Generate API credentials

Log in to the Xenia web app
Open Settings → Public Integrations
Click Create Client Key
Enter a name for your key (e.g., “My Integration”) and choose the default user the key acts as
Save your credentials securely:
- Client Key — your API identifier
- Client Secret — your API secret (shown only once)

Store your Client Secret securely. It is displayed only once at creation and cannot be retrieved later. If it’s lost, create a new key.

Step 2: Understand authentication

The Xenia API uses client credentials. Include these headers with every request:

Header	Required	Description
`x-client-key`	Yes	Your API client key
`x-client-secret`	Yes	Your API client secret
`x-client-user`	No	UUID of a workspace user to act as (defaults to the key’s default user)

You do not send a workspace-id header — the workspace is derived automatically from the key. Only supply a workspace ID where an endpoint path contains {workspaceId}.

Step 3: Make your first API call

Verify your credentials by fetching the 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"

Response: (the workspace-specific fields — role, locations, status — live under UserWorkspaces[])

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "firstName": "John",
      "lastName": "Doe",
      "emailId": "john.doe@example.com",
      "UserWorkspaces": [
        { "title": "Admin", "status": "active", "isAdmin": true, "RoleId": "role-uuid", "Role": { "id": "role-uuid", "title": "Admin" } }
      ],
      "UserLocations": [ { "LocationId": "loc-uuid" } ]
    }
  ],
  "meta": { "current_page": 1, "last_page": 1, "per_page": 10000, "total": 42 }
}

A 200 with a data array means your credentials work. A 401 means the key/secret is wrong; a 403 means this route isn’t allowed for API keys or the key’s user lacks permission.

Step 4: Confirm your identity and workspace

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"

The response returns the acting user’s context (id, workspaces, role, permissions, features):

{
  "data": {
    "id": "user-uuid",
    "UserWorkspaces": [ { "Workspace": { "id": "workspace-uuid" }, "Role": { "title": "Admin" } } ],
    "Permissions": { "...": {} }
  },
  "message": "Login Successfully",
  "extra_meta": { "token": "..." }
}

API base URL

All requests go to:

https://api.xenia.team

Common API paths

Path prefix	Used by
`/api/v1/mgt/`	Users, roles, grid & scheduled reports, set-password / set-login-pin
`/api/v1/ops/`	Task reads (catalog, list, details), submission records, exports, task analytics

Next steps

Core Concepts

Understand the key entities and how they relate

Error Handling

Response shapes and how to handle errors

Users API

Manage users in your workspace

Data Extraction

Pull submissions and analytics into BI tools

Need help?

Email Support: support@xenia.team
API Reference: Browse the complete API Reference

​Introduction

​Prerequisites

​Step 1: Generate API credentials

​Step 2: Understand authentication

​Step 3: Make your first API call

​Step 4: Confirm your identity and workspace

​API base URL

​Common API paths

​Next steps

Core Concepts

Error Handling

Users API

Data Extraction

​Need help?

Introduction

Prerequisites

Step 1: Generate API credentials

Step 2: Understand authentication

Step 3: Make your first API call

Step 4: Confirm your identity and workspace

API base URL

Common API paths

Next steps

Need help?