Health and root metadata endpoints
Pearl of the Orient API Docs (1.0.0)
Download OpenAPI description
Overview
URL
License
Languages
Servers
Mock server
https://api-docs.pearlchaplaincy.org/_mock/openapi
Version 1 API base path
https://api-docs.pearlchaplaincy.org/api/v1
Bodyapplication/jsonrequired
Must include at least 1 uppercase letter, 1 number, and 1 special character
- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/auth/register
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/auth/register
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-docs.pearlchaplaincy.org/_mock/openapi/auth/register \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"email": "user@example.com",
"password": "stringst",
"role": "MEMBER"
}'Response
application/json
{ "code": "OK", "message": "string", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "user@example.com", "avatar": "string", "role": "MEMBER", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "isEmailVerified": true }, "accessToken": "string", "mfaRequired": true }
- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/auth/login
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/auth/login
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-docs.pearlchaplaincy.org/_mock/openapi/auth/login \
-H 'Content-Type: application/json' \
-d '{
"email": "user@example.com",
"password": "stringst",
"userAgent": "string"
}'Response
application/json
{ "code": "OK", "message": "string", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "user@example.com", "avatar": "string", "role": "MEMBER", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "isEmailVerified": true }, "accessToken": "string", "mfaRequired": true }
- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/auth/logout
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/auth/logout
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://api-docs.pearlchaplaincy.org/_mock/openapi/auth/logout \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/auth/refresh-token
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/auth/refresh-token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api-docs.pearlchaplaincy.org/_mock/openapi/auth/refresh-token \
-b refreshToken=YOUR_API_KEY_HEREResponse
application/json
{ "accessToken": "string" }
- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/auth/forgot-password
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/auth/forgot-password
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-docs.pearlchaplaincy.org/_mock/openapi/auth/forgot-password \
-H 'Content-Type: application/json' \
-d '{
"email": "user@example.com"
}'- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/auth/reset-password
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/auth/reset-password
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-docs.pearlchaplaincy.org/_mock/openapi/auth/reset-password?token=string' \
-H 'Content-Type: application/json' \
-d '{
"password": "stringst",
"confirmPassword": "stringst"
}'- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/auth/verify-email
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/auth/verify-email
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-docs.pearlchaplaincy.org/_mock/openapi/auth/verify-email \
-H 'Content-Type: application/json' \
-d '{
"code": "string"
}'Response
application/json
{ "code": "OK", "message": "string", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "user@example.com", "avatar": "string", "role": "MEMBER", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "isEmailVerified": true } }
- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/auth/resend-email-verification
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/auth/resend-email-verification
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api-docs.pearlchaplaincy.org/_mock/openapi/auth/resend-email-verification \
-H 'Content-Type: application/json' \
-d '{
"email": "user@example.com"
}'Response
application/json
{ "code": "OK", "message": "string", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "user@example.com", "avatar": "string", "role": "MEMBER", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "isEmailVerified": true }, "accessToken": "string", "mfaRequired": true }