List Users
Returns a paginated list of user objects.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter users returned in the response.
Show Child Parameters
Response
application/json
Response
A paginated list response for a collection of users.
returns the pagination information
Show Child Parameters
The user object contains information about an individual user who can use the Konnect application and API.
Example:{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"user@email.com","full_name":"Test User","preferred_name":"test","active":true,"inferred_region":"us","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z"}
Show Child Parameters
Authentication
Query Parameters
Get a User
Returns the user object for the user ID specified as a path parameter.
Path Parameters
The ID of the user being deleted.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
A get action response of a single user.
User
The user object contains information about an individual user who can use the Konnect application and API.
The User ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The email registered to the user.
<= 250 characters
Example:user@email.com
The User’s full name.
Match pattern:^[\w \W]+$
<= 250 characters
Example:Jane Doe
The User’s preferred name.
<= 250 characters
Example:Jane
Returns True if a user has verified their email address.
Default:true
The Konnect region closest to the user’s IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.
Example:us
The time stamp for the date the account was registered.
Example:2022-02-07T17:46:57.52Z
A Unix timestamp representation of the most recent change to the User account.
Example:2022-10-08T17:00:00.52Z
Authentication
Path Parameters
Update User
Update an individual user.
Path Parameters
The ID of the user being deleted.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
The request schema for the update user request.
The user’s full name.
Match pattern:^[\w \W]+$
<= 250 characters
Example:James C. Woods
The user’s desired name.
<= 250 characters
Example:Jimmy
Response
application/json
Response
A get action response of a single user.
User
The user object contains information about an individual user who can use the Konnect application and API.
The User ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The email registered to the user.
<= 250 characters
Example:user@email.com
The User’s full name.
Match pattern:^[\w \W]+$
<= 250 characters
Example:Jane Doe
The User’s preferred name.
<= 250 characters
Example:Jane
Returns True if a user has verified their email address.
Default:true
The Konnect region closest to the user’s IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.
Example:us
The time stamp for the date the account was registered.
Example:2022-02-07T17:46:57.52Z
A Unix timestamp representation of the most recent change to the User account.
Example:2022-10-08T17:00:00.52Z
Authentication
Path Parameters
Body
Delete User
Deletes an individual user. Returns 404 if the requested user was not found.
Path Parameters
The ID of the user being deleted.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
No Content