Skip to main content

API V1 (v0.1)

Download OpenAPI specification:Download

A RestFull API for Decidim, to be able to CRUD resources from Decidim.

Authentication

Get a token from our /oauth/token routes, following OAuth specs on Credential Flows or Resource Owner Password Credentials Flow.

Permissions

A permission system is attached to the created OAuth application, that is designed in two levels:

  • scope: a broad permission to access a collection of endpoints
  • abilities: a fine grained permission system that allow actions.

The scopes and abilities are manageable in your System Admin Panel.

Multi-tenant

Decidim is multi-tenant, and this API supports it.

  • The system scope endpoints are available in any tenant
  • The tenant host attribute will be used to guess which tenant you are requesting. For example, given a tenant example.org and foobar.org, the endpoint
    • example.org/oauth/token will ask a token for the example.org organization
    • foobar.org/oauth/token for foobar.org.

OAuth

Use OAuth to get tokens and interact with the API. You can use machine-to-machine tokens, or user token directly with the API.

  • Machine-to-machine: Client Credential Flow
  • User: Resource Owner Password Credential Flow, with impersonation or login

Introspect a OAuth token

Get given oauth token details

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
Request Body schema: application/json
required
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
Example
{
  • "active": true,
  • "scope": "public",
  • "client_id": "VXCSzD4fH7Ey8XPbzuy1FG84KeAbyrQVF3yYuHlDfpc",
  • "token_type": "Bearer",
  • "exp": 3480272416,
  • "iat": 1738926608,
  • "sub": 44035,
}

Request a OAuth token through Client Credentials

Create a oauth token for the given scopes

Request Body schema: application/json
required
One of
grant_type
required
string
Value: "client_credentials"

Client Credential Flow, for machine-to-machine

client_id
required
string

OAuth application Client Id

client_secret
required
string

OAuth application Client Secret

scope
required
string
Enum: "public" "spaces" "system" "proposals" "meetings" "debates" "pages" "blogs" "oauth"

Requested scopes

Responses

Request samples

Content type
application/json
Example
{
  • "grant_type": "client_credentials",
  • "client_id": "string",
  • "client_secret": "string",
  • "scope": "public"
}

Response samples

Content type
application/json
Example
{
  • "access_token": "goDhzdEfHvF6zXoeeR6S96hWMfaxi_430_UuS3Tz92o",
  • "token_type": "Bearer",
  • "expires_in": 7200,
  • "scope": "public",
  • "created_at": 1738926612
}

Spaces

Search and vizualize spaces (eg. Assemblies, Participatory Processes)

Search Participatory Spaces

List or search spaces of the organization. Can be processes, assemblies, or any other registred participatory space.

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"
filter[manifest_name_not_in][]
Array of strings (manifest_name not IN filter)
Items Enum: "participatory_processes" "assemblies"

match none of manifest_name's values in array

filter[manifest_name_in][]
Array of strings (manifest_name IN filter)
Items Enum: "participatory_processes" "assemblies"

match one of manifest_name's values in array

filter[manifest_name_eq]
string (manifest_name equal filter)
Enum: "participatory_processes" "assemblies"

manifest_name is equal to

filter[manifest_name_not_eq]
string (manifest_name not equal filter)
Enum: "participatory_processes" "assemblies"

manifest_name is NOT equal to

filter[title_not_in][]
Array of strings (title not IN filter)

match none of title's values in array

filter[title_in][]
Array of strings (title IN filter)

match one of title's values in array

filter[title_start]
string (title starts With filter)
Example: filter[title_start]=some_string

title starts with

filter[title_not_start]
string (title not starts With filter)
Example: filter[title_not_start]=some_string

title does not starts with

filter[title_eq]
string (title equal filter)

title is equal to

filter[title_not_eq]
string (title not equal filter)

title is NOT equal to

filter[title_matches]
string (title like filter)
Example: filter[title_matches]=%some_string

matches title with LIKE

filter[title_does_not_match]
string (title not like filter)

Does not matches title with LIKE

filter[title_present]
boolean (title present filter)

title is not null and not empty

filter[title_blank]
boolean (title blank filter)

title is null or empty

page
integer

Page number for pagination

per_page
integer

Number of items per page

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Participatory Processes Details

Get detail of a Participatory Processes given its id

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
path Parameters
id
required
integer

