Feeds
Read a feed
Call the feed's address with a key and the period you want. The answer is the file you designed.
Call it
Call the feed's address, here weekly-hours, with the period you want at the end:
curl "/api/v1/feeds/weekly-hours/last-week" \
-H "Authorization: Bearer $PLANIFIZER_API_KEY"Choose the period
Write the period in words. Relative words follow the calendar, in the timezone of the feed's first activity: last-week called on any day of week 42 reads week 41.
| Words | Period |
|---|---|
this-week · last-week · next-week | This, last or next week, Monday to Sunday. |
last-4-weeks · next-2-weeks | Several whole weeks before this one, or after it: 2 to 13. |
this-month · last-month · next-month | This, last or next calendar month. |
last-3-months | The 2 or 3 months before this one. |
2026-W42 · w42 | A week by its number. w42 is week 42 of the current year. |
2026-10 | A calendar month. |
2026-10-12 | One day. |
2026-10-01..2026-10-15 | From one day to another, both included, 93 days at most. |
Put the words at the end of the address, or in period for tools that only add parameters. week, month, or from and to still work. Give the period once; with none, the feed uses its default period.
GET /api/v1/feeds/weekly-hours/last-week
GET /api/v1/feeds/weekly-hours?period=last-week
GET /api/v1/feeds/weekly-hours?week=2026-W42
GET /api/v1/feeds/weekly-hoursThe feed's default period
Each feed has a period set in Planifizer: last week, this month, fixed dates… A call without a period gets that one, so a tool can call the bare address every Monday and always get last week. A feed set to "Chosen in each call" answers 400 when the call gives none.Parameters
| Parameter | Required | Description |
|---|---|---|
period | No | The period in words: last-week, this-month, 2026-W42, w42, 2026-10, 2026-10-01..2026-10-15. The same words also go at the end of the address. |
week | month | from, to | No | Or the period as week (2026-W42), month (2026-10), or from and to. Leave every period out to get the feed's default period. |
format | No | json or csv. Leave it out to get the feed's own format. |
limit | No | Rows per page, 1 to 1000. Default 500 for JSON. A CSV without limit holds every row. |
cursor | No | The next page: next_cursor from the previous response. |
What comes back
The feed's columns, in its order and with its names, filtered and sorted as saved. Without format, you get the format the feed was saved with.
Semaine,Agent,Responsable,Lundi,Mardi,Mercredi,Jeudi,Vendredi,Samedi,Dimanche,Heures Semaine
2026-W42,DUPONT MARIE,MARTIN PAUL,7,7,7,7,7,5,0,40
2026-W42,KOFFI JEAN,MARTIN PAUL,8,8,8,8,0,8,0,40A feed read as CSV is always the whole file. As JSON it comes in pages, like reports: Pages and syncing
Which keys can read it
Any key of the workspace can read a feed. When the feed shows personal data or planned vs actual, the key needs that access too. A key limited to some activities only gets rows for those, and is refused (activity_not_allowed) on a feed set to other activities.
List your feeds
The workspace's feeds, with their address, row type and columns, are at /feeds
curl "/api/v1/feeds" \
-H "Authorization: Bearer $PLANIFIZER_API_KEY"{
"data": [
{
"slug": "wip-hebdo",
"name": "Heures hebdo pour WIP",
"path": "/api/v1/feeds/wip-hebdo",
"type": "agents",
"group_by": "week",
"period": "week",
"format": "csv",
"columns": [
"Semaine",
"Agent",
"Responsable",
"Lundi",
"Mardi",
"Mercredi",
"Jeudi",
"Vendredi",
"Samedi",
"Dimanche",
"Heures Semaine"
],
"updated_at": "2026-10-13T09:12:00.000Z"
}
],
"meta": {
"count": 1
}
}