API ReferenceView as MarkdownOpenAPI

Insurance

View as Markdown

Endpoints that need a token: the site owner creates it in their admin (Developers > API reference). AI assistants: how to ask the user for one.

5 endpoints.

Retrieve the insurance

Returns the insurance.

Public

Public - no token needed.

Query parameters
dependability_filterstring

Only insurances with this dependability filter.

no_populatestring

Only insurances with this no populate.

Status codes

200 500

GET/insurance
curl -X GET 'http://builderly.app/insurance?ionic=true&dependability_filter=...&no_populate=...'
Response
{
  "name": "Example",
  "make": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Create an insurance

Creates an insurance from the fields sent.

User token

Needs the token of a signed-in user.

Status codes

201 400 401 500

POST/insurance
curl -X POST 'http://builderly.app/insurance?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "name": "Example",
  "make": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Retrieve an insurance

Returns one insurance, found by its ID.

Public

Public - no token needed.

Path parameters
idstringRequired

The ID of the insurance.

Query parameters
no_populatestring

Only insurances with this no populate.

Status codes

200 404 500

GET/insurance/:id
curl -X GET 'http://builderly.app/insurance/{id}?ionic=true&no_populate=...'
Response
{
  "name": "Example",
  "make": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Update an insurance

Changes the fields sent; the others stay as they are.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the insurance.

Status codes

200 400 401 404 500

PATCH/insurance/:id
curl -X PATCH 'http://builderly.app/insurance/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
Response
{
  "name": "Example",
  "make": "6543210fedcba98765432100",
  "_id": "6543210fedcba98765432100",
  "updatedAt": "2026-11-04T12:00:00.000Z",
  "createdAt": "2026-11-04T12:00:00.000Z"
}

Delete an insurance

Deletes the insurance. This cannot be undone.

User token

Needs the token of a signed-in user.

Path parameters
idstringRequired

The ID of the insurance.

Returns

Returns an empty answer on success.

Status codes

200 401 404 500

DELETE/insurance/:id
curl -X DELETE 'http://builderly.app/insurance/{id}?ionic=true' \
  -H 'Authorization: Bearer <TOKEN>'
↑↓ Navigate↵ GoEsc Close