Id of the space

query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Assemblies Details

Get detail of a Assemblies given its id

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
path Parameters
id
required
integer

Id of the space

query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Components

Search and vizualize components

Blog Components

List or search blog components of the organization

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"
filter[participatory_space_id_in][]
Array of strings (participatory_space_id IN filter)

match one of participatory_space_id's values in array

filter[participatory_space_id_eq]
string (participatory_space_id equal filter)

participatory_space_id is equal to

filter[participatory_space_type_in][]
Array of strings (participatory_space_type IN filter)
Example: filter[participatory_space_type_in][]=Decidim::Assembly

match one of participatory_space_type's values in array

filter[participatory_space_type_eq]
string (participatory_space_type equal filter)
Example: filter[participatory_space_type_eq]=Decidim::Assembly

participatory_space_type is equal to

filter[name_start]
string (name starts With filter)
Example: filter[name_start]=some_string

name starts with

filter[name_eq]
string (name equal filter)

name is equal to

filter[name_not_eq]
string (name not equal filter)

name is NOT equal to

filter[name_matches]
string (name like filter)
Example: filter[name_matches]=%some_string

matches name with LIKE

page
integer

Page number for pagination

per_page
integer

Number of items per page

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Blog Component Details

Blog component details

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
path Parameters
id
required
integer
query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Search components

List or search components of the organization

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"
filter[manifest_name_not_in][]
Array of strings (manifest_name not IN filter)
Items Enum: "pages" "proposals" "meetings" "budgets" "surveys" "accountability" "debates" "sortitions" "blogs" "awesome_map" "awesome_iframe"

match none of manifest_name's values in array

filter[manifest_name_in][]
Array of strings (manifest_name IN filter)
Items Enum: "pages" "proposals" "meetings" "budgets" "surveys" "accountability" "debates" "sortitions" "blogs" "awesome_map" "awesome_iframe"

match one of manifest_name's values in array

filter[manifest_name_eq]
string (Component Manifest)
Enum: "pages" "proposals" "meetings" "budgets" "surveys" "accountability" "debates" "sortitions" "blogs" "awesome_map" "awesome_iframe"
filter[manifest_name_not_eq]
string (Component Manifest)
Enum: "pages" "proposals" "meetings" "budgets" "surveys" "accountability" "debates" "sortitions" "blogs" "awesome_map" "awesome_iframe"
filter[id_not_in][]
Array of integers (id not IN filter)

match none of id's values in array

filter[id_in][]
Array of integers (id IN filter)

match one of id's values in array

filter[id_eq]
integer (id equal filter)

id is equal to

filter[id_not_eq]
integer (id not equal filter)

id is NOT equal to

filter[participatory_space_id_in][]
Array of strings (participatory_space_id IN filter)

match one of participatory_space_id's values in array

filter[participatory_space_id_eq]
string (participatory_space_id equal filter)

participatory_space_id is equal to

filter[participatory_space_type_in][]
Array of strings (participatory_space_type IN filter)
Items Enum: "participatory_processes" "assemblies"

match one of participatory_space_type's values in array

filter[participatory_space_type_eq]
string (space_type)
Enum: "participatory_processes" "assemblies"
filter[name_start]
string (name starts With filter)
Example: filter[name_start]=some_string

name starts with

filter[name_eq]
string (name equal filter)

name is equal to

filter[name_not_eq]
string (name not equal filter)

name is NOT equal to

filter[name_matches]
string (name like filter)
Example: filter[name_matches]=%some_string

matches name with LIKE

page
integer

Page number for pagination

per_page
integer

Number of items per page

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Proposal Components

List or search proposal components of the organization

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"
filter[participatory_space_id_in][]
Array of strings (participatory_space_id IN filter)

match one of participatory_space_id's values in array

filter[participatory_space_id_eq]
string (participatory_space_id equal filter)

participatory_space_id is equal to

filter[participatory_space_type_in][]
Array of strings (participatory_space_type IN filter)
Example: filter[participatory_space_type_in][]=Decidim::Assembly

match one of participatory_space_type's values in array

filter[participatory_space_type_eq]
string (participatory_space_type equal filter)
Example: filter[participatory_space_type_eq]=Decidim::Assembly

participatory_space_type is equal to

