KNknak
Users

List all users

Retrieve a page of users in the organization.

get/users

Request

Query parameters

filter[email]string
Example:email@knak.com

Filter users by email. Partial match filter.

sortstring
Example:created_at

Sort users by field (created_at, updated_at).

pageinteger

Page number

per_pageinteger

Number of items per page

Response

OK

Example response

{
  "data": [
    {
      "type": "user",
      "id": "609d7ce223411",
      "attributes": {
        "id": "609d7ce223411",
        "name": "John Doe",
        "email": "john.doe@email.com",
        "roles": [
          "Email Creator",
          "Collaborator"
        ]
      }
    }
  ],
  "links": {
    "first": "https://enterprise.knak.io/api/published/v1/users?per_page=10&page=1",
    "last": "https://enterprise.knak.io/api/published/v1/users?per_page=10&page=3",
    "prev": "https://enterprise.knak.io/api/published/v1/users?per_page=10&page=1",
    "next": "https://enterprise.knak.io/api/published/v1/users?per_page=10&page=3"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 3,
    "links": [
      {
        "url": "https://enterprise.knak.io/api/published/v1/users?per_page=10&page=2",
        "label": "Next",
        "active": true
      }
    ],
    "path": "https://enterprise.knak.io/api/published/v1/users?per_page=10&page=2",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.