Example
Section titled “Example”The key is read from PORT_API_KEY, so the command never prints it.
Parameters
Section titled “Parameters”| Name | In | Type | What it does |
|---|---|---|---|
day | query | string | A day as YYYY-MM-DD. Defaults to the latest. |
Answers 404 no_briefing when none has been written yet, or none for that day. That is the normal answer for a new account, not a fault.
Response
Section titled “Response”A 200 with the envelope every endpoint answers, and this endpoint's answer in data. Amounts and USD figures are strings.
What data looks like, with sample values: the shape is the schema's, checked when these pages are built, and the figures are made up, not anyone's port.
{ "day": "2026-10-06", "at": "2026-10-06T05:42:10.000Z", "greeting": "Good morning", "summary": [ { "text": "Up 1.0% while you slept.", "strong": false, "money": false } ], "stories": [ { "tone": "up", "title": "ETH carried the night", "body": [ { "text": "Up 1.0% while you slept.", "strong": false, "money": false } ], "facts": [ { "label": "Net worth", "value": "$48,210" } ], "mark": null, "action": { "label": "Open Home", "to": "/home" } } ], "complete": true, "news": [ { "title": "A headline from a source you follow", "link": "https://example.com/story", "source": "Example News", "site": "example.com", "at": "2026-10-06T05:42:10.000Z" } ]}Field of data | Type | Always present |
|---|---|---|
day | string | yes |
at | string | yes |
greeting | string | yes |
summary | array of object | yes |
stories | array of object | yes |
complete | boolean | yes |
news | array of object | no |
The whole schema of data
As the OpenAPI document at https://getport.app/api/v1/openapi.json states it. Objects are left open, because a response only ever gains fields.
{ "type": "object", "properties": { "day": { "type": "string" }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "greeting": { "type": "string" }, "summary": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "strong": { "type": "boolean" }, "money": { "type": "boolean" } }, "required": [ "text" ] } }, "stories": { "type": "array", "items": { "type": "object", "properties": { "tone": { "type": "string", "enum": [ "up", "down", "warn", "muted" ] }, "title": { "type": "string" }, "body": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "strong": { "type": "boolean" }, "money": { "type": "boolean" } }, "required": [ "text" ] } }, "facts": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "label", "value" ] } }, "mark": { "anyOf": [ { "type": "object", "properties": { "path": { "type": [ "string", "null" ] }, "mono": { "type": "string" }, "tint": { "type": "string" } }, "required": [ "path", "mono", "tint" ] }, { "type": "null" } ] }, "action": { "type": "object", "properties": { "label": { "type": "string" }, "to": { "type": "string" } }, "required": [ "label", "to" ] } }, "required": [ "tone", "title", "body", "facts", "action" ] } }, "complete": { "type": "boolean" }, "news": { "maxItems": 6, "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 400 }, "link": { "type": "string", "pattern": "^https?:\\/\\/" }, "source": { "type": "string", "maxLength": 120 }, "site": { "type": "string", "maxLength": 200 }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "title", "link", "source", "site", "at" ] } } }, "required": [ "day", "at", "greeting", "summary", "stories", "complete" ]}From an agent
Section titled “From an agent”The MCP tool port_briefing answers the same question ("what does my briefing say today") with the same figures, over the MCP server.
Refusals
Section titled “Refusals”Every endpoint shares three: 401 for a missing or dead key, 402 for an account whose plan has no API ("Agents, MCP and the API are on Pro+ and above."), and 429 past the minute or day limit. The errors section has each body.
This endpoint also refuses:
400bad_daywhendayis not a day as YYYY-MM-DD.404no_briefingwhen no briefing has been written yet, or none for that day.