API V1 (v0.3)

Check token validity and get optional user/resource (RFC 7662). Send the token to introspect in the request body; use a valid Bearer token in Authorization.

Create an OAuth token for the given scopes (password or client_credentials grant).

List available organizations

This endpoint allows you to update an organization.

Update host

To update the host, send in your payload the host attribute. It will be saved as an unconfirmed_host extended data attribute. Once saved, a job will be enqueued to reverse DNS the unconfirmed host before actually updating the host. The host attribute must be unique across all organizations. More information on this update process is documented in the Safe host update page.

Update name

To update the name, send in your payload the name attribute. The name attribute must be unique across all organizations.

Show organization

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.

Fetch organization extended data

List participatory spaces of type Initiatives for the current organization. Supports the same filter query parameters as /spaces/search, scoped to this space type.

List participatory spaces of type Conferences for the current organization. Supports the same filter query parameters as /spaces/search, scoped to this space type.

List participatory spaces of type Participatory Processes for the current organization. Supports the same filter query parameters as /spaces/search, scoped to this space type.

List participatory spaces of type Assemblies for the current organization. Supports the same filter query parameters as /spaces/search, scoped to this space type.

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