Notification Permission Manager - API Contract

GET /api/v1/notification-permissions/api/v1/notification-permissions

List permission status records across users (admin)

Public

Response Example

{
  "data": [
    {
      "permission_id": "perm-601",
      "user_id": "usr-441",
      "platform": "android",
      "status": "granted",
      "checked_at": "2026-03-26T08:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 120
  }
}

GET /api/v1/notification-permissions/api/v1/notification-permissions/:id

Get a permission status record by ID

Public

Response Example

{
  "permission_id": "perm-601",
  "user_id": "usr-441",
  "platform": "android",
  "status": "granted",
  "checked_at": "2026-03-26T08:00:00Z"
}

POST /api/v1/notification-permissions/api/v1/notification-permissions

Record a new permission check/request result for a user

Public

Request Example

{
  "user_id": "usr-441",
  "platform": "ios",
  "status": "denied"
}

Response Example

{
  "permission_id": "perm-620",
  "user_id": "usr-441",
  "platform": "ios",
  "status": "denied",
  "checked_at": "2026-03-26T10:00:00Z"
}

PUT /api/v1/notification-permissions/api/v1/notification-permissions/:id

Update a permission status record

Public

Request Example

{
  "status": "granted",
  "checked_at": "2026-03-26T10:30:00Z"
}

Response Example

{
  "permission_id": "perm-620",
  "user_id": "usr-441",
  "platform": "ios",
  "status": "granted",
  "checked_at": "2026-03-26T10:30:00Z"
}

DELETE /api/v1/notification-permissions/api/v1/notification-permissions/:id

Delete a permission record

Public

Response Example

{
  "deleted": true,
  "permission_id": "perm-601"
}

GET /api/v1/notification-permissions/api/v1/notification-permissions/user/:user_id

Get current permission status for a user

Public

Response Example

{
  "user_id": "usr-441",
  "platform": "android",
  "status": "granted",
  "checked_at": "2026-03-26T08:00:00Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}