Show/hide List Operations Expand Operations

Comments

/recording/comments/{id}

DELETE /recording/comments/{id}.{_format}

Delete a comment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/recordings/{recording}/comments

GET /recordings/{recording}/comments.{_format}

Get all comments of a recording

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
recording			The ID of the recording

Filters

Name

Information

per_page

Datatype	integer
Description	Items per page

page

Datatype	integer
Description	Current page

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /recordings/{recording}/comments.{_format}

Create a comment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
recording

Parameters

Parameter	Type	Required?	Description
start	integer	false	The start position of the annotation, in milliseconds
end	integer	false	The end position of the annotation, in milliseconds
text	string	false

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/recordings/{recording}/comments/{comment}

GET /recordings/{recording}/comments/{comment}.{_format}

Get a single comment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
recording
comment

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Images

POST /files/images.{_format}

Create a new image image

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Links

/pages/{id}/links

GET /pages/{id}/links.{_format}

Get paginated list of links for a page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id			pageId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /pages/{id}/links.{_format}

Create a new link

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id			pageId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{id}/links/{lid}

GET /pages/{id}/links/{lid}.{_format}

Get a single link

Documentation
Sandbox

Requirements

Name	Requirement	Description
_format	json\|xml\|html
id		pageId
lid		linkId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /pages/{id}/links/{lid}.{_format}

Update an existing link

Documentation
Sandbox

Requirements

Name	Requirement	Description
_format	json\|xml\|html
id		pageId
lid		linkId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /pages/{id}/links/{lid}.{_format}

Delete a link related to a page

Documentation
Sandbox

Requirements

Name	Requirement	Description
_format	json\|xml\|html
id		pageId
lid		linkId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Pages

/page/upload/{id}

POST /page/upload/{id}.{_format}

Upload a recording to a page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id			the PageId of the upload

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages

GET /pages.{_format}

Get a list of pages

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/vanityURL/edit

PUT /pages/vanityURL/edit.{_format}

Edit vanityURL of a page.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{id}

GET /pages/{id}.{_format}

Get a single page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /pages/{id}.{_format}

Update an existing page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{id}/recordings

GET /pages/{id}/recordings.{_format}

Get a paginated list of recordings for a page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{id}/recordings/others

GET /pages/{id}/recordings/others.{_format}

Get a paginated list of recordings tagged with a page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{pageId}/activities

GET /pages/{pageId}/activities.{_format}

Get public activities of a page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
pageId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{pageId}/followers

GET /pages/{pageId}/followers.{_format}

Get a list of pages which follow this page.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
pageId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{pageId}/followings

GET /pages/{pageId}/followings.{_format}

Get a list of pages the page is following

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
pageId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{pageId}/notifications

GET /pages/{pageId}/notifications.{_format}

Get a list of notifications for a page.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
pageId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /pages/{pageId}/notifications.{_format}

Mark all unread notifications as read.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
pageId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Playlists

/pages

GET /pages/playlist/{id}/recordings.{_format}

Get a collection of recordings in a playlist

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /pages/playlist/{playlist}.{_format}

Delete an existing playlist.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
playlist

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /pages/playlist/{playlist}/recording/{recording}.{_format}

Add a recording to a playlist.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
playlist
recording

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /pages/playlist/{playlist}/recording/{recording}.{_format}

Remove a recording from a playlist.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
playlist
recording

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /pages/{pageId}/playlist/favorites.{_format}

Get the currently authenticated pages `favorites` list

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
pageId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /pages/{recording}/playlist/favor/toggle.{_format}

Add a recording the currently authenticated pages `favorites `list

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
recording

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/playlist/recording/{recording}

POST /pages/playlist/recording/{recording}.{_format}

Create a new playlist for the current page and an existing recording.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
recording

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/playlists

POST /pages/playlists.{_format}

Create a new playlist for the current page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{id}/playlists

GET /pages/{id}/playlists.{_format}

Get a collection of playlists for a page

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{id}/playlists/{playlist}

PUT /pages/{id}/playlists/{playlist}.{_format}

Update an existing playlist

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id
playlist

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{id}/playlists/{slug}

GET /pages/{id}/playlists/{slug}.{_format}

Get a single playlist

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id
slug

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Recordings

/recordings/slug/{page}/{slug}

GET /recordings/slug/{page}/{slug}.{_format}

Get a single recording by page url and recording slug

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
page
slug

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /recordings/slug/{page}/{slug}.{_format}

Update a recording by slug

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
page
slug

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/recordings/{id}

GET /recordings/{id}.{_format}

Get a single recording

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /recordings/{id}.{_format}

Update an existing recording

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /recordings/{id}.{_format}

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/recordings/{recording}/likes

GET /recordings/{recording}/likes.{_format}

Get all likes for a recording

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
recording

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Tracklist

/recordings/{id}/tracks

GET /recordings/{id}/tracks.{_format}

Get the tracklist for a recording

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
id

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/recordings/{recording}/tracks

PUT /recordings/{recording}/tracks.{_format}

Update the tracklist for a recording

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
recording

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Users

/users/me

GET /users/me.{_format}

Get the currently logged in user

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/users/{username}/favorites

GET /users/{username}/favorites.{_format}

Get a list with recording ids the user has favored

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
username

Filters

Name

Information

pageId

Requirement
Description	ID of the users page

Parameters

Parameter	Type	Required?	Format	Description
user	\s+	false		Username

Input

Requirements

= -

Filters

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/users/{username}/followings

GET /users/{username}/followings.{_format}

Get a list with page ids the user is following

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	json\|xml\|html
username

Filters

Name

Information

pageId

Requirement
Description	ID of the users page

Parameters

Parameter	Type	Required?	Format	Description
user	\s+	false		Username

Input

Requirements

= -

Filters

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Play.fm API Documentation

Comments

/recording/comments/{id}

DELETE /recording/comments/{id}.{_format}

Requirements

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/recordings/{recording}/comments

GET /recordings/{recording}/comments.{_format}

Requirements

Filters

Requirements

Filters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /recordings/{recording}/comments.{_format}

Requirements

Parameters

Requirements

Parameters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/recordings/{recording}/comments/{comment}

GET /recordings/{recording}/comments/{comment}.{_format}

Requirements

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Images

POST /files/images.{_format}

Requirements

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Links

/pages/{id}/links

GET /pages/{id}/links.{_format}

Requirements

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /pages/{id}/links.{_format}

Requirements

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/pages/{id}/links/{lid}

GET /pages/{id}/links/{lid}.{_format}

Requirements

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /pages/{id}/links/{lid}.{_format}

Requirements

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

DELETE /pages/{id}/links/{lid}.{_format}

Requirements

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Pages

/page/upload/{id}

POST /page/upload/{id}.{_format}

Requirements

Requirements

Request URL

Response Headers [Expand] [Profiler]