Default

Server

Download schema

Default endpoints that are included with Better Auth by default. These endpoints are not part of any plugin.

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/sign-in/social

Request Body

required

callbackURL

string

Callback URL to redirect to after the user has signed in

newUserCallbackURL

string

errorCallbackURL

string

Callback URL to redirect to if an error happens

disableRedirect

boolean

Disable automatic redirection to the provider. Useful for handling the redirection yourself

object

scopes

string[]

Array of scopes to request from the provider. This will override the default scopes passed.

requestSignUp

boolean

Explicitly request sign-up. Useful when disableImplicitSignUp is true for this provider

loginHint

string

The login hint to use for the authorization code request

object

Extra query parameters to append to the provider authorization URL (e.g. Cognito identity_provider, Google hd).

object

Responses

Success - Returns session details (idToken branch) or an authorize URL (redirect branch)

Returns session details when idToken is provided, or an authorize URL otherwise

redirect

boolean · required

token

string

User

url

string

POST/api/auth/sign-in/social

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/sign-in/social \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "callbackURL": "callbackURL",
  "newUserCallbackURL": "newUserCallbackURL",
  "errorCallbackURL": "errorCallbackURL",
  "provider": "apple",
  "disableRedirect": true,
  "idToken": {
    "token": "token",
    "nonce": "nonce",
    "accessToken": "accessToken",
    "refreshToken": "refreshToken",
    "expiresAt": 0,
    "user": {
      "name": {
        "firstName": "firstName",
        "lastName": "lastName"
      },
      "email": "email"
    }
  },
  "scopes": [
    "string"
  ],
  "requestSignUp": true,
  "loginHint": "loginHint",
  "additionalParams": {
    "key": "string"
  },
  "additionalData": {
    "key": {}
  }
}'

Example Request Body

{
  "callbackURL": "callbackURL",
  "newUserCallbackURL": "newUserCallbackURL",
  "errorCallbackURL": "errorCallbackURL",
  "provider": "apple",
  "disableRedirect": true,
  "idToken": {
    "token": "token",
    "nonce": "nonce",
    "accessToken": "accessToken",
    "refreshToken": "refreshToken",
    "expiresAt": 0,
    "user": {
      "name": {
        "firstName": "firstName",
        "lastName": "lastName"
      },
      "email": "email"
    }
  },
  "scopes": [
    "string"
  ],
  "requestSignUp": true,
  "loginHint": "loginHint",
  "additionalParams": {
    "key": "string"
  },
  "additionalData": {
    "key": {}
  }
}

Example Responses

{
  "token": "token",
  "user": {
    "id": "id",
    "name": "name",
    "email": "email",
    "emailVerified": false,
    "image": "image",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  },
  "url": "url",
  "redirect": true
}

application/json

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/callback/{id}

path Parameters

id

string · required

Responses

Bad Request. Usually due to missing parameters, or invalid parameters.

message

string · required

GET/api/auth/callback/{id}

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/callback/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "message": "message"
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/callback/{id}

path Parameters

id

string · required

Request Body optional

code

string

error

string

device_id

string

error_description

string

state

string

user

string

iss

string

Responses

Bad Request. Usually due to missing parameters, or invalid parameters.

message

string · required

POST/api/auth/callback/{id}

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/callback/:id \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "code": "code",
  "error": "error",
  "device_id": "device_id",
  "error_description": "error_description",
  "state": "state",
  "user": "user",
  "iss": "iss"
}'

Example Request Body

{
  "code": "code",
  "error": "error",
  "device_id": "device_id",
  "error_description": "error_description",
  "state": "state",
  "user": "user",
  "iss": "iss"
}

Example Responses

{
  "message": "message"
}

application/json

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/get-session

Get the current session

Responses

Success

Session · required

User · required

