Get app API reference
Changed on<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, including a read-only key. Workspace API keys are not accepted.</Note>
Request
- Base URLhttps://app.base44.com
- URLhttps://app.base44.com/api/apps/{app_id}/openapi-spec
- AuthHTTP bearer
Path parameters
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
- info
the security scope
read_onlywas added to the endpoint's security schemePersonalAccessTokenAuth - info
the security scope
full_accesswas removed from the endpoint's security schemePersonalAccessTokenAuth
- info
- info
the endpoint scheme security
PersonalAccessTokenAuthwas added to the API
- info