Skip to main content

Podlove Publisher API (2)

analytics

Get download numbers per episode for all episodes.

Get download numbers per episode for all episodes.

query Parameters
format
string

Responses

Response samples

Content type
[]

Get download numbers for an episode.

Get download numbers for an episode.

path Parameters
id
required
integer <int64>
query Parameters
format
string

Responses

Response samples

Content type
{}

podcast

Get the information about the podcast

Get the information about the podcast

Responses

Response samples

Content type
application/json
{
  • "version": "v2",
  • "title": "Podlovers",
  • "subtitle": "Der Podlove Entwickler:innen Podcast",
  • "summary": "Podlove ist eine Initiative zur Verbesserung der Open Source Infrastruktur zum Podcasting. Podlove ist gleichzeitig auch ein Netzwerk an Entwickler:innen zur Diskussion von Features und Standardisierung.",
  • "mnemonic": "LOV",
  • "itunes_type": "episodic",
  • "author_name": "Podlove team",
  • "poster": null,
}

Update the information about the podcast

Update the information about the podcast

Request Body schema: application/json
_version
string
Value: "v2"
title
string
subtitle
string
summary
string
mnemonic
string
itunes_type
string
Enum: "episodic" "serial"
author_name
string
poster
string
link
string

Responses

Request samples

Content type
application/json
{
  • "version": "v2",
  • "title": "Podlovers",
  • "subtitle": "Der Podlove Entwickler:innen Podcast",
  • "summary": "Podlove ist eine Initiative zur Verbesserung der Open Source Infrastruktur zum Podcasting. Podlove ist gleichzeitig auch ein Netzwerk an Entwickler:innen zur Diskussion von Features und Standardisierung.",
  • "mnemonic": "LOV",
  • "itunes_type": "episodic",
  • "author_name": "Podlove team",
  • "poster": null,
}

Response samples

Content type
application/json
{
  • "code": 401,
  • "message": "sorry, you do not have permissions to use this REST API endpoint"
}

Update the information about the podcast

Update the information about the podcast

Request Body schema: application/json
_version
string
Value: "v2"
title
string
subtitle
string
summary
string
mnemonic
string
itunes_type
string
Enum: "episodic" "serial"
author_name
string
poster
string
link
string

Responses

Request samples

Content type
application/json
{
  • "version": "v2",
  • "title": "Podlovers",
  • "subtitle": "Der Podlove Entwickler:innen Podcast",
  • "summary": "Podlove ist eine Initiative zur Verbesserung der Open Source Infrastruktur zum Podcasting. Podlove ist gleichzeitig auch ein Netzwerk an Entwickler:innen zur Diskussion von Features und Standardisierung.",
  • "mnemonic": "LOV",
  • "itunes_type": "episodic",
  • "author_name": "Podlove team",
  • "poster": null,
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the information about the podcast

Update the information about the podcast

Request Body schema: application/json
_version
string
Value: "v2"
title
string
subtitle
string
summary
string
mnemonic
string
itunes_type
string
Enum: "episodic" "serial"
author_name
string
poster
string
link
string

Responses

Request samples

Content type
application/json
{
  • "version": "v2",
  • "title": "Podlovers",
  • "subtitle": "Der Podlove Entwickler:innen Podcast",
  • "summary": "Podlove ist eine Initiative zur Verbesserung der Open Source Infrastruktur zum Podcasting. Podlove ist gleichzeitig auch ein Netzwerk an Entwickler:innen zur Diskussion von Features und Standardisierung.",
  • "mnemonic": "LOV",
  • "itunes_type": "episodic",
  • "author_name": "Podlove team",
  • "poster": null,
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

episodes

A list of episodes

A list of episodes

query Parameters
filter
Array of strings
Items Enum: "publish" "draft"

The filter parameter is used to filter the collection of episodes

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "results": [
    ]
}

Create a new episode

Create a new episode

Responses

Response samples

Content type
application/json
{
  • "message": "Episode successfully created with id 10",
  • "location": null,
  • "id": 10
}

The information about an episode

The information about an episode

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 10,
  • "post_id": 80,
  • "title": "Title of the episode",
  • "subtitle": "Subtitle of the episode",
  • "summary": "Summary of the episode",
  • "number": 10,
  • "mnemonic": "LOV010",
  • "soundbite_start": "00:00:10",
  • "soundbite_duration": "00:00:59",
  • "soundbite_title": "A short soundbite from the episode",
  • "explizit": "no"
}

