API Documentation
Notifications ¶
GET /api/v2/notifications
Requests
GET /api/v2/notifications
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [],
"links": {
"first": "http://api-test.productive.io/api/v2/notifications?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/notifications?page%5Bnumber%5D=0&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 0,
"total_count": 0,
"page_size": 30,
"max_page_size": 200
}
}
Get notificationsGET/api/v2/notifications
GET /api/v2/notifications/1
Requests
GET /api/v2/notifications/233
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "233",
"type": "notifications",
"attributes": {
"target_id": 43,
"target_type": "task",
"target_title": "#1: Ticket title",
"parent_id": 588,
"parent_type": "project",
"parent_title": "[Client1351] test project",
"title": "created task <b>#1: Ticket title</b> on <b>[Client1351] test project</b>",
"read": false,
"dismissed": false,
"new_activities_count": 1,
"excerpt": "",
"last_action_at": null,
"first_unread_activity_id": 13,
"changeset": [],
"important": false,
"mention": false,
"target_label": "task",
"made_by_automation": false,
"root_id": null,
"root_type": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "740"
}
},
"actor": {
"meta": {
"included": false
}
},
"owner": {
"data": {
"type": "organization_memberships",
"id": "2748"
}
}
}
},
"meta": {}
}
Shows a notificationGET/api/v2/notifications/{id}
URI Parameters
- id
number
(required) Example: 1notification id
PATCH /api/v2/notifications/1/dismiss
Requests
PATCH /api/v2/notifications/234/dismiss
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "234",
"type": "notifications",
"attributes": {
"target_id": 46,
"target_type": "task",
"target_title": "#1: Ticket title",
"parent_id": 598,
"parent_type": "project",
"parent_title": "[Client1361] test project",
"title": "created task <b>#1: Ticket title</b> on <b>[Client1361] test project</b>",
"read": false,
"dismissed": true,
"new_activities_count": 1,
"excerpt": "",
"last_action_at": null,
"first_unread_activity_id": 14,
"changeset": [],
"important": false,
"mention": false,
"target_label": "task",
"made_by_automation": false,
"root_id": null,
"root_type": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "741"
}
},
"actor": {
"meta": {
"included": false
}
},
"owner": {
"data": {
"type": "organization_memberships",
"id": "2768"
}
}
}
},
"meta": {}
}
Dismisses a notificationPATCH/api/v2/notifications/{id}/dismiss
URI Parameters
- id
number
(required) Example: 1notification id
PATCH /api/v2/notifications/236/read
Requests
PATCH /api/v2/notifications/236/read
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "236",
"type": "notifications",
"attributes": {
"target_id": 52,
"target_type": "task",
"target_title": "#1: Ticket title",
"parent_id": 618,
"parent_type": "project",
"parent_title": "[Client1381] test project",
"title": "created task <b>#1: Ticket title</b> on <b>[Client1381] test project</b>",
"read": true,
"dismissed": false,
"new_activities_count": 1,
"excerpt": "",
"last_action_at": null,
"first_unread_activity_id": 16,
"changeset": [],
"important": false,
"mention": false,
"target_label": "task",
"made_by_automation": false,
"root_id": null,
"root_type": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "743"
}
},
"actor": {
"meta": {
"included": false
}
},
"owner": {
"data": {
"type": "organization_memberships",
"id": "2808"
}
}
}
},
"meta": {}
}
Reads a notificationPATCH/api/v2/notifications/{id}/read
URI Parameters
- id
number
(required) Example: 236
PATCH /api/v2/notifications/1/undismiss
Requests
PATCH /api/v2/notifications/238/undismiss
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "238",
"type": "notifications",
"attributes": {
"target_id": 58,
"target_type": "task",
"target_title": "#1: Ticket title",
"parent_id": 638,
"parent_type": "project",
"parent_title": "[Client1401] test project",
"title": "created task <b>#1: Ticket title</b> on <b>[Client1401] test project</b>",
"read": false,
"dismissed": false,
"new_activities_count": 1,
"excerpt": "",
"last_action_at": null,
"first_unread_activity_id": 18,
"changeset": [],
"important": true,
"mention": true,
"target_label": "task",
"made_by_automation": false,
"root_id": null,
"root_type": null
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "745"
}
},
"actor": {
"meta": {
"included": false
}
},
"owner": {
"data": {
"type": "organization_memberships",
"id": "2848"
}
}
}
},
"meta": {}
}
Undismisses a notificationPATCH/api/v2/notifications/{id}/undismiss
URI Parameters
- id
number
(required) Example: 1notification id
Generated by aglio on 20 Jul 2025