List users

1 min

GET

https://api.app.kognic.com/v2/users

Query Parameters

organizationIdinteger<int64>
Format
int64
accountStatusUserAccountStatus
emailstring[]
accountTypeAccountType

Responses

200

Enveloped_Seq_User
- dataUser[]
  - accountStatusUserAccountStatusrequired
  - accountTypeAccountTyperequired
  - emailstringrequired
  - firstNamestringrequired
  - idinteger<int64>required
    Format
    int64
  - lastNamestringrequired
  - organizationLightOrganizationrequired
    - idinteger<int64>required
      Format
      int64
    - namestringrequired
  - rolesUserRole[]
    - idstring<uuid>required
      Format
      uuid
    - namestringrequired

400Bad request

BadRequest
- errorCodestring
- messagestringrequired

401Unauthorized

Unauthorized
- messagestringrequired

403Forbidden

Forbidden
- messagestringrequired

python

import requests
import json

url = "https://api.app.kognic.com/v2/users?accountStatus=object&accountType=object"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

{
  "data": [
    {
      "accountStatus": "",
      "accountType": "",
      "email": "",
      "firstName": "",
      "id": "",
      "lastName": "",
      "organization": {
        "id": "",
        "name": ""
      },
      "roles": [
        {
          "id": "",
          "name": ""
        }
      ]
    }
  ]
}

400

// Bad request
{
  "errorCode": "",
  "message": ""
}

401

// Unauthorized
{
  "message": ""
}

403

// Forbidden
{
  "message": ""
}