Notifications

List Notifications

get

Retrieves a paginated list of notifications for the current user.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/notifications

HTTPcURLJavaScriptPython

GET /api/v1/notifications HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "read": "example_read",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "type": "example_type",
      "read_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/notifications",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/notifications?page=1",
    "last": "https://api.example.com/api/v1/notifications?page=1",
    "prev": null,
    "next": null
  }
}

Read Notifications

patch

Marks all notifications as read for the current user.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

patch

/api/v1/notifications

HTTPcURLJavaScriptPython

PATCH /api/v1/notifications HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}

Update Notification

put

Updates a specific notification, for example to mark it as read.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

notificationstringRequired

The notification identifier.

Body

application/json

readstringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/notifications/{notification}

HTTPcURLJavaScriptPython

PUT /api/v1/notifications/{notification} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "read": "text"
}

{
  "data": {
    "id": 1,
    "read": "example_read",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "type": "example_type",
    "read_at": "2025-01-15T10:30:00.000000Z"
  }
}

Delete Notification

delete

Permanently deletes a specific notification.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

notificationstringRequired

The notification identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/notifications/{notification}

HTTPcURLJavaScriptPython

DELETE /api/v1/notifications/{notification} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}