Skip to content

Pearl of the Orient API Docs (1.0.0)

Quick Overview

  • API Version: 1.0.0
  • Developer: Kyle Andre Lim
  • Base Path: /api/v1

Comprehensive API documentation for authentication, users, members, branch services, and offices endpoints.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://docs-api.pearl-chaplaincy.com
License
Apache-2.0
Languages
Servers
Mock server
https://api-docs.pearlchaplaincy.org/_mock/openapi
Version 1 API base path
https://api-docs.pearlchaplaincy.org/api/v1

System

Health and root metadata endpoints

Operations

API root status

Request

curl -i -X GET \
  https://api-docs.pearlchaplaincy.org/_mock/openapi/

Responses

API status metadata

Bodyapplication/json
codestringrequired
Example: "OK"
messagestringrequired
Example: "API is live"
statusstringrequired
Example: "ok"
versionstringrequired
Example: "1.0.0"
docsstring(uri)required
developerstringrequired
timestampstring(date-time)required
Response
application/json
{
  "code": "OK",
  "message": "API is live",
  "status": "ok",
  "version": "1.0.0",
  "docs": "http://example.com",
  "developer": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Auth

Authentication and account recovery

Operations

Users

User profile and admin user management

Operations

Members

Member application and management

Operations

Branch Service

Branch of service management

Operations

Offices

Office title management

Operations