MumbleAPI

API for the Mumble.dev

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

articles

list

GET /api/articles/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action articles list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["articles", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["articles", "list"]
result = client.action(schema, action)

read

GET /api/articles/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action articles read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["articles", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["articles", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

create > create

POST /api/articles/create/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action articles create create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["articles", "create > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["articles", "create > create"]
result = client.action(schema, action)

delete > delete

DELETE /api/articles/delete/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action articles delete delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["articles", "delete > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["articles", "delete > delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

delete-comment > delete

DELETE /api/articles/delete-comment/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action articles delete-comment delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["articles", "delete-comment > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["articles", "delete-comment > delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

edit > update

PUT /api/articles/edit/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action articles edit update -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["articles", "edit > update"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["articles", "edit > update"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

edit-comment > update

PUT /api/articles/edit-comment/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action articles edit-comment update -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["articles", "edit-comment > update"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["articles", "edit-comment > update"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

vote > create

POST /api/articles/vote/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action articles vote create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["articles", "vote > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["articles", "vote > create"]
result = client.action(schema, action)

discussions

list

GET /api/discussions/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action discussions list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["discussions", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["discussions", "list"]
result = client.action(schema, action)

read

GET /api/discussions/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action discussions read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["discussions", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["discussions", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

create > create

POST /api/discussions/create/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action discussions create create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["discussions", "create > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["discussions", "create > create"]
result = client.action(schema, action)

delete > delete

DELETE /api/discussions/delete/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action discussions delete delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["discussions", "delete > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["discussions", "delete > delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

delete-comment > delete

DELETE /api/discussions/delete-comment/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action discussions delete-comment delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["discussions", "delete-comment > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["discussions", "delete-comment > delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

edit > update

PUT /api/discussions/edit/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action discussions edit update -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["discussions", "edit > update"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["discussions", "edit > update"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

edit-comment > update

PUT /api/discussions/edit-comment/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action discussions edit-comment update -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["discussions", "edit-comment > update"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["discussions", "edit-comment > update"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

vote > create

POST /api/discussions/vote/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action discussions vote create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["discussions", "vote > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["discussions", "vote > create"]
result = client.action(schema, action)

messages

list

GET /api/messages/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action messages list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["messages", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["messages", "list"]
result = client.action(schema, action)

create > create

POST /api/messages/create/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action messages create create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["messages", "create > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["messages", "create > create"]
result = client.action(schema, action)

create-thread > create

POST /api/messages/create-thread/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action messages create-thread create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["messages", "create-thread > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["messages", "create-thread > create"]
result = client.action(schema, action)

read > list

GET /api/messages/{id}/read/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action messages read list -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["messages", "read > list"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["messages", "read > list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

mumbles

list

GET /api/mumbles/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action mumbles list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["mumbles", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["mumbles", "list"]
result = client.action(schema, action)

comments > list

GET /api/mumbles/{id}/comments/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action mumbles comments list -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["mumbles", "comments > list"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["mumbles", "comments > list"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

create > create

POST /api/mumbles/create/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action mumbles create create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["mumbles", "create > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["mumbles", "create > create"]
result = client.action(schema, action)

delete > delete

DELETE /api/mumbles/delete/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action mumbles delete delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["mumbles", "delete > delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["mumbles", "delete > delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

details > read

GET /api/mumbles/details/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action mumbles details read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["mumbles", "details > read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["mumbles", "details > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

edit > partial_update

PATCH /api/mumbles/edit/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action mumbles edit partial_update -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["mumbles", "edit > partial_update"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["mumbles", "edit > partial_update"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

remumble > create

POST /api/mumbles/remumble/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action mumbles remumble create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["mumbles", "remumble > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["mumbles", "remumble > create"]
result = client.action(schema, action)

vote > create

POST /api/mumbles/vote/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action mumbles vote create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["mumbles", "vote > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["mumbles", "vote > create"]
result = client.action(schema, action)

notifications

list

GET /api/notifications/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action notifications list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["notifications", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["notifications", "list"]
result = client.action(schema, action)

read > update

PUT /api/notifications/{id}/read/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action notifications read update -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["notifications", "read > update"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["notifications", "read > update"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

users

list

GET /api/users/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "list"]
result = client.action(schema, action)

read

GET /api/users/{username}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users read -p username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "read"]
var params = {
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "read"]
params = {
    "username": ...,
}
result = client.action(schema, action, params=params)

articles > list

GET /api/users/{username}/articles/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users articles list -p username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "articles > list"]
var params = {
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "articles > list"]
params = {
    "username": ...,
}
result = client.action(schema, action, params=params)

delete-profile > create

POST /api/users/delete-profile/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users delete-profile create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "delete-profile > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "delete-profile > create"]
result = client.action(schema, action)

email > send-email-activation > create

POST /api/users/email/send-email-activation

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users email send-email-activation create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "email > send-email-activation > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "email > send-email-activation > create"]
result = client.action(schema, action)

follow > create

POST /api/users/{username}/follow/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users follow create -p username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "follow > create"]
var params = {
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "follow > create"]
params = {
    "username": ...,
}
result = client.action(schema, action, params=params)

following > list

GET /api/users/following/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users following list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "following > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "following > list"]
result = client.action(schema, action)

POST /api/users/login/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required
`password` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users login create -p username=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "login > create"]
var params = {
    username: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "login > create"]
params = {
    "username": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

mumbles > list

GET /api/users/{username}/mumbles/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users mumbles list -p username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "mumbles > list"]
var params = {
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "mumbles > list"]
params = {
    "username": ...,
}
result = client.action(schema, action, params=params)

password > change > create

POST /api/users/password/change/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users password change create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "password > change > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "password > change > create"]
result = client.action(schema, action)

profile > list

GET /api/users/profile/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users profile list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "profile > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "profile > list"]
result = client.action(schema, action)

profile_update > partial_update

PATCH /api/users/profile_update/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users profile_update partial_update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "profile_update > partial_update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "profile_update > partial_update"]
result = client.action(schema, action)

profile_update > delete > delete

DELETE /api/users/profile_update/delete/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users profile_update delete delete

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "profile_update > delete > delete"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "profile_update > delete > delete"]
result = client.action(schema, action)

profile_update > interests > partial_update

PATCH /api/users/profile_update/interests/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users profile_update interests partial_update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "profile_update > interests > partial_update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "profile_update > interests > partial_update"]
result = client.action(schema, action)

profile_update > photo > partial_update

PATCH /api/users/profile_update/photo/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users profile_update photo partial_update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "profile_update > photo > partial_update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "profile_update > photo > partial_update"]
result = client.action(schema, action)

profile_update > skills > partial_update

PATCH /api/users/profile_update/skills/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users profile_update skills partial_update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "profile_update > skills > partial_update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "profile_update > skills > partial_update"]
result = client.action(schema, action)

recommended > list

GET /api/users/recommended/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users recommended list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "recommended > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "recommended > list"]
result = client.action(schema, action)

refresh_token > create

POST /api/users/refresh_token/

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`refresh` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users refresh_token create -p refresh=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "refresh_token > create"]
var params = {
    refresh: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "refresh_token > create"]
params = {
    "refresh": ...,
}
result = client.action(schema, action, params=params)

register > create

POST /api/users/register/

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users register create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "register > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "register > create"]
result = client.action(schema, action)

skills > read

GET /api/users/skills/{skill}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`skill` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users skills read -p skill=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "skills > read"]
var params = {
    skill: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "skills > read"]
params = {
    "skill": ...,
}
result = client.action(schema, action, params=params)

verify > read

GET /api/users/verify/{uidb64}/{token}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`uidb64` required
`token` required

# Load the schema document
$ coreapi get https://mumbleapi.herokuapp.com/

# Interact with the API endpoint
$ coreapi action users verify read -p uidb64=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "verify > read"]
var params = {
    uidb64: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://mumbleapi.herokuapp.com/")

# Interact with the API endpoint
action = ["users", "verify > read"]
params = {
    "uidb64": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)