Users Endpoints

Method	URL	Description
`POST`	`https://api.qwikgeo.com/api/v1/users/`	Create User
`GET`	`https://api.qwikgeo.com/api/v1/users/me`	User
`PUT`	`https://api.qwikgeo.com/api/v1/users/me`	Update User
`DELETE`	`https://api.qwikgeo.com/api/v1/users/me`	Delete User
`GET`	`https://api.qwikgeo.com/api/v1/users/`	User Search

Endpoint Description's

Create User

Description

The create user endpoint allows you to create a new user to use QwikGeo.

Create user endpoint is available at https://api.qwikgeo.com/api/v1/users/

Example Input

{
    "username": "johndoe",
    "password_hash": "secret",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]"
}

Example Output

{
    "id": 1,
    "username": "johndoe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "photo_url": null,
    "created_at": "2022-08-19T18:44:55.415824+00:00",
    "modified_at": "2022-08-19T18:44:55.415846+00:00"
}

User

Description

The user endpoint allows you to view your user information.

User endpoint is available at https://api.qwikgeo.com/api/v1/users/me

Example Output

{
    "id": 1,
    "username": "johndoe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "photo_url": null,
    "created_at": "2022-08-19T18:44:55.415824+00:00",
    "modified_at": "2022-08-19T18:44:55.415846+00:00"
}

Update User

Description

The update user endpoint allows you to update information about your account.

Update user endpoint is available at https://api.qwikgeo.com/api/v1/users/me

Example Input

{
    "username": "johndoe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]"
}

Example Output

{
    "id": 1,
    "username": "johndoe",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "photo_url": null,
    "created_at": "2022-08-19T18:44:55.415824+00:00",
    "modified_at": "2022-08-19T18:44:55.415846+00:00"
}

Delete User

Description

The delete user endpoint allows you to delete your account.

Delete user endpoint is available at https://api.qwikgeo.com/api/v1/users/me

Example Output

{
    "message": "Deleted user."
}

User Search

Description

The update user endpoint allows you to update information about your account.

Update user endpoint is available at https://api.qwikgeo.com/api/v1/users/

Example

Search for users who username contain john.

Example Input

curl `https://api.qwikgeo.com/api/v1/users/?username=john`

Example Output

{
    "users": [
        {
            "username": "johndoe",

        }
    ]
}