Skip to main content

API Channels

Endpoint

URL:
/api/v1/providers

Parameters:

NameTypeRequiredDescription
apkstring✅ YesAPI key used for authentication.
appstring✅ YesThe application context, in this case, “house-music-festival”.
pageinteger✅ YesThe page of results to retrieve.
perPageinteger✅ YesNumber of items to include per page.
includeSubItemsbooleanOptionalWhether or not to include sub-items in the response.

Example Request:

https://www.planbynow.app/api/v1/providers?apk=12345&app=app-test&page=1&perPage=15&includeSubItems=false

Response

Success Response (200 OK)

{
"data": [
{
"uuid": "836ad0c6-b38b-4b25-be2e-338a72c10e0c",
"title": "Trance",
"logo": "https://app.com/jpg/img.jpg",
"displayOrder": 1,
"groupTree": false,
"parentChannelUuid": null
}
],
"page": 1,
"perPage": 15,
"pages": 1,
"results": 6
}

Error Responses

Status CodeError MessageDescription
400"Invalid Request"The request parameters are incorrect or missing.
401"Unauthorized"The API key is missing or invalid.
404"Not Found"The requested configuration does not exist.
500"Internal Server Error"A server-side error occurred.