Matches in other apps
zpe-reviews
mount /reviews · base https://zpe.vc/reviews · v0.1.0 · 8 operations · 6 write · 0 need no account · wip
archived: committed 2026-11-03, from 86eb111c. Contract: https://zpe.vc/reviews/_/api/v1/openapi.json
GET
/_/api/v1/reviews
Every review this account holds, newest first, with what verified it and its state
getReviews
Every review this account holds, newest first, with what verified it and its state
Parameters
No parameters.
Request body
None: this operation takes its arguments in the path and the query.
Responses
| status | meaning | body |
|---|---|---|
200 | The answer | object |
400 | The request could not be read | object |
401 | The credential is missing or does not open this account | object |
403 | This account may not do that | object |
404 | Nothing is here | object |
429 | Too many requests | object |
Example
Every review this account holds, newest first, with what verified it and its state, with a token from the door.
curl -X GET 'https://zpe.vc/reviews/_/api/v1/reviews' \ -H 'Authorization: Bearer $ZPE_TOKEN'
{}The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.
GET
/_/api/v1/wall
The two populations and their counts, with the gap published only above the minimum sample
getWall
The two populations and their counts, with the gap published only above the minimum sample
Parameters
| name | in | required | type | notes |
|---|---|---|---|---|
business | query | yes | string |
Request body
None: this operation takes its arguments in the path and the query.
Responses
| status | meaning | body |
|---|---|---|
200 | The answer | object |
400 | The request could not be read | object |
401 | The credential is missing or does not open this account | object |
403 | This account may not do that | object |
404 | Nothing is here | object |
429 | Too many requests | object |
Example
The two populations and their counts, with the gap published only above the minimum sample, with a token from the door.
curl -X GET 'https://zpe.vc/reviews/_/api/v1/wall?business=string' \ -H 'Authorization: Bearer $ZPE_TOKEN'
{}The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.
POST
/_/api/v1/erasures
Honour an erasure request by the person's address: the contact record goes, the review becomes a tombstone, one event records it
postErasures
Honour an erasure request by the person's address: the contact record goes, the review becomes a tombstone, one event records it
Parameters
No parameters.
Request body application/json · required
| field | type | required | notes |
|---|---|---|---|
business | string | yes | |
contact | string | yes |
Responses
| status | meaning | body |
|---|---|---|
200 | The answer | object |
400 | The request could not be read | object |
401 | The credential is missing or does not open this account | object |
403 | This account may not do that | object |
404 | Nothing is here | object |
429 | Too many requests | object |
Example
Honour an erasure request by the person's address: the contact record goes, the review becomes a tombstone, one event records it, with a token from the door.
curl -X POST 'https://zpe.vc/reviews/_/api/v1/erasures' \
-H 'Authorization: Bearer $ZPE_TOKEN' \
-H 'content-type: application/json' \
-d '{
"business": "string",
"contact": "string"
}'{}The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.
POST
/_/api/v1/replies/forward
Turn the copy of a tenant's replies on or off and say where it goes. The stored inbox is never affected
postRepliesForward
Turn the copy of a tenant's replies on or off and say where it goes. The stored inbox is never affected
Parameters
No parameters.
Request body application/json · required
| field | type | required | notes |
|---|---|---|---|
business | string | yes | |
forward_to | string | no | |
enabled | boolean | yes |
Responses
| status | meaning | body |
|---|---|---|
200 | The answer | object |
400 | The request could not be read | object |
401 | The credential is missing or does not open this account | object |
403 | This account may not do that | object |
404 | Nothing is here | object |
429 | Too many requests | object |
Example
Turn the copy of a tenant's replies on or off and say where it goes. The stored inbox is never affected, with a token from the door.
curl -X POST 'https://zpe.vc/reviews/_/api/v1/replies/forward' \
-H 'Authorization: Bearer $ZPE_TOKEN' \
-H 'content-type: application/json' \
-d '{
"business": "string",
"forward_to": "string",
"enabled": false
}'{}The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.
POST
/_/api/v1/appeals
Decide a removal appeal. Refused when the deciding principal is the one who removed it, so the chain shows two signatures
postAppeals
Decide a removal appeal. Refused when the deciding principal is the one who removed it, so the chain shows two signatures
Parameters
No parameters.
Request body application/json · required
| field | type | required | notes |
|---|---|---|---|
review | string | yes | |
decision | "restore" | "uphold" | yes | |
note | string | no |
Responses
| status | meaning | body |
|---|---|---|
200 | The answer | object |
400 | The request could not be read | object |
401 | The credential is missing or does not open this account | object |
403 | This account may not do that | object |
404 | Nothing is here | object |
429 | Too many requests | object |
Example
Decide a removal appeal. Refused when the deciding principal is the one who removed it, so the chain shows two signatures, with a token from the door.
curl -X POST 'https://zpe.vc/reviews/_/api/v1/appeals' \
-H 'Authorization: Bearer $ZPE_TOKEN' \
-H 'content-type: application/json' \
-d '{
"review": "string",
"decision": "restore",
"note": "string"
}'{}The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.
POST
/_/api/v1/invitations
Create an invitation per eligible purchase and, when a sender is configured, send it. One purchase buys one review, and the address is never stored
postInvitations
Create an invitation per eligible purchase and, when a sender is configured, send it. One purchase buys one review, and the address is never stored
Parameters
No parameters.
Request body application/json · required
| field | type | required | notes |
|---|---|---|---|
business | string | yes | |
recipients | array of object | yes | |
window_days | number | no | |
send | boolean | no |
Responses
| status | meaning | body |
|---|---|---|
200 | The answer | object |
400 | The request could not be read | object |
401 | The credential is missing or does not open this account | object |
403 | This account may not do that | object |
404 | Nothing is here | object |
429 | Too many requests | object |
Example
Create an invitation per eligible purchase and, when a sender is configured, send it. One purchase buys one review, and the address is never stored, with a token from the door.
curl -X POST 'https://zpe.vc/reviews/_/api/v1/invitations' \
-H 'Authorization: Bearer $ZPE_TOKEN' \
-H 'content-type: application/json' \
-d '{
"business": "string",
"recipients": [
{
"purchase": "string",
"contact": "string"
}
],
"window_days": 0,
"send": false
}'{}The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.
POST
/_/api/v1/claims
State the domain a business owns and get the record name and value that prove it, or the page tag instead
postClaims
State the domain a business owns and get the record name and value that prove it, or the page tag instead
Parameters
No parameters.
Request body application/json · required
| field | type | required | notes |
|---|---|---|---|
business | string | yes | |
domain | string | yes |
Responses
| status | meaning | body |
|---|---|---|
200 | The answer | object |
400 | The request could not be read | object |
401 | The credential is missing or does not open this account | object |
403 | This account may not do that | object |
404 | Nothing is here | object |
429 | Too many requests | object |
Example
State the domain a business owns and get the record name and value that prove it, or the page tag instead, with a token from the door.
curl -X POST 'https://zpe.vc/reviews/_/api/v1/claims' \
-H 'Authorization: Bearer $ZPE_TOKEN' \
-H 'content-type: application/json' \
-d '{
"business": "string",
"domain": "string"
}'{}The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.
POST
/_/api/v1/claims/verify
Read the TXT record and the page, and mark the business claimed when either answers. Until then it can publish nothing
postClaimsVerify
Read the TXT record and the page, and mark the business claimed when either answers. Until then it can publish nothing
Parameters
No parameters.
Request body application/json · required
| field | type | required | notes |
|---|---|---|---|
business | string | yes |
Responses
| status | meaning | body |
|---|---|---|
200 | The answer | object |
400 | The request could not be read | object |
401 | The credential is missing or does not open this account | object |
403 | This account may not do that | object |
404 | Nothing is here | object |
429 | Too many requests | object |
Example
Read the TXT record and the page, and mark the business claimed when either answers. Until then it can publish nothing, with a token from the door.
curl -X POST 'https://zpe.vc/reviews/_/api/v1/claims/verify' \
-H 'Authorization: Bearer $ZPE_TOKEN' \
-H 'content-type: application/json' \
-d '{
"business": "string"
}'{}The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.