Update the information about an episode

Update the information about an episode

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
title
string

Clear, concise name for your episode.

subtitle
string

Single sentence describing the episode.

summary
string

A summary of the episode.

number
integer

An epsiode number.

slug
string
soundbite_start
string

Start value of podcast:soundbite tag

soundbite_duration
string

Duration value of podcast::soundbite tag

soundbite_title
string

Title for the podcast::soundbite tag

explizit
string
Enum: "yes" "no"

explicit content?

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 10,
  • "post_id": 80,
  • "title": "Title of the episode",
  • "subtitle": "Subtitle of the episode",
  • "summary": "Summary of the episode",
  • "number": 10,
  • "mnemonic": "LOV010",
  • "soundbite_start": "00:00:10",
  • "soundbite_duration": "00:00:59",
  • "soundbite_title": "A short soundbite from the episode",
  • "explizit": "no"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the information about an episode

Update the information about an episode

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
title
string

Clear, concise name for your episode.

subtitle
string

Single sentence describing the episode.

summary
string

A summary of the episode.

number
integer

An epsiode number.

slug
string
soundbite_start
string

Start value of podcast:soundbite tag

soundbite_duration
string

Duration value of podcast::soundbite tag

soundbite_title
string

Title for the podcast::soundbite tag

explizit
string
Enum: "yes" "no"

explicit content?

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 10,
  • "post_id": 80,
  • "title": "Title of the episode",
  • "subtitle": "Subtitle of the episode",
  • "summary": "Summary of the episode",
  • "number": 10,
  • "mnemonic": "LOV010",
  • "soundbite_start": "00:00:10",
  • "soundbite_duration": "00:00:59",
  • "soundbite_title": "A short soundbite from the episode",
  • "explizit": "no"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the information about an episode

Update the information about an episode

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
title
string

Clear, concise name for your episode.

subtitle
string

Single sentence describing the episode.

summary
string

A summary of the episode.

number
integer

An epsiode number.

slug
string
soundbite_start
string

Start value of podcast:soundbite tag

soundbite_duration
string

Duration value of podcast::soundbite tag

soundbite_title
string

Title for the podcast::soundbite tag

explizit
string
Enum: "yes" "no"

explicit content?

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 10,
  • "post_id": 80,
  • "title": "Title of the episode",
  • "subtitle": "Subtitle of the episode",
  • "summary": "Summary of the episode",
  • "number": 10,
  • "mnemonic": "LOV010",
  • "soundbite_start": "00:00:10",
  • "soundbite_duration": "00:00:59",
  • "soundbite_title": "A short soundbite from the episode",
  • "explizit": "no"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Move an episode to the wordpress trash

Move an episode to the wordpress trash

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

A list of contributors who contribute to the episo

A list of contributors who contribute to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "contributors": [
    ]
}

Add a contributor to the episode.

Add a contributor to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
contributor_id
integer

Identifier of the contributor.

role_id
integer

Id of the role for the contributor.

group_id
integer

Id of the group for the contributor.

comment
string

Comment to the contributor.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "contributor_id": 10,
  • "role_id": 1,
  • "group_id": 1,
  • "comment": "Host of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Add a contributor to the episode.

Add a contributor to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
contributor_id
integer

Identifier of the contributor.

role_id
integer

Id of the role for the contributor.

group_id
integer

Id of the group for the contributor.

comment
string

Comment to the contributor.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "contributor_id": 10,
  • "role_id": 1,
  • "group_id": 1,
  • "comment": "Host of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Add a contributor to the episode.

Add a contributor to the episode.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
contributor_id
integer

Identifier of the contributor.

role_id
integer

Id of the role for the contributor.

group_id
integer

Id of the group for the contributor.

comment
string

Comment to the contributor.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "contributor_id": 10,
  • "role_id": 1,
  • "group_id": 1,
  • "comment": "Host of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Remove a contributor from the contribution list of

Remove a contributor from the contribution list of an episode.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

chapters

