API Documentation

API Endpoint

Discussions

Discussions

Discussion is a thread of comments related to the highlighted part of docs (page) content.

Supported filter params

  • id

  • page_id

  • status (1: active, 2: resolved)

Supported sort params

  • created_at

  • resolved_at

  • updated_at

GET /api/v2/discussions
Requestsreturns discussions

GET  /api/v2/discussions

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "1",
      "type": "discussions",
      "attributes": {
        "excerpt": null,
        "resolved_at": null,
        "subscriber_ids": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "432"
          }
        },
        "page": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "2",
      "type": "discussions",
      "attributes": {
        "excerpt": null,
        "resolved_at": null,
        "subscriber_ids": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "432"
          }
        },
        "page": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "3",
      "type": "discussions",
      "attributes": {
        "excerpt": null,
        "resolved_at": null,
        "subscriber_ids": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "432"
          }
        },
        "page": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/discussions?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/discussions?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 3,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get discussions
GET/api/v2/discussions

GET /api/v2/discussions/1
Requestsreturns discussion

GET  /api/v2/discussions/4

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4",
    "type": "discussions",
    "attributes": {
      "excerpt": null,
      "resolved_at": null,
      "subscriber_ids": []
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "433"
        }
      },
      "page": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a discussion
GET/api/v2/discussions/{id}

URI Parameters
HideShow
id
number (required) Example: 1

discussion id

POST /api/v2/discussions
Requestscreates discussionreturns error

POST  /api/v2/discussions

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
Body
{
  "data": {
    "type": "discussions",
    "attributes": {},
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "4"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "6",
    "type": "discussions",
    "attributes": {
      "excerpt": null,
      "resolved_at": null,
      "subscriber_ids": []
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "434"
        }
      },
      "page": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Create an discussion
POST/api/v2/discussions

URI Parameters
HideShow
page_id
number (required) Example: 1

page id

PATCH /api/v2/discussions/1
Requestsupdates discussionreturns error

PATCH  /api/v2/discussions/8

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
Body
{
  "data": {
    "type": "discussions",
    "attributes": {},
    "relationships": {
      "page": {
        "data": {
          "type": "pages",
          "id": "7"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "8",
    "type": "discussions",
    "attributes": {
      "excerpt": null,
      "resolved_at": null,
      "subscriber_ids": []
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "436"
        }
      },
      "page": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Update an discussion
PATCH/api/v2/discussions/{id}

URI Parameters
HideShow
id
number (required) Example: 1

discussion id

DELETE /api/v2/discussions/1
Requestsdestroys discussion

DELETE  /api/v2/discussions/10

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
Responses204
This response has no content.

Deletes a discussion
DELETE/api/v2/discussions/{id}

URI Parameters
HideShow
id
number (required) Example: 1

discussion id

PATCH /api/v2/discussions/1/reopen
Requestsreopens discussion

PATCH  /api/v2/discussions/11/reopen

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "11",
    "type": "discussions",
    "attributes": {
      "excerpt": null,
      "resolved_at": null,
      "subscriber_ids": []
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "439"
        }
      },
      "page": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Reopens a discussion
PATCH/api/v2/discussions/{id}/reopen

URI Parameters
HideShow
id
number (required) Example: 1

discussion id

PATCH /api/v2/discussions/1/resolve
Requestsresolves discussion

PATCH  /api/v2/discussions/12/resolve

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "12",
    "type": "discussions",
    "attributes": {
      "excerpt": null,
      "resolved_at": "2025-07-13T06:04:51.000+02:00",
      "subscriber_ids": []
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "440"
        }
      },
      "page": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Resolves a discussion
PATCH/api/v2/discussions/{id}/resolve

URI Parameters
HideShow
id
number (required) Example: 1

discussion id

PATCH /api/v2/discussions/1/subscribe
Requestssubscribes to discussion

PATCH  /api/v2/discussions/13/subscribe

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "13",
    "type": "discussions",
    "attributes": {
      "excerpt": null,
      "resolved_at": null,
      "subscriber_ids": [
        1647
      ]
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "441"
        }
      },
      "page": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Subscribes to discussion
PATCH/api/v2/discussions/{id}/subscribe

URI Parameters
HideShow
id
number (required) Example: 1

discussion id

PATCH /api/v2/discussions/1/unsubscribe
Requestsunsubscribes from discussion

PATCH  /api/v2/discussions/14/unsubscribe

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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "14",
    "type": "discussions",
    "attributes": {
      "excerpt": null,
      "resolved_at": null,
      "subscriber_ids": []
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "442"
        }
      },
      "page": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Unsubscribes from discussion
PATCH/api/v2/discussions/{id}/unsubscribe

URI Parameters
HideShow
id
number (required) Example: 1

discussion id

Generated by aglio on 13 Jul 2025