Push

5 endpoints — 2 GET, 3 POST

GET /api/v1/pushAUTH

Returns push requests, optionally filtered by query parameters. Supported filters: any field from PushQuery (error, blocked, allowPush, authorised, canceled, rejected, type).

Authorization Required

This endpoint requires a valid JWT Bearer token in the Authorization header.

Responses

• 200 Ok

---

GET /api/v1/push/{id}AUTH

Returns a single push request by ID.

Authorization Required

This endpoint requires a valid JWT Bearer token in the Authorization header.

Parameters

Name	In	Type	Required	Description
id	path	string	Yes

Responses

• 200 Ok
• 404 Not Found

---

POST /api/v1/push/{id}/authoriseAUTH

Authorises (approves) a pending push request.

Authorization Required

This endpoint requires a valid JWT Bearer token in the Authorization header.

Parameters

Name	In	Type	Required	Description
id	path	string	Yes

Request Body

Field	Type	Required	Description
params	object	Yes

Responses

• 200 Ok
• 400 Bad Request
• 401 Unauthorized
• 403 Forbidden
• 404 Not Found

---

POST /api/v1/push/{id}/cancelAUTH

Cancels a pending push request.

Authorization Required

This endpoint requires a valid JWT Bearer token in the Authorization header.

Parameters

Name	In	Type	Required	Description
id	path	string	Yes

Responses

• 200 Ok
• 401 Unauthorized
• 403 Forbidden

---

POST /api/v1/push/{id}/rejectAUTH

Rejects a pending push request.

Authorization Required

This endpoint requires a valid JWT Bearer token in the Authorization header.

Parameters

Name	In	Type	Required	Description
id	path	string	Yes

Request Body

Field	Type	Required	Description
reason	string	Yes	The reason for rejecting the push request.

Responses

• 200 Ok
• 400 Bad Request
• 401 Unauthorized
• 403 Forbidden
• 404 Not Found

---