The list of chapters to an episode

The list of chapters to an episode

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "chapters": [
    ]
}

Edit the chapters list to an epsiode, old chapter

Edit the chapters list to an epsiode, old chapter list will be deleted.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "chapters": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Edit the chapters list to an epsiode, old chapter

Edit the chapters list to an epsiode, old chapter list will be deleted.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "chapters": [
    ]
}

Response samples

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

Edit the chapters list to an epsiode, old chapter

Edit the chapters list to an epsiode, old chapter list will be deleted.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "chapters": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete the chapters list for an epsiode.

Delete the chapters list for an epsiode.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

transcripts

Returns the transcript of the episode.

Wihtout limit and offset, you get the whole transcript.

path Parameters
id
required
string

Unique identifier for the episode.

query Parameters
limit
string

How many entries should be delivered?

offset
string

From which entry should the data be delivered?

count
string

How many entries are there? Ignored limit and offset.

Responses

Response samples

Content type
application/json
{
  • "count": {
    },
  • "offset_limit": {
    },
  • "transcript": {
    }
}

Add a transcript to the episode.

The content part of the request have to use the vtt format and must be UTF-8 encoded.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
type
string
Value: "vtt"
content
string

Responses

Request samples

Content type
application/json
{
  • "type": "vtt",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "transcript": {
    }
}

Add a transcript to the episode.

The content part of the request have to use the vtt format and must be UTF-8 encoded.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
type
string
Value: "vtt"
content
string

Responses

Request samples

Content type
application/json
{
  • "type": "vtt",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "transcript": {
    }
}

Add a transcript to the episode.

The content part of the request have to use the vtt format and must be UTF-8 encoded.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
type
string
Value: "vtt"
content
string

Responses

Request samples

Content type
application/json
{
  • "type": "vtt",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "transcript": {
    }
}

Delete the transcript of an episode.

Delete the transcript of an episode.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

A list of the voices.

A list of the voices on the episode's transcript.

path Parameters
id
required
string

Unique identifier for the episode.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "voices": [
    ]
}

Update the list of the voices.

Update the list of the voices on the episode's transcript.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "voices": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the list of the voices.

Update the list of the voices on the episode's transcript.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "voices": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the list of the voices.

Update the list of the voices on the episode's transcript.

path Parameters
id
required
string

Unique identifier for the episode.

Request Body schema: application/json
_version
string
Value: "v2"
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "voices": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

A part of the transcription (called chaption).

A part of the transcription (called chaption).

path Parameters
id
required
string

Unique identifier for the part of the transcription (called chaption).

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 1082,
  • "episode": 20,
  • "start": "00:00:00.005",
  • "start_ms": 5,
  • "end": "00:00:12.648",
  • "end_ms": 12648,
  • "voice": "Michi",
  • "text": "Hallo und herzlich willkommen zur Folge zwanzig, Episode zwanzig. Ich sage erstmal hallo und dann sage ich kurz wer wir sind. Hallo Alex."
}

Edit a chaption of the transcript

Edit a chaption of the transcript

path Parameters
id
required
string

Unique identifier for the part of the transcription (called chaption).

Request Body schema: application/json
start
string

Timestamp begin of the chaption. (Format HH:MM:SS.sss)

end
string

Timestamp end of the chaption. (Format HH:MM:SS.sss)

text
string

Content

Responses

Request samples

