Skip to main content
GET
/
api
/
v3
/
users
List company members
curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/users \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "username": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "is_active": true,
      "date_joined": "2023-11-07T05:31:56Z",
      "account_expiration_date": "2023-11-07T05:31:56Z",
      "last_login": "2023-11-07T05:31:56Z",
      "invitation_status": "<string>",
      "language": "<string>",
      "company": {
        "id": 123,
        "name": "<string>"
      },
      "roles": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "groups": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "role": "<string>",
          "category": "<string>",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lighton.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
company_id
integer

Filter by company ID (for admin users only)

​
group_id
integer

Filter by group ID (users must be members of the specified group)

​
is_active
boolean

Filter by active status

​
page
integer

A page number within the paginated result set.

Response

List of company members accessible to the authenticated user

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"