API Reference

Team Members

Create, list, update, and remove team members on your SkyLight Chat account.

The Team Member object

{
  "id": 5,
  "name": "James Carter",
  "email": "james@acmecorp.com",
  "role": "agent",
  "status": "active",
  "created_at": "2026-01-20T09:00:00.000000Z",
  "updated_at": "2026-01-20T09:00:00.000000Z"
}

Field	Type	Description
`id`	integer	Unique team member ID
`name`	string	Full name
`email`	string	Email address (used for login)
`role`	string	`admin` or `agent`
`status`	string	`active` or `inactive`

List team members

GET /api/v1/team

curl https://dashboard.skylightchat.com/api/v1/team \
  -H "Authorization: Bearer sk_live_••••••••••••"

Query parameters

Parameter	Type	Description
`page`	integer	Page number
`per_page`	integer	Results per page
`role`	string	Filter by role: `admin`, `agent`

Response

{
  "success": true,
  "data": [
    {
      "id": 5,
      "name": "James Carter",
      "email": "james@acmecorp.com",
      "role": "agent",
      "status": "active"
    },
    {
      "id": 6,
      "name": "Layla Al-Hassan",
      "email": "layla@acmecorp.com",
      "role": "admin",
      "status": "active"
    }
  ],
  "meta": { "current_page": 1, "last_page": 1, "per_page": 15, "total": 2 }
}

Create a team member

POST /api/v1/team

Creates a new team member. An invitation email is sent to the provided email address.

Request body

{
  "name": "James Carter",
  "email": "james@acmecorp.com",
  "role": "agent",
  "password": "SecureP@ssword123"
}

Field	Required	Description
`name`	✓	Full name
`email`	✓	Email address (must be unique)
`role`	✓	`admin` or `agent`
`password`	✓	Initial password (min 8 characters)

Example

curl -X POST https://dashboard.skylightchat.com/api/v1/team \
  -H "Authorization: Bearer sk_live_••••••••••••" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "James Carter",
    "email": "james@acmecorp.com",
    "role": "agent",
    "password": "SecureP@ssword123"
  }'

Response `201 Created`

{
  "success": true,
  "data": {
    "id": 5,
    "name": "James Carter",
    "email": "james@acmecorp.com",
    "role": "agent",
    "status": "active",
    "created_at": "2026-03-04T12:00:00.000000Z"
  },
  "message": "Team member created successfully."
}

Get a team member

GET /api/v1/team/{id}

curl https://dashboard.skylightchat.com/api/v1/team/5 \
  -H "Authorization: Bearer sk_live_••••••••••••"

Update a team member

PUT /api/v1/team/{id}

All fields are optional. Only provided fields are updated.

{
  "name": "James A. Carter",
  "role": "admin"
}

curl -X PUT https://dashboard.skylightchat.com/api/v1/team/5 \
  -H "Authorization: Bearer sk_live_••••••••••••" \
  -H "Content-Type: application/json" \
  -d '{"role": "admin"}'

Response

{
  "success": true,
  "data": {
    "id": 5,
    "name": "James Carter",
    "role": "admin",
    "status": "active"
  },
  "message": "Team member updated successfully."
}

Delete a team member

DELETE /api/v1/team/{id}

Removes the team member from your account. This action cannot be undone.

curl -X DELETE https://dashboard.skylightchat.com/api/v1/team/5 \
  -H "Authorization: Bearer sk_live_••••••••••••"

Response `204 No Content`

No response body.

Deleting a team member permanently removes their access. Any conversations or assignments linked to them will be preserved but unassigned.

Roles

Role	Capabilities
`admin`	Full access: settings, team management, all conversations
`agent`	Access to assigned conversations, contacts, and bookings

Account

Read and update your account profile, subscription plan, and connected channel status.

Webhooks Overview

Receive real-time event notifications from SkyLight Chat to your server.