GET
/
ext
/
v1
/
users
List users
curl --request GET \
  --url https://api.light.inc/rest/ext/v1/users
{
  "total": 123,
  "records": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": {
        "countryCode": "UNDEFINED",
        "localNumber": "<string>"
      },
      "avatarUrl": "<string>",
      "notificationChannel": "MS_TEAMS",
      "country": "UNDEFINED",
      "city": "<string>",
      "zipcode": "<string>",
      "address": "<string>",
      "status": "ACTIVE",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "roles": [
        "SUPERUSER"
      ],
      "groups": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>",
          "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "memberCount": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "managerIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

Query Parameters

​
sort
string
Example:

"amount:desc,createdAt:asc"

​
filter
string
Example:

"state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500"

​
searchTerm
string
​
limit
integer
​
offset
integer
​
includeRoles
boolean
​
includeGroups
boolean

Response

default - application/json;charset=UTF-8

default response

The response is of type object.