Users

Create User

• Endpoint: POST /users

• Description: Create a new user account.

• Request Body:

  • email: User's email address.

  • name: User's name.

  • password: User's password.

• Response: User object containing user account details.

Request

curl -X POST \
     -H "Content-Type: application/json" \
     -d '{"email": "[e-mail]", "name": "John Doe", "password": "password123"}' \
     https://api.pagepeek.com/v1/users

Response

{
    "userId": "user123",
    "email": "[e-mail]",
    "name": "John Doe",
    "createdAt": "2023-10-01T12:00:00Z",
    "updatedAt": "2023-10-01T12:00:00Z"
}

Get User

• Endpoint: GET /users/:user_id

• Description: Retrieve the details of a specific user.

• Response: User object containing user account details.

Request

curl -X GET \
     -H "Authorization: Bearer your_api_key_here" \
     https://api.pagepeek.com/v1/users/user123

Response

{
    "userId": "user123",
    "email": "[e-mail]",
    "name": "John Doe",
    "createdAt": "2023-10-01T12:00:00Z",
    "updatedAt": "2023-10-01T12:00:00Z"
}

Update User

• Endpoint: PUT /users/:user_id

• Description: Update the details of a specific user.

• Request Body:

  • email: Updated email address (optional).

  • name: Updated name (optional).

  • password: Updated password (optional).

• Response: User object containing updated user account details.

Request

curl -X PUT \
     -H "Authorization: Bearer your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{"email": "[e-mail]", "name": "John Smith"}' \
     https://api.pagepeek.com/v1/users/user123

Response

{
    "userId": "user123",
    "email": "[e-mail]",
    "name": "John Smith",
    "updatedAt": "2023-10-02T12:00:00Z"
}