Skip to content
Updawg

`GET /v1/orgs/{org}/proposals/grouped?by=policy|group` (DAWG-303).

GET
/v1/orgs/{org}/proposals/grouped
curl --request GET \
  --url 'https://api.updawg.net/v1/orgs/example/proposals/grouped?by=example'

The sections of a grouped inbox and how many proposals each holds, under the same ?status= as the list. Each section opens with the list’s ?policy= or ?group= — none for the section without one — so a section pages like the inbox does rather than arriving whole.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

Query Parameters

Section titled “Query Parameters”
by
required
string

policy or group.

status
Array<string>

Repeatable, as on the list. Omitted means every status.

Responses

Section titled “Responses”

200

Section titled “200”

Biggest section first; the one for proposals with no policy or group last.

Media typeapplication/json
object
by
required

policy or group, as asked.

string
overlapping
required

⚠️ true when a proposal can be in more than one section, so the totals add up to more than the inbox holds: by group, a proposal across hosts in two groups is in both.

boolean
sections
required
Array<object>

One section of a grouped inbox.

object
deleted
required

A policy deleted since it made these proposals.

boolean
id

pol_… or grp_…, to pass as the list’s ?policy= or ?group=. null is the section for proposals with neither: pass none.

string | null
name
string | null
total
required
integer format: int64

Example generated

{
  "by": "example",
  "overlapping": true,
  "sections": [
    {
      "deleted": true,
      "id": "example",
      "name": "example",
      "total": 1
    }
  ]
}

400

Section titled “400”

No by, an unknown one, an unknown status or parameter.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

401

Section titled “401”

No session.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

No such organization, or not yours.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

421

Section titled “421”

The organization’s data is in another region (wrong-region, DAWG-159). detail names that region’s API; send the request there.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Section titled “429”

Over the organization’s request limit. Retry-After says when to try again; RateLimit-Limit is the burst.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string

Example generated

{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}