filter[name_start]
string (name starts With filter)
Example: filter[name_start]=some_string

name starts with

filter[name_eq]
string (name equal filter)

name is equal to

filter[name_not_eq]
string (name not equal filter)

name is NOT equal to

filter[name_matches]
string (name like filter)
Example: filter[name_matches]=%some_string

matches name with LIKE

page
integer

Page number for pagination

per_page
integer

Number of items per page

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Proposal Component Details

Find on proposal

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
path Parameters
id
required
integer
query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Users

Get information about participants, and manage own data.

Use a magic-lick

Challenge given token, open and a session and redirect. Publically accessible by HTTP.

path Parameters
magic_token
required
string

A token received for magic link

Responses

Response samples

Content type
application/json
{ }

Get user extended data

Fetch user extended data

Authorizations:
resourceOwnerFlowBearer
query Parameters
object_path
required
string

object path, in dot style, like foo.bar

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update user extended data

The extended_data feature allows you to update a hash with recursive merging. Use the body payload with these keys:

  1. data: The value or hash you want to update.
  2. object_path: The dot-style path to the key (e.g., access.this.key).

Root path
To update data from root of the hash, use object_path=".".

Example:

  body={"data": {"name": "Jane"}, "object_path": "personnal"}

This recursively merges data into the hash without removing existing keys.

Merge some data
Initial hash:

  {
    "personnal": {"birthday": "1989-05-18"}
  }

Patch payload:

  {
    "data": {
      "name": "Jane"
    },
    "object_path": "personnal"
  }

Result:

  {
    "personnal": {"birthday": "1989-05-18", "name": "Jane"}
  }

Create new Paths
Paths are created as needed. Exemple:

  body = {"data": {"external_user_id": 12}, "object_path": "data-store.my-app.foo"}

Result:

  {
    "personnal": {"birthday": "1989-05-18"},
    "data-store": {"my-app": {"foo": {"external_user_id": 12}}}
  }

Alternatively:

  body = {"data": 12, "object_path": "data-store.my-app.foo.external_user_id"}

Remove a key
Set a key to null or an empty value to remove it.

Example: Initial hash:

  {
    "personnal": {"birthday": "1989-05-18", "name": "Jane"}
  }

Patch:

  body = {"data": {"birthday": ""}, "object_path": "personnal"}

Result:

{
  "personnal": {"name": "Jane"}
}

Return Value
The update request returns the updated value at the specified path.

Authorizations:
resourceOwnerFlowBearer
Request Body schema: application/json
required
data
required
object

New value for the extended data at the given path

object_path
string

object path, in dot style, like foo.bar. use '.' to update the whole user data

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "object_path": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

List available Users

List or search users of the organization

Authorizations:
credentialFlowBearer
query Parameters
page
integer

Page number for pagination

per_page
integer

Number of items per page

filter[nickname_not_in][]
Array of strings (nickname not IN filter)

match none of nickname's values in array

filter[nickname_in][]
Array of strings (nickname IN filter)

match one of nickname's values in array

filter[nickname_start]
string (nickname starts With filter)
Example: filter[nickname_start]=some_string

nickname starts with

filter[nickname_not_start]
string (nickname not starts With filter)
Example: filter[nickname_not_start]=some_string

nickname does not starts with

filter[nickname_eq]
string (nickname equal filter)

nickname is equal to

filter[nickname_not_eq]
string (nickname not equal filter)

nickname is NOT equal to

filter[nickname_matches]
string (nickname like filter)
Example: filter[nickname_matches]=%some_string

matches nickname with LIKE

filter[nickname_does_not_match]
string (nickname not like filter)

Does not matches nickname with LIKE

filter[nickname_present]
boolean (nickname present filter)

nickname is not null and not empty

filter[nickname_blank]
boolean (nickname blank filter)

nickname is null or empty

filter[extended_data_cont]
string
Example: filter[extended_data_cont]="foo": "bar"

Search on user extended_data. use the format: "<key>":<space>"<value>"

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Blogs

Get informations about blog posts

Blog Post Lists

Get blog post list

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"
space_manifest
string
Enum: "participatory_processes" "assemblies"

Space type

space_id
integer

Space Id

component_id
integer

Component Id

page
integer

Page number for pagination

per_page
integer

Number of items per page

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Show a blog detail

