The Staff API allows you to manage workspace staff members and their permissions within DMLY.
Use these endpoints to retrieve staff lists and fetch individual staff member details.

Base URL

https://api.dmly.io/api

Authentication

All endpoints require the x-api-key header:

x-api-key: YOUR_API_KEY

Endpoints

List / Search Staff

GET /v1/staffs

Retrieve a list of staff members with optional filtering and search.

Response: 200 OK — Array of Staff

Query Parameters

Example Request

curl -X GET "https://api.dmly.io/api/v1/staffs?workspaceId=ws_123&page=1&limit=20&searchText=john" \
  -H "x-api-key: YOUR_API_KEY"

✅ Example Response

[
  {
    "id": "staff_001",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "countryCode": "ng",
    "phone": "2348012345678",
    "active": true,
    "workspaces": ["ws_123"]
  }
]

2️⃣ Get Staff by ID

GET /v1/staffs/{staffId}

Retrieve a staff member by their unique ID.

Response: 200 OK — Staff

Path Parameters

Example Request

curl -X GET "https://api.dmly.io/api/v1/staffs/staff_001" \
  -H "x-api-key: YOUR_API_KEY"

✅ Example Response

{
  "id": "staff_001",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "countryCode": "ng",
  "phone": "2348012345678",
  "active": true,
  "workspaces": ["ws_123"]
}

📦 Schemas

Staff Schema

{
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "countryCode": "string",
  "phone": "string",
  "active": true,
  "workspaces": ["string"]
}

Staffs Schema

[
  {
    // Staff object
  }
]

✅ Best Practices

• Use workspaceId when managing staff in multi-workspace environments.

• Use pagination (page, limit) when listing large staff sets.

• Store staffId for role management and permission updates.

• Use searchText for fast UI filtering integrations.

Security Notes

• Only workspace owners or authorized roles should access staff endpoints.

• Do not expose x-api-key in frontend applications.

• Always validate workspace membership before displaying or modifying staff data.