Get app API reference
<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>
Returns a reference for the app's own API, the one its code and other systems use to work with its data. It covers:
- Each entity's endpoints to list, read, create, update, and delete records
- The app's users
- Its backend functions
- Its agents
The reference is built from the app as it is now, so it can include entities and functions that haven't been published yet. Server addresses use the app's base44.app address, even when it also has a custom domain.
This is limited to 30 requests a minute per caller for each app. Some workspaces have a different limit.
<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>
Path parameters
ID of the app.
ID of the app.
Response
The app's API reference, as an OpenAPI 3.0.3 document.
Example response
{
"openapi": "3.0.3",
"info": {
"title": "Nordwind Furniture API",
"version": "1.0.0"
},
"servers": [
{
"description": "API server",
"url": "https://my-crm-3c45a1f2.base44.app/api"
}
],
"paths": {
"/entities/Task": {
"get": {
"summary": "List Task records"
}
}
},
"components": {
"schemas": {
"Task": {
"type": "object"
}
}
}
}Changes
Changed in 1 of the 22 revisions of this API.1
- ○
endpoint added
endpoint-added
- ○
Of the 22 revisions, 1 has no diff computed.