GET/api/auth/get-session

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/get-session \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "session": {
    "id": "id",
    "expiresAt": "2024-08-25T15:00:00Z",
    "token": "token",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "ipAddress": "ipAddress",
    "userAgent": "userAgent",
    "userId": "userId"
  },
  "user": {
    "id": "id",
    "name": "name",
    "email": "email",
    "emailVerified": false,
    "image": "image",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/get-session

Get the current session

Request Body

Responses

Success

Session · required

User · required

POST/api/auth/get-session

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/get-session \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

Example Responses

{
  "session": {
    "id": "id",
    "expiresAt": "2024-08-25T15:00:00Z",
    "token": "token",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "ipAddress": "ipAddress",
    "userAgent": "userAgent",
    "userId": "userId"
  },
  "user": {
    "id": "id",
    "name": "name",
    "email": "email",
    "emailVerified": false,
    "image": "image",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/sign-out

Sign out the current user

Request Body optional

callbackURL

string

The URL to redirect to after provider logout

disableRedirect

boolean

Return the provider logout URL without redirecting

state

string

State to pass to the provider logout endpoint

Responses

Success

success

boolean

url

string

Provider logout URL when RP-initiated logout is available

redirect

boolean

Whether the client should redirect to the provider logout URL

POST/api/auth/sign-out

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/sign-out \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "callbackURL": "callbackURL",
  "disableRedirect": true,
  "state": "state"
}'

Example Request Body

{
  "callbackURL": "callbackURL",
  "disableRedirect": true,
  "state": "state"
}

Example Responses

{
  "success": true,
  "url": "url",
  "redirect": true
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/sign-up/email

Request Body

name

string · required

The name of the user

email

string · required

The email of the user

password

string · required

The password of the user

image

string

The profile image URL of the user

callbackURL

string

The URL to use for email verification callback

rememberMe

boolean

If this is false, the session will not be remembered. Default is true.

Responses

Successfully created user

object · required

token

string

Authentication token for the session

POST/api/auth/sign-up/email

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/sign-up/email \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "email": "email",
  "password": "password",
  "image": "image",
  "callbackURL": "callbackURL",
  "rememberMe": true
}'

Example Request Body

{
  "name": "name",
  "email": "email",
  "password": "password",
  "image": "image",
  "callbackURL": "callbackURL",
  "rememberMe": true
}

Example Responses

{
  "token": "token",
  "user": {
    "id": "id",
    "email": "test@example.com",
    "name": "name",
    "image": "https://www.example.com/path/to/resource",
    "emailVerified": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/sign-in/email

Request Body

email

string · required

Email of the user

password

string · required

Password of the user

callbackURL

string

Callback URL to use as a redirect for email verification

rememberMe

boolean

If this is false, the session will not be remembered. Default is true.

Responses

Success - Returns either session details or redirect URL

Session response when idToken is provided

redirect

boolean · enum · required

Enum values:

token

string · required

Session token

User · required

url

string

POST/api/auth/sign-in/email

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/sign-in/email \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "email",
  "password": "password",
  "callbackURL": "callbackURL",
  "rememberMe": true
}'

Example Request Body

{
  "email": "email",
  "password": "password",
  "callbackURL": "callbackURL",
  "rememberMe": true
}

Example Responses

{
  "redirect": false,
  "token": "token",
  "url": "url",
  "user": {
    "id": "id",
    "name": "name",
    "email": "email",
    "emailVerified": false,
    "image": "image",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/reset-password

Reset the password for a user

Request Body

newPassword

string · required

The new password to set

token

string

The token to reset the password

Responses

Success

status

boolean

POST/api/auth/reset-password

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/reset-password \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "newPassword": "newPassword",
  "token": "token"
}'

Example Request Body

{
  "newPassword": "newPassword",
  "token": "token"
}

Example Responses

{
  "status": true
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/verify-password

Verify the current user's password

Request Body

password

string · required

The password to verify

Responses

Success

status

boolean

POST/api/auth/verify-password

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/verify-password \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "password": "password"
}'

Example Request Body

{
  "password": "password"
}

Example Responses

{
  "status": true
}

application/json

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/verify-email

Verify the email of the user

query Parameters

token

string · required

The token to verify the email

callbackURL

string

The URL to redirect to after email verification

Responses

Success

User · required

status

boolean · required

Indicates if the email was verified successfully

GET/api/auth/verify-email

curl 'https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/verify-email?token=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "user": {
    "id": "id",
    "name": "name",
    "email": "email",
    "emailVerified": false,
    "image": "image",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  },
  "status": true
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/send-verification-email

Send a verification email to the user

Request Body

email

string · required

The email to send the verification email to

callbackURL

string

The URL to use for email verification callback

Responses

Success

status

boolean

Indicates if the email was sent successfully

POST/api/auth/send-verification-email

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/send-verification-email \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "user@example.com",
  "callbackURL": "https://example.com/callback"
}'

Example Request Body

{
  "email": "user@example.com",
  "callbackURL": "https://example.com/callback"
}

Example Responses

{
  "status": true
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/change-email

Request Body

newEmail

string · required

The new email address to set must be a valid email address

callbackURL

string

The URL to redirect to after email verification

Responses

Email change request processed successfully

status

boolean · required

Indicates if the request was successful

User

message

string · enum

Status message of the email change process

Enum values:

Email updated

Verification email sent

POST/api/auth/change-email

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/change-email \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "newEmail": "newEmail",
  "callbackURL": "callbackURL"
}'

Example Request Body

{
  "newEmail": "newEmail",
  "callbackURL": "callbackURL"
}

Example Responses

{
  "user": {
    "id": "id",
    "name": "name",
    "email": "email",
    "emailVerified": false,
    "image": "image",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  },
  "status": true,
  "message": "Email updated"
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/change-password

Change the password of the user

Request Body

newPassword

string · required

The new password to set

currentPassword

string · required

The current password is required

revokeOtherSessions

boolean

Must be a boolean value

Responses

Password successfully changed

object · required

token

string

New session token if other sessions were revoked

POST/api/auth/change-password

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/change-password \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "newPassword": "newPassword",
  "currentPassword": "currentPassword",
  "revokeOtherSessions": true
}'

Example Request Body

{
  "newPassword": "newPassword",
  "currentPassword": "currentPassword",
  "revokeOtherSessions": true
}

Example Responses

{
  "token": "token",
  "user": {
    "id": "id",
    "email": "test@example.com",
    "name": "name",
    "image": "https://www.example.com/path/to/resource",
    "emailVerified": true,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/update-session

Update the current session

Request Body

No data returned

Responses

Success

Session

POST/api/auth/update-session

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/update-session \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "key": {}
}'

Example Request Body

{
  "key": {}
}

Example Responses

{
  "session": {
    "id": "id",
    "expiresAt": "2024-08-25T15:00:00Z",
    "token": "token",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "ipAddress": "ipAddress",
    "userAgent": "userAgent",
    "userId": "userId"
  }
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/update-user

Update the current user

Request Body

name

string

The name of the user

image

string

The image of the user

Responses

Success

User

POST/api/auth/update-user

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/update-user \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "image": "image"
}'

Example Request Body

{
  "name": "name",
  "image": "image"
}

Example Responses

{
  "user": {
    "id": "id",
    "name": "name",
    "email": "email",
    "emailVerified": false,
    "image": "image",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/delete-user

Delete the user

Request Body

callbackURL

string

The callback URL to redirect to after the user is deleted

password

string

The user's password. Required if session is not fresh

token

string

The deletion verification token

Responses

User deletion processed successfully

success

boolean · required

Indicates if the operation was successful

message

string · enum · required

Status message of the deletion process

Enum values:

User deleted

Verification email sent

POST/api/auth/delete-user

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/delete-user \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "callbackURL": "callbackURL",
  "password": "password",
  "token": "token"
}'

Example Request Body

{
  "callbackURL": "callbackURL",
  "password": "password",
  "token": "token"
}

Example Responses

{
  "success": true,
  "message": "User deleted"
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/request-password-reset

Send a password reset email to the user

Request Body

email

string · required

The email address of the user to send a password reset email to

redirectTo

string

The URL to redirect the user to reset their password. If the token isn't valid or expired, it'll be redirected with a query parameter ?error=INVALID_TOKEN. If the token is valid, it'll be redirected with a query parameter `?token=VALID_TOKEN

Responses

Success

status

boolean

message

string

POST/api/auth/request-password-reset

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/request-password-reset \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "email",
  "redirectTo": "redirectTo"
}'

Example Request Body

{
  "email": "email",
  "redirectTo": "redirectTo"
}

Example Responses

{
  "status": true,
  "message": "message"
}

application/json

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/reset-password/{token}

Redirects the user to the callback URL with the token

path Parameters

token

string · required

The token to reset the password

query Parameters

callbackURL

string · required

The URL to redirect the user to reset their password

Responses

Success

token

string

GET/api/auth/reset-password/{token}

curl 'https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/reset-password/:token?callbackURL=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "token": "token"
}

application/json

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/list-sessions

List all active sessions for the user

Responses

Success

Session[]

Session

id

string · readOnly · required

expiresAt

string · date-time · required

token

string · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

userId

string · required

ipAddress

string

userAgent

string

GET/api/auth/list-sessions

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/list-sessions \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "id",
    "expiresAt": "2024-08-25T15:00:00Z",
    "token": "token",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "ipAddress": "ipAddress",
    "userAgent": "userAgent",
    "userId": "userId"
  }
]

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/revoke-session

Revoke a single session

Request Body

token

string · required

The token to revoke

Responses

Success

status

boolean · required

Indicates if the session was revoked successfully

POST/api/auth/revoke-session

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/revoke-session \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "token": "token"
}'

