API Elements

Endpoint

URL:
/api/v1/elements

Parameters:

Name	Type	Required	Description
apk	string	✅ Yes	API key used for authentication.
app	string	✅ Yes	The application context, in this case, “tech-conference”.
page	integer	✅ Yes	The page of results to retrieve.
perPage	integer	✅ Yes	Number of items to include per page.
channelUuid	string	Optional	Comma-separated list of channel UUIDs to filter by.
startDate	string	✅ Yes	Start date and time for the filter in ISO 8601 format.
endDate	string	✅ Yes	End date and time for the filter in ISO 8601 format.

Example Request:

https://www.planbynow.app/api/v1/elements?apk=12345&app=app-test&page=1&perPage=60&channelUuid=fef929bf-c304-4072-a304-2219e5310141,81b2515c-01a5-4b26-ae61-84763caf8e0c&startDate=2024-11-05T10:00:00&endDate=2024-11-05T16:00:00

Response

Success Response (200 OK)

{
  "data": [
    {
      "id": "67a54ea8-40f1-4ed0-ada2-3c985b75b901",
      "title": "Lynne Gerhold II",
      "shortDescription": "Extended value-added product",
      "description": "Intuitive logistical toolset. Use the online SMS firewall, then you can override the virtual array!.Aestus cohibeo tabernus. Careo amet crur amiculum crastinus depereo vinco creo callide. Suppellex excepturi tantum laborum arcus.",
      "since": "2024-11-05T10:00:00",
      "till": "2024-11-05T11:00:00",
      "status": "active",
      "image": "https://api.dicebear.com/7.x/miniavs/svg?seed=Dr. Lela Fadel",
      "images": [
        "https://api.dicebear.com/7.x/miniavs/svg?seed=Dr. Lela Fadel"
      ],
      "videos": ["https://www.youtube.com/embed/8aGhZQkoFbQI"],
      "socials": [
        {
          "link": "https://x.com/planbyapp",
          "text": "--",
          "type": "github"
        },
        {
          "link": "https://x.com/planbyapp",
          "text": "--",
          "type": "linkedin"
        },
        {
          "link": "https://x.com/planbyapp",
          "text": "--",
          "type": "instagram"
        },
        {
          "link": "",
          "text": "",
          "type": ""
        },
        {
          "link": "",
          "text": "",
          "type": ""
        }
      ],
      "utc": false,
      "timeZone": "",
      "channelUuid": "fef929bf-c304-4072-a304-2219e5310141"
    }
  ],
  "page": 1,
  "perPage": 60,
  "pages": 1,
  "results": 43
}

Error Responses

Status Code	Error Message	Description
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.