Content type
application/json
{
  • "id": 1082,
  • "episode": 20,
  • "start": "00:00:00.005",
  • "end": "00:00:12.648",
  • "text": "Hallo und herzlich willkommen zur Folge zwanzig, Episode zwanzig. Ich sage erstmal hallo und dann sage ich kurz wer wir sind. Hallo Alex."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Edit a chaption of the transcript

Edit a chaption of the transcript

path Parameters
id
required
string

Unique identifier for the part of the transcription (called chaption).

Request Body schema: application/json
start
string

Timestamp begin of the chaption. (Format HH:MM:SS.sss)

end
string

Timestamp end of the chaption. (Format HH:MM:SS.sss)

text
string

Content

Responses

Request samples

Content type
application/json
{
  • "id": 1082,
  • "episode": 20,
  • "start": "00:00:00.005",
  • "end": "00:00:12.648",
  • "text": "Hallo und herzlich willkommen zur Folge zwanzig, Episode zwanzig. Ich sage erstmal hallo und dann sage ich kurz wer wir sind. Hallo Alex."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Edit a chaption of the transcript

Edit a chaption of the transcript

path Parameters
id
required
string

Unique identifier for the part of the transcription (called chaption).

Request Body schema: application/json
start
string

Timestamp begin of the chaption. (Format HH:MM:SS.sss)

end
string

Timestamp end of the chaption. (Format HH:MM:SS.sss)

text
string

Content

Responses

Request samples

Content type
application/json
{
  • "id": 1082,
  • "episode": 20,
  • "start": "00:00:00.005",
  • "end": "00:00:12.648",
  • "text": "Hallo und herzlich willkommen zur Folge zwanzig, Episode zwanzig. Ich sage erstmal hallo und dann sage ich kurz wer wir sind. Hallo Alex."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a chaption of the transcript

Delete a chaption of the transcript

path Parameters
id
required
string

Unique identifier for the part of the transcription (called chaption).

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

social

A list of supported social services.

A list of supported social services.

query Parameters
category
string
Enum: "social" "donation" "internal"

Select a category of social services

Responses

Response samples

Content type
application/json
[]

A list of social services from a contributor.

A list of social services from a contributor.

path Parameters
id
required
string

contributor id

query Parameters
category
string

category: social, donation, internal

Responses

Response samples

Content type
application/json
[]

shownotes

A list of shownotes for an episode.

A list of shownotes for an episode.

query Parameters
episode_id
required
string

Limit result set by episode.

Responses

Response samples

Content type
application/json
[]

Add a shownotes item for an episode.

Add a shownotes item for an episode.

query Parameters
episode_id
required
string

Limit result set by episode.

type
required
string
Enum: "topic" "link"

Type of the created shownotes

title
required
string

Title of the created shownotes.

Request Body schema: application/json
original_url
string
title
string
url
string
description
string
position
integer
hidden
string
Enum: "yes" "no"

Responses

Request samples

Content type
application/json
{
  • "original_url": "string",
  • "title": "string",
  • "url": "string",
  • "description": "string",
  • "position": 0,
  • "hidden": "yes"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "episode_id": 2,
  • "type": "topic",
  • "state": null,
  • "position": -2,
  • "unfurl_data": null,
  • "original_url": null,
  • "affiliate_url": null,
  • "url": null,
  • "title": "Dieser Text gehört zu den Shownotes",
  • "description": null,
  • "site_name": null,
  • "site_url": null,
  • "icon": null,
  • "image": null,
  • "created_at": null,
  • "hidden": null
}

A shownote item for an episode.

A shownote item for an episode.

path Parameters
id
required
string

Unique identifier for the object.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "episode_id": 2,
  • "type": "topic",
  • "state": null,
  • "position": -2,
  • "unfurl_data": null,
  • "original_url": null,
  • "affiliate_url": null,
  • "url": null,
  • "title": "Dieser Text gehört zu den Shownotes",
  • "description": null,
  • "site_name": null,
  • "site_url": null,
  • "icon": null,
  • "image": null,
  • "created_at": null,
  • "hidden": null
}

Update a shownotes item for an episode.

Update a shownotes item for an episode.

path Parameters
id
required
string

Unique identifier for the object.

Request Body schema: application/json
original_url
string
title
string
url
string
description
string
position
integer
hidden
string
Enum: "yes" "no"

Responses

Request samples

Content type
application/json
{
  • "original_url": "string",
  • "title": "string",
  • "url": "string",
  • "description": "string",
  • "position": 0,
  • "hidden": "yes"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update a shownotes item for an episode.

Update a shownotes item for an episode.

path Parameters
id
required
string

Unique identifier for the object.

Request Body schema: application/json
original_url
string
title
string
url
string
description
string
position
integer
hidden
string
Enum: "yes" "no"

Responses

Request samples

Content type
application/json
{
  • "original_url": "string",
  • "title": "string",
  • "url": "string",
  • "description": "string",
  • "position": 0,
  • "hidden": "yes"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update a shownotes item for an episode.

Update a shownotes item for an episode.

path Parameters
id
required
string

Unique identifier for the object.

Request Body schema: application/json
original_url
string
title
string
url
string
description
string
position
integer
hidden
string
Enum: "yes" "no"

Responses

Request samples

Content type
application/json
{
  • "original_url": "string",
  • "title": "string",
  • "url": "string",
  • "description": "string",
  • "position": 0,
  • "hidden": "yes"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a shownotes item for an episode.

Delete a shownotes item for an episode.

path Parameters
id
required
string

Unique identifier for the object.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Extract URL metadata

Uses the backend at https://plus.podlove.org/api/unfurl with the original_url of the entry to automatically set title, description, site name, site url, image and icon.

path Parameters
id
required
string

Unique identifier for the object.

Responses

Import from OSF plugin

Generates shownotes entries from the "OSF" plugin.

Responses

Import from HTML

The HTML used is either the provided html parameter or the_content of the WordPress post.

Every link (a tag) encountered creates a shownotes entry of type link with the original_url set to its href attribute and the title set to the a content.

Every section heading (h1h6 tag) encountered creates a shownotes entry of type topic with the title set to the heading content.

query Parameters
html
string

html string. If not supplied, the content of the post is used.

Responses

contributors

A list of contributors of the podcast

If you are not authentificate, you will get only the visible contributors. The all filter will be ignored.

query Parameters
filter
Array of strings
Items Enum: "all" "visible"

The filter parameter is used to filter the collection of contributors.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "contributors": []
}

Add a contributor to the podcast.

Add a contributor to the podcast.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "id": 2
}

A contributor of the podcast

If you are not authentificate, you will get only the information, if the contributor visible.

path Parameters
id
required
string

Unique identifier for contributor.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "contributors": []
}

Update the information about a contributor.

Update the information about a contributor.

path Parameters
id
required
string

Unique identifier for contributor.

Request Body schema: application/json
visibility
string
Enum: "yes" "no"

Should the participation of the contributor be publicilyh visible?

identifier
string

The identifier will be used as in internal identifier for e.g. shortcodes.

avatar
string

Either a Gravatar email adress or a URL.

realname
string

Name of contributor.

publicname
string

The publicname will be used for public mentions.

nickname
string

Nickname of the contributor.

mail
string

Mail address

department
string

Department of the contributor.

organisation
string

Organisation of the contributor.

jobtitle
string

Jobtitle of the contributor.

gender
string
Enum: "male" "female" "Not attributed"

Gender of the contributor.

email
string

e-mail of the contributor Do not use external.

Responses

Request samples

Content type
application/json
{
  • "identifier": "Dirk_Developer",
  • "realname": "Dirk Schumann",
  • "publicname": "Dirk",
  • "nickname": "Schumi",
  • "mail": null,
  • "department": "Entwicklung",
  • "organisation": "Podlove",
  • "jobtitle": "Entwickler",
  • "gender": "male",
  • "email": "dirk@podlove.local"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the information about a contributor.

Update the information about a contributor.

path Parameters
id
required
string

Unique identifier for contributor.

Request Body schema: application/json
visibility
string
Enum: "yes" "no"

Should the participation of the contributor be publicilyh visible?

identifier
string

The identifier will be used as in internal identifier for e.g. shortcodes.

avatar
string

Either a Gravatar email adress or a URL.

realname
string

Name of contributor.

publicname
string

The publicname will be used for public mentions.

nickname
string

Nickname of the contributor.

mail
string

Mail address

department
string

Department of the contributor.

organisation
string

Organisation of the contributor.

jobtitle
string

Jobtitle of the contributor.

gender
string
Enum: "male" "female" "Not attributed"

Gender of the contributor.

email
string

e-mail of the contributor Do not use external.

Responses

Request samples

Content type
application/json
{
  • "identifier": "Dirk_Developer",
  • "realname": "Dirk Schumann",
  • "publicname": "Dirk",
  • "nickname": "Schumi",
  • "mail": null,
  • "department": "Entwicklung",
  • "organisation": "Podlove",
  • "jobtitle": "Entwickler",
  • "gender": "male",
  • "email": "dirk@podlove.local"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the information about a contributor.

Update the information about a contributor.

path Parameters
id
required
string

Unique identifier for contributor.

Request Body schema: application/json
visibility
string
Enum: "yes" "no"

Should the participation of the contributor be publicilyh visible?

identifier
string

The identifier will be used as in internal identifier for e.g. shortcodes.

avatar
string

Either a Gravatar email adress or a URL.

realname
string

Name of contributor.

publicname
string

The publicname will be used for public mentions.

nickname
string

Nickname of the contributor.

mail
string

Mail address

department
string

Department of the contributor.

organisation
string

Organisation of the contributor.

jobtitle
string

Jobtitle of the contributor.

gender
string
Enum: "male" "female" "Not attributed"

Gender of the contributor.

email
string

e-mail of the contributor Do not use external.

Responses

Request samples

Content type
application/json
{
  • "identifier": "Dirk_Developer",
  • "realname": "Dirk Schumann",
  • "publicname": "Dirk",
  • "nickname": "Schumi",
  • "mail": null,
  • "department": "Entwicklung",
  • "organisation": "Podlove",
  • "jobtitle": "Entwickler",
  • "gender": "male",
  • "email": "dirk@podlove.local"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete the information about a contributor.

Delete the information about a contributor.

path Parameters
id
required
string

Unique identifier for contributor.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

A list of groups to divide contributors by type of

A list of groups to divide contributors by type of participation.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "groups": [
    ]
}

Create a group of contributors.

Create a group of contributors.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Get the information about a group of contributors.

Get the information about a group of contributors.

path Parameters
id
required
string

Unique identifier for contributor group.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "id": 2
}

Update the group of contributor informations.

Update the group of contributor informations.

path Parameters
id
required
string

Unique identifier for contributor group.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor group.

slug
string

Slug of the contributor group.

title
string

Title of the contributor group.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 2,
  • "slug": "production",
  • "title": "The group who are responsible for the production"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the group of contributor informations.

Update the group of contributor informations.

path Parameters
id
required
string

Unique identifier for contributor group.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor group.

slug
string

Slug of the contributor group.

title
string

Title of the contributor group.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 2,
  • "slug": "production",
  • "title": "The group who are responsible for the production"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the group of contributor informations.

Update the group of contributor informations.

path Parameters
id
required
string

Unique identifier for contributor group.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor group.

slug
string

Slug of the contributor group.

title
string

Title of the contributor group.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 2,
  • "slug": "production",
  • "title": "The group who are responsible for the production"
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a contributor group.

Delete a contributor group.

path Parameters
id
required
string

Unique identifier for contributor group.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

A list of roles for contributors.

Use roles to assign a certain type of activity to a single contributor independent of any assigned group.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "roles": [
    ]
}

Create a role for contributors.

Create a role for contributors.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Get the information about a role for contributors.

Get the information about a role for contributors.

path Parameters
id
required
string

Unique identifier for contributor role.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "id": 2
}

Update the role for contributor informations.

Update the role for contributor informations.

path Parameters
id
required
string

Unique identifier for contributor role.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor role.

slug
string

Slug of the contributor role.

title
string

Title of the contributor role.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 1,
  • "slug": "moderator",
  • "title": "The moderator of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the role for contributor informations.

Update the role for contributor informations.

path Parameters
id
required
string

Unique identifier for contributor role.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor role.

slug
string

Slug of the contributor role.

title
string

Title of the contributor role.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 1,
  • "slug": "moderator",
  • "title": "The moderator of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Update the role for contributor informations.

Update the role for contributor informations.

path Parameters
id
required
string

Unique identifier for contributor role.

Request Body schema: application/json
_version
string
Value: "v2"
id
integer

Identifier of the contributor role.

slug
string

Slug of the contributor role.

title
string

Title of the contributor role.

Responses

Request samples

Content type
application/json
{
  • "_version": "v2",
  • "id": 1,
  • "slug": "moderator",
  • "title": "The moderator of the episode."
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a contributor role.

Delete a contributor role.

path Parameters
id
required
string

Unique identifier for contributor role.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

A list of episodes with the contributor

A list of episodes with the contributor

path Parameters
id
required
string

Unique identifier for contributor.

Responses

Response samples

Content type
application/json
{
  • "_version": "v2",
  • "results": [
    ]
}