Skip to content

get_discussions

Endpoint#

PropertyValue
Typequery
MethodGET
Path/api/external/v1/get_discussions
HandlerOperatelyWeb.Api.Queries.GetDiscussions

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
space_idid primitive (encoded as string)NoYes-
include_authorbooleanNoYes-
include_comments_countbooleanNoYes-
include_my_draftsbooleanNoYes-

Outputs#

FieldTypeRequiredNullable
discussionsarray of discussion objectNoYes
my_draftsarray of discussion objectNoYes

cURL Example#

Copied
curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_discussions?include_author=true&include_comments_count=true&include_my_drafts=true&space_id=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "discussions": [
    {
      "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"
    }
  ],
  "my_drafts": [
    {
      "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"
    }
  ]
}