Skip to content

get_discussion

Endpoint#

PropertyValue
Typequery
MethodGET
Path/api/external/v1/get_discussion
HandlerOperatelyWeb.Api.Queries.GetDiscussion

Authentication#

  • Requires a valid API token.
  • Read-only and full-access tokens can execute this query.

Inputs#

FieldTypeRequiredNullableDefault
idstringYesNo-
include_authorbooleanNoYes-
include_reactionsbooleanNoYes-
include_spacebooleanNoYes-
include_space_membersbooleanNoYes-
include_subscriptions_listbooleanNoYes-
include_potential_subscribersbooleanNoYes-
include_unread_notificationsbooleanNoYes-
include_permissionsbooleanNoYes-

Outputs#

FieldTypeRequiredNullable
discussiondiscussion objectYesNo

cURL Example#

Copied
curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_discussion?id=value&include_author=true&include_permissions=true&include_potential_subscribers=true&include_reactions=true&include_space=true&include_space_members=true&include_subscriptions_list=true&include_unread_notifications=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "discussion": {
    "author": "<person>",
    "body": "value",
    "comments": [
      "<comment>"
    ],
    "comments_count": 123,
    "id": "value",
    "inserted_at": "2026-01-01",
    "name": "value",
    "notifications": [
      "<notification>"
    ],
    "permissions": "<space_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "published_at": "2026-01-01",
    "reactions": [
      "<reaction>"
    ],
    "space": "<space>",
    "state": "value",
    "subscription_list": "<subscription_list>",
    "title": "value",
    "updated_at": "2026-01-01"
  }
}