Get blog post details

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
path Parameters
id
required
integer

Blog Post Id

query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Proposals

Manipulate proposals and drafts

Proposals

Search proposals

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"
page
integer

Page number for pagination

per_page
integer

Number of items per page

order
string
Enum: "published_at" "rand"

field to order by

order_direction
string
Enum: "desc" "asc"

order direction

space_manifest
string
Enum: "participatory_processes" "assemblies"

Space type

space_id
integer

Space Id

component_id
integer

Component Id

filter[voted_weight_in][]
Array of strings (voted_weight IN filter)

match one of voted_weight's values in array

filter[voted_weight_eq]
string (voted_weight equal filter)

voted_weight is equal to

filter[voted_weight_blank]
boolean (voted_weight blank filter)

voted_weight is null or empty

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Proposal Details

Proposal detail

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
path Parameters
id
required
integer

Proposal Id

query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"
space_manifest
string
Enum: "participatory_processes" "assemblies"

Space type

space_id
integer

Space Id

component_id
integer

Component Id

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Draft Proposals

Create draft proposal

Create a draft

Authorizations:
resourceOwnerFlowBearer
Request Body schema: application/json
required
required
object

Payload to update in the proposal

component_id
required
integer

Component ID

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Withdrawn a draft proposal

Withdrawn a draft proposal. This action cannot be undone.

Authorizations:
resourceOwnerFlowBearer
path Parameters
id
required
integer

Draft Id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Display a draft proposal

Detail a draft proposal. Raise HTTP 404 error if no draft is created for now.

Authorizations:
resourceOwnerFlowBearer
path Parameters
id
required
integer

Draft Id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update draft proposal

This endpoint allows you to update a draft proposal associated with your application ID. Drafts updated via this API are not visible in the Decidim front-end, and drafts created from the Decidim application are not editable through the API. Therefore, any draft you create here is new and tied to your application's credentials.

Example Request

PUT /public/assemblies/12/2319/proposals/draft
Content-Type: application/json
Authorization: Bearer YOUR_IMPERSONATION_TOKEN

{
  "title": "My valid title"
}

Access Requirements

  • Authentication: This endpoint requires an impersonation token. You must create drafts on behalf of a participant; drafts cannot be created using a service token (credential_token).

Error Handling

  • Field Errors: Only errors related to the fields you're updating will be returned.
  • Publishable Status: To determine if the draft is publishable, check the data.meta.publishable field in the response.

Example response

{
  "data": {
    "id": "12345",
    "type": "proposal",
    "attributes": {
      "title": "My valid title",
      "body": null
    },
    "meta": {
      "publishable": false
    }
  }
}

In this example, the title is valid, so the server returns a 200 OK status. However, since the body is blank, meta.publishable is false, indicating that the draft is not yet ready for publication.

Authorizations:
resourceOwnerFlowBearer
path Parameters
id
required
integer

Draft Id

Request Body schema: application/json
required
required
object

Payload to update in the proposal

title
string

Title of the draft

body
string

Content of the draft

locale
string
Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"

Locale of the draft. default to user locale

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Publish a draft proposal

Publish a draft proposal

Authorizations:
resourceOwnerFlowBearer
path Parameters
id
required
integer

Draft Id

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

System

List available organizations

List available organizations

Authorizations:
credentialFlowBearer
query Parameters
locales[]
Array of strings (Locales enumeration)
Items Enum: "en" "bg" "ar" "ca" "cs" "da" "de" "el" "eo" "es" "es-MX" "es-PY" "et" "eu" "fa" "fi-pl" "fi" "fr" "fr-CA" "ga" "gl" "hr" "hu" "id" "is" "it" "ja" "ko" "lb" "lt" "lv" "mt" "nl" "no" "pl" "pt" "pt-BR" "ro" "ru" "sk" "sl" "sr" "sv" "tr" "uk" "vi" "zh-CN" "zh-TW"
page
integer

Page number for pagination

per_page
integer

Number of items per page

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

Proposals Vote

Vote

Vote on a proposal

Authorizations:
credentialFlowBearerresourceOwnerFlowBearer
Request Body schema: application/json
required
proposal_id
required
integer

Proposal Id

required
object

Payload to send your vote

Responses

Request samples

Content type
application/json
{
  • "proposal_id": 0,
  • "data": {
    }
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}