Example Request Body

{
  "token": "token"
}

Example Responses

{
  "status": true
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/revoke-sessions

Revoke all sessions for the user

Request Body

Responses

Success

status

boolean · required

Indicates if all sessions were revoked successfully

POST/api/auth/revoke-sessions

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/revoke-sessions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

Example Responses

{
  "status": true
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/revoke-other-sessions

Revoke all other sessions for the user except the current one

Request Body

Responses

Success

status

boolean · required

Indicates if all other sessions were revoked successfully

POST/api/auth/revoke-other-sessions

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/revoke-other-sessions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

Example Responses

{
  "status": true
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/link-social

Link a social account to the user

Request Body

required

callbackURL

string

The URL to redirect to after the user has signed in

object

requestSignUp

boolean

scopes

string[]

Additional scopes to request from the provider

errorCallbackURL

string

The URL to redirect to if there is an error during the link process

disableRedirect

boolean

Disable automatic redirection to the provider. Useful for handling the redirection yourself

loginHint

string

The login hint to use for the authorization code request

object

Extra query parameters to append to the provider authorization URL (e.g. Cognito identity_provider, Google hd).

object

Responses

Success

redirect

boolean · required

Indicates if the user should be redirected to the authorization URL

url

string

The authorization URL to redirect the user to

status

boolean

POST/api/auth/link-social

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/link-social \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "callbackURL": "callbackURL",
  "provider": "apple",
  "idToken": {
    "token": "token",
    "nonce": "nonce",
    "accessToken": "accessToken",
    "refreshToken": "refreshToken"
  },
  "requestSignUp": true,
  "scopes": [
    "string"
  ],
  "errorCallbackURL": "errorCallbackURL",
  "disableRedirect": true,
  "loginHint": "loginHint",
  "additionalParams": {
    "key": "string"
  },
  "additionalData": {
    "key": {}
  }
}'

Example Request Body

{
  "callbackURL": "callbackURL",
  "provider": "apple",
  "idToken": {
    "token": "token",
    "nonce": "nonce",
    "accessToken": "accessToken",
    "refreshToken": "refreshToken"
  },
  "requestSignUp": true,
  "scopes": [
    "string"
  ],
  "errorCallbackURL": "errorCallbackURL",
  "disableRedirect": true,
  "loginHint": "loginHint",
  "additionalParams": {
    "key": "string"
  },
  "additionalData": {
    "key": {}
  }
}

Example Responses

{
  "url": "url",
  "redirect": true,
  "status": true
}

application/json

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/list-accounts

List all accounts linked to the user

Responses

Success

object[]

id

string · required

providerId

string · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

issuer

string · required

accountId

string · required

userId

string · required

scopes

string[] · required

GET/api/auth/list-accounts

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/list-accounts \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "id",
    "providerId": "providerId",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "issuer": "issuer",
    "accountId": "accountId",
    "userId": "userId",
    "scopes": [
      "string"
    ]
  }
]

application/json

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/delete-user/callback

Callback to complete user deletion with verification token

query Parameters

token

string

The token to verify the deletion request

callbackURL

string

The URL to redirect to after deletion

Responses

User successfully deleted

success

boolean · required

Indicates if the deletion was successful

message

string · enum · required

Confirmation message

Enum values:

User deleted

GET/api/auth/delete-user/callback

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/delete-user/callback \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "success": true,
  "message": "User deleted"
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/unlink-account

Unlink an account

Request Body

accountId

string · required

The Better Auth account ID to unlink

Responses

Success

status

boolean

POST/api/auth/unlink-account

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/unlink-account \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "accountId": "accountId"
}'

Example Request Body

{
  "accountId": "accountId"
}

Example Responses

{
  "status": true
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/refresh-token

Refresh the access token using a refresh token

Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: accountId
	type = object · requires: useAccountCookie

Properties for Variant 1:

accountId

string · required

The Better Auth account ID

userId

string

The user ID associated with the account

Responses

Access token refreshed successfully

tokenType

string

idToken

string

accessToken

string

refreshToken

string

accessTokenExpiresAt

string · date-time

refreshTokenExpiresAt

string · date-time

POST/api/auth/refresh-token

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/refresh-token \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "accountId": "accountId",
  "userId": "userId"
}'

Example Request Body

{
  "accountId": "accountId",
  "userId": "userId"
}

Example Responses

{
  "tokenType": "tokenType",
  "idToken": "idToken",
  "accessToken": "accessToken",
  "refreshToken": "refreshToken",
  "accessTokenExpiresAt": "2024-08-25T15:00:00Z",
  "refreshTokenExpiresAt": "2024-08-25T15:00:00Z"
}

application/json

POST

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/get-access-token

Get a valid access token, doing a refresh if needed

Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: accountId
	type = object · requires: useAccountCookie

Properties for Variant 1:

accountId

string · required

The Better Auth account ID

userId

string

The user ID associated with the account

Responses

A Valid access token

tokenType

string

idToken

string

accessToken

string

accessTokenExpiresAt

string · date-time

POST/api/auth/get-access-token

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/get-access-token \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "accountId": "accountId",
  "userId": "userId"
}'

Example Request Body

{
  "accountId": "accountId",
  "userId": "userId"
}

Example Responses

{
  "tokenType": "tokenType",
  "idToken": "idToken",
  "accessToken": "accessToken",
  "accessTokenExpiresAt": "2024-08-25T15:00:00Z"
}

application/json

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/account-info

Get the account info provided by the provider

Responses

Success

object · required

GET/api/auth/account-info

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/account-info \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "user": {
    "name": "name",
    "email": "email",
    "image": "image",
    "emailVerified": true
  },
  "account": {
    "id": "id",
    "providerId": "providerId",
    "issuer": "issuer",
    "accountId": "accountId"
  },
  "data": {}
}

application/json

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/ok

Check if the API is working

Responses

API is working

ok

boolean · required

Indicates if the API is working

GET/api/auth/ok

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/ok \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "ok": true
}

application/json

GET

https://capworks-api-docs.pages.dev/proxy/capworks

/api/auth/error

Displays an error page

Responses

Success

string

The HTML content of the error page

GET/api/auth/error

curl https://capworks-api-docs.pages.dev/proxy/capworks/api/auth/error \
  --header 'Authorization: Bearer <token>'

Example Responses

string

text/html

Email-otp