List Users

List all users of the company

Path Parameters

companyID companyID required

The id of the company

Query Parameters

nextToken nextToken

Token to use for pagination

Responses

• 200

---

List of users of the company

application/json

Schema

Example (from schema)

---

Schema

items object[]
List of users
Array [
id string
Unique ID of the the user
email string
Email of the user
createdAt date-time
Date the user was created
updatedAt date-time
Date the user was last updated
deletedAt date nullable
Date the user was deleted
teams string[]
List of teams the user is part of
]
nextToken string nullable

Next token to use for pagination

{
  "items": [
    {
      "id": "2e8f9915-fda0-450c-95a3-d61f93c66fa9",
      "email": "john.doe@yourdomain.com",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "deletedAt": "2021-01-01",
      "teams": [
        "2e8f9915-fda0-450c-95a3-d61f93c66fa9"
      ]
    }
  ],
  "nextToken": "2e8f9915-fda0-450c-95a3-d61f93c66fa9"
}

Loading...