Skip to main content

API Configs

Endpoint

GET /api/v1/configs

Query Parameters

ParameterTypeRequiredDescription
apkstring✅ YesAPI key required for authentication.
appstring✅ YesThe name of the application for which the configuration is requested.

Example Request

GET https://www.planbynow.app/api/v1/configs?apk=12345&app=test-app

Response

Success Response (200 OK)

{
"data": {
"startDate": "2024-10-25T10:00:00",
"endDate": "2024-10-25T24:00:00",
"areas": [],
"dayWidth": 4200,
"dnd": {
"mode": "multi-rows",
"enabled": false
},
"grid": {
"enabled": false,
"hoverHighlight": false
},
"hoursInDays": [],
"isBaseTimeFormat": true,
"isCurrentTime": false,
"isInitialScrollToNow": true,
"isResize": false,
"isRtl": false,
"isVerticalMode": false,
"itemHeight": 90,
"mode": {
"type": "day",
"style": "modern"
},
"overlap": {
"mode": "stack",
"enabled": true
},
"sidebarWidth": 200,
"timelineHeight": 60,
"timezone": {
"mode": "utc",
"zone": "Europe/Paris",
"enabled": false
},
"timelineDividers": 4,
"uiElements": {
"channel": {
"width": 60,
"height": 60,
"showText": true,
"showImage": false,
"textStyle": "modern",
"imageStyle": "default",
"imageBorderRadius": 6
},
"element": {
"width": 40,
"height": 40,
"showTime": true,
"showTitle": true,
"imageStyle": "gradient",
"showImageLive": true,
"showImagePast": true,
"showDescription": false,
"showImageFuture": true,
"imageBorderRadius": 50
}
},
"modal": {
"size": "lg",
"time": {
"showLive": true,
"showPast": true,
"showFuture": true
},
"links": {
"showLive": true,
"showPast": true,
"showFuture": true
},
"style": "festival",
"images": {
"showLive": false,
"showPast": true,
"showFuture": true
},
"videos": {
"showLive": true,
"showPast": true,
"showFuture": false
},
"enabled": true,
"timeFormat": "hh:mm a",
"description": {
"showLive": true,
"showPast": true,
"showFuture": true
},
"descriptionTitle": "Description"
},
"isCalendarMode": false,
"theme": {
"grey": {
"300": "#d1d1d1"
},
"grid": {
"item": "#7180961a",
"divider": "#7180961a",
"highlight": "#38B2AC"
},
"teal": {
"100": "#7927b0"
},
"text": {
"grey": {
"300": "#a0aec0",
"500": "#718096"
}
},
"green": {
"200": "#9c27b0",
"300": "#9c27b0"
},
"white": "#ffffff",
"loader": {
"bg": "#171923db",
"pink": "#6a1b9a",
"teal": "#6a1b9a",
"purple": "#6a1b9a"
},
"primary": {
"600": "#1a202c",
"900": "#171923"
},
"program": {
"hover": {
"text": "#718096",
"title": "#d1d1d1",
"border": "#171923"
},
"border": "#171923"
},
"gradient": {
"blue": {
"300": "#6a1b9a",
"600": "#6a1b9a",
"900": "#4a148c"
}
},
"timeline": {
"divider": {
"bg": "#718096"
}
},
"scrollbar": {
"thumb": {
"bg": "#4a148c"
},
"border": "#4a148c"
}
},
"dateControllers": {
"showDateControllers": false,
"style": {
"text": "#ffffff",
"active": {
"text": "#ffffff",
"border": "#4a148c",
"background": "#4a148c"
},
"border": "#1a202c",
"background": "#1a202c"
}
}
}
}

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.