Health and root metadata endpoints
/
List users (admin only)
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
- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/users/current
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/users/current
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api-docs.pearlchaplaincy.org/_mock/openapi/users/current \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "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/users/current
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/users/current
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://api-docs.pearlchaplaincy.org/_mock/openapi/users/current \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"email": "user@example.com",
"avatar": "string"
}'Response
application/json
{ "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/users/current
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/users/current
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://api-docs.pearlchaplaincy.org/_mock/openapi/users/current \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/users
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/users
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-docs.pearlchaplaincy.org/_mock/openapi/users?limit=1&offset=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "total": 0, "limit": 0, "offset": 0, "totalPages": 0, "currentPage": 0, "hasMore": true, "users": [ { … } ] }
- Mock serverhttps://api-docs.pearlchaplaincy.org/_mock/openapi/users/{userId}
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/users/{userId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-docs.pearlchaplaincy.org/_mock/openapi/users/{userId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "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/users/{userId}
- Version 1 API base pathhttps://api-docs.pearlchaplaincy.org/api/v1/users/{userId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://api-docs.pearlchaplaincy.org/_mock/openapi/users/{userId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'