API reference

Generated from the OpenAPI 3.1 spec, the same file our tests check the API against.

Base URL: https://api.lemobb.comDownload the specOpenAPI 3.1.0 · v1.0.0

Project

Your app's stage in the production funnel, dates and next step.

GET /v1/project

Get your project. Returns the current stage of your app, when it started, what happens next and the promised dates (web app 72 hours and app stores up to 14 days after kickoff).

Scope: project:read

Response (200)

FieldTypeDescription
objectrequired"project"
idrequiredstringProject id (c_ + 20 hex characters).
business_namerequiredstring | null
test_moderequiredbooleanTrue when the project comes from a test purchase.
stagerequired"paid" | "materials_received" | "preview_ready" | "review" | "web_live" | "submitted_to_stores" | "published"Current stage of the production funnel.
stage_labelrequiredstring
stage_summaryrequiredstringWhat the current stage means.
stage_sincerequiredstring (date-time) | null
next_stagerequired"paid" | "materials_received" | "preview_ready" | "review" | "web_live" | "submitted_to_stores" | "published" | null
next_steprequiredstringWhat happens next, in plain English.
deadlinesrequiredobject
deadlines.web_live_byrequiredstring (date-time) | nullPromised web launch date; null before kickoff.
deadlines.published_byrequiredstring (date-time) | nullPromised app store date; null before kickoff.
materials_missingrequiredarray of "logo" | "colors" | "services" | "photos" | "bio" | "hours" | "store"
historyrequiredarray of object
history[].stagerequired"paid" | "materials_received" | "preview_ready" | "review" | "web_live" | "submitted_to_stores" | "published"
history[].atrequiredstring (date-time)
history[].noterequiredstring | null
portal_urlrequiredstringClient portal, where the same data is shown.

Responses

  • 200 Your project.
  • 401 Missing, invalid or expired access token. API Gateway answers {"message": "Unauthorized"}; a token without a linked project gets 403 no_project.
  • 403 The token does not have the scope this operation needs. API Gateway answers {"message": "Forbidden"} (or insufficient_scope from the API).
  • 429 Too many requests (rate_limited). Each user can make 120 requests per minute; wait for the number of seconds in Retry-After. API Gateway also caps the whole API.

Example

curl https://api.lemobb.com/v1/project \
  -H "Authorization: Bearer $LEMOBB_TOKEN"

Materials

The checklist of what we need to build your app, text answers and file uploads.

GET /v1/materials

Get the materials checklist. Lists every checklist item with its status (missing, received, approved, needs_changes), what it accepts and the files you sent. missing lists the required items we still need.

Scope: project:read

Response (200)

FieldTypeDescription
objectrequired"materials"
completerequiredbooleanTrue when no required item is missing.
missingrequiredarray of "logo" | "colors" | "services" | "photos" | "bio" | "hours" | "store"
used_bytesrequiredinteger
quota_bytesrequiredinteger
itemsrequiredarray of MaterialItem

Responses

  • 200 The checklist.
  • 401 Missing, invalid or expired access token. API Gateway answers {"message": "Unauthorized"}; a token without a linked project gets 403 no_project.
  • 403 The token does not have the scope this operation needs. API Gateway answers {"message": "Forbidden"} (or insufficient_scope from the API).
  • 429 Too many requests (rate_limited). Each user can make 120 requests per minute; wait for the number of seconds in Retry-After. API Gateway also caps the whole API.

Example

curl https://api.lemobb.com/v1/materials \
  -H "Authorization: Bearer $LEMOBB_TOKEN"

PUT /v1/materials/{item}/text

Save a text answer. Saves the text answer of an item that accepts text (colors, services, bio, hours, store). It replaces the previous answer and sends the item back to review. An empty text clears the answer.

Scope: materials:write

Path parameters

FieldTypeDescription
itemrequiredstringChecklist item id. One of: logo, colors, services, photos, bio, hours, store.

Request body

FieldTypeDescription
textrequiredstringEmpty text clears the answer. max 10000 chars.

Response (200)

FieldTypeDescription
idrequired"logo" | "colors" | "services" | "photos" | "bio" | "hours" | "store"
titlerequiredstring
hintrequiredstringWhat we need for this item.
requiredrequiredboolean
statusrequired"missing" | "received" | "approved" | "needs_changes"
textrequiredstring | null
noterequiredstring | nullNote from our team (e.g. what to fix).
acceptsrequiredobject
accepts.textrequiredobject | null
accepts.text.max_lengthrequiredinteger
accepts.filesrequiredobject | null
accepts.files.formatsrequiredarray of object
accepts.files.formats[].formatrequired"svg" | "png" | "jpeg" | "webp" | "heic" | "pdf" | "csv" | "txt" | "docx" | "xlsx"
accepts.files.formats[].content_typerequiredstring
accepts.files.max_bytesrequiredinteger
accepts.files.max_filesrequiredinteger
filesrequiredarray of object
files[].idrequiredstring
files[].namerequiredstring
files[].sizerequiredinteger
files[].uploaded_atrequiredstring (date-time)

Responses

  • 200 The updated item.
  • 400 The request is invalid (invalid_request, invalid_json) or breaks an item rule (text_not_accepted, text_too_long, files_not_accepted, file_type_not_accepted, file_too_large, too_many_files, quota_exceeded, upload_missing).
  • 401 Missing, invalid or expired access token. API Gateway answers {"message": "Unauthorized"}; a token without a linked project gets 403 no_project.
  • 403 The token does not have the scope this operation needs. API Gateway answers {"message": "Forbidden"} (or insufficient_scope from the API).
  • 404 Unknown checklist item (unknown_item) or upload (upload_not_found).
  • 429 Too many requests (rate_limited). Each user can make 120 requests per minute; wait for the number of seconds in Retry-After. API Gateway also caps the whole API.

Example

curl -X PUT https://api.lemobb.com/v1/materials/hours/text \
  -H "Authorization: Bearer $LEMOBB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text": "Mon-Fri 9am-6pm, Sat 10am-2pm. Closed on Sundays."}'

POST /v1/materials/{item}/upload-url

Create an upload URL. Checks the file against the item's rules (format, size, number of files and your storage quota) and returns a pre-signed URL valid for 10 minutes. PUT the file to url with the Content-Type in headers, then confirm it with POST /v1/materials/{item}/files. Limit: 30 per hour.

Scope: materials:write

Path parameters

FieldTypeDescription
itemrequiredstringChecklist item id. One of: logo, colors, services, photos, bio, hours, store.

Request body

FieldTypeDescription
file_namerequiredstringmin 1 chars, max 500 chars.
content_typerequiredstringMIME type, e.g. image/png. max 200 chars.
sizerequiredintegerExact file size in bytes. min 1.

Response (200)

FieldTypeDescription
objectrequired"upload_url"
upload_idrequiredstring
methodrequired"PUT"
urlrequiredstringPre-signed URL. Valid for 10 minutes.
headersrequiredobjectSend exactly these headers with the PUT.
headers.Content-Typerequiredstring
expires_atrequiredstring (date-time)

Responses

  • 200 Where to upload the file.
  • 400 The request is invalid (invalid_request, invalid_json) or breaks an item rule (text_not_accepted, text_too_long, files_not_accepted, file_type_not_accepted, file_too_large, too_many_files, quota_exceeded, upload_missing).
  • 401 Missing, invalid or expired access token. API Gateway answers {"message": "Unauthorized"}; a token without a linked project gets 403 no_project.
  • 403 The token does not have the scope this operation needs. API Gateway answers {"message": "Forbidden"} (or insufficient_scope from the API).
  • 404 Unknown checklist item (unknown_item) or upload (upload_not_found).
  • 429 Too many requests (rate_limited). Each user can make 120 requests per minute; wait for the number of seconds in Retry-After. API Gateway also caps the whole API.

Example

curl -X POST https://api.lemobb.com/v1/materials/logo/upload-url \
  -H "Authorization: Bearer $LEMOBB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"file_name": "logo.png", "content_type": "image/png", "size": 48213}'

# Then upload the file to the returned url:
curl -X PUT "$UPLOAD_URL" -H "Content-Type: image/png" --data-binary @logo.png

POST /v1/materials/{item}/files

Confirm an uploaded file. Confirms a file after the PUT. We check that the size and the file signature match what you declared; if not, the file is discarded (422 file_rejected). On success the file is added to the item.

Scope: materials:write

Path parameters

FieldTypeDescription
itemrequiredstringChecklist item id. One of: logo, colors, services, photos, bio, hours, store.

Request body

FieldTypeDescription
upload_idrequiredstringpattern ^[0-9a-f-]{36}\.[a-z]+$.

Response (200)

FieldTypeDescription
idrequired"logo" | "colors" | "services" | "photos" | "bio" | "hours" | "store"
titlerequiredstring
hintrequiredstringWhat we need for this item.
requiredrequiredboolean
statusrequired"missing" | "received" | "approved" | "needs_changes"
textrequiredstring | null
noterequiredstring | nullNote from our team (e.g. what to fix).
acceptsrequiredobject
accepts.textrequiredobject | null
accepts.text.max_lengthrequiredinteger
accepts.filesrequiredobject | null
accepts.files.formatsrequiredarray of object
accepts.files.formats[].formatrequired"svg" | "png" | "jpeg" | "webp" | "heic" | "pdf" | "csv" | "txt" | "docx" | "xlsx"
accepts.files.formats[].content_typerequiredstring
accepts.files.max_bytesrequiredinteger
accepts.files.max_filesrequiredinteger
filesrequiredarray of object
files[].idrequiredstring
files[].namerequiredstring
files[].sizerequiredinteger
files[].uploaded_atrequiredstring (date-time)

Responses

  • 200 The updated item.
  • 400 The request is invalid (invalid_request, invalid_json) or breaks an item rule (text_not_accepted, text_too_long, files_not_accepted, file_type_not_accepted, file_too_large, too_many_files, quota_exceeded, upload_missing).
  • 401 Missing, invalid or expired access token. API Gateway answers {"message": "Unauthorized"}; a token without a linked project gets 403 no_project.
  • 403 The token does not have the scope this operation needs. API Gateway answers {"message": "Forbidden"} (or insufficient_scope from the API).
  • 404 Unknown checklist item (unknown_item) or upload (upload_not_found).
  • 422 The file does not match its declared type or size and was discarded.
  • 429 Too many requests (rate_limited). Each user can make 120 requests per minute; wait for the number of seconds in Retry-After. API Gateway also caps the whole API.

Example

curl -X POST https://api.lemobb.com/v1/materials/logo/files \
  -H "Authorization: Bearer $LEMOBB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"upload_id": "3f1c2a9e-8d7b-4c6a-9f0e-1b2c3d4e5f60.png"}'

Notes

Messages to your concierge.

POST /v1/notes

Send a note to your concierge. Sends a message to the Lemobb team building your app: a question, a change request or context about your materials. Limit: 20 per day.

Scope: materials:write

Request body

FieldTypeDescription
textrequiredstringmin 1 chars, max 2000 chars.

Response (201)

FieldTypeDescription
objectrequired"note"
idrequiredstring
textrequiredstring
created_atrequiredstring (date-time)

Responses

  • 201 The note was received.
  • 400 The request is invalid (invalid_request, invalid_json) or breaks an item rule (text_not_accepted, text_too_long, files_not_accepted, file_type_not_accepted, file_too_large, too_many_files, quota_exceeded, upload_missing).
  • 401 Missing, invalid or expired access token. API Gateway answers {"message": "Unauthorized"}; a token without a linked project gets 403 no_project.
  • 403 The token does not have the scope this operation needs. API Gateway answers {"message": "Forbidden"} (or insufficient_scope from the API).
  • 429 Too many requests (rate_limited). Each user can make 120 requests per minute; wait for the number of seconds in Retry-After. API Gateway also caps the whole API.

Example

curl -X POST https://api.lemobb.com/v1/notes \
  -H "Authorization: Bearer $LEMOBB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text": "Can the booking button say \"Book a visit\"?"}'

Billing

Where to manage your subscription.

GET /v1/billing

Get the billing portal link. Returns the Stripe Customer Portal sign-in page for your subscription. Sign in there with the email you used at checkout to update your card, download invoices or cancel. Lemobb never sees your card details.

Scope: billing:read

Response (200)

FieldTypeDescription
objectrequired"billing"
test_moderequiredboolean
customer_portal_urlrequiredstringStripe Customer Portal sign-in page for your subscription.
instructionsrequiredstring

Responses

  • 200 The billing portal link.
  • 401 Missing, invalid or expired access token. API Gateway answers {"message": "Unauthorized"}; a token without a linked project gets 403 no_project.
  • 403 The token does not have the scope this operation needs. API Gateway answers {"message": "Forbidden"} (or insufficient_scope from the API).
  • 429 Too many requests (rate_limited). Each user can make 120 requests per minute; wait for the number of seconds in Retry-After. API Gateway also caps the whole API.

Example

curl https://api.lemobb.com/v1/billing \
  -H "Authorization: Bearer $LEMOBB_TOKEN"

Errors

Every error has the same shape. Use code in your code and show message to people.

FieldTypeDescription
errorrequiredobject
error.coderequiredstringStable machine-readable code, e.g. file_too_large.
error.messagerequiredstringHuman-readable explanation in English.
{"error": {"code": "file_too_large", "message": "This file is too large for this item."}}

Schemas

Project

FieldTypeDescription
objectrequired"project"
idrequiredstringProject id (c_ + 20 hex characters).
business_namerequiredstring | null
test_moderequiredbooleanTrue when the project comes from a test purchase.
stagerequired"paid" | "materials_received" | "preview_ready" | "review" | "web_live" | "submitted_to_stores" | "published"Current stage of the production funnel.
stage_labelrequiredstring
stage_summaryrequiredstringWhat the current stage means.
stage_sincerequiredstring (date-time) | null
next_stagerequired"paid" | "materials_received" | "preview_ready" | "review" | "web_live" | "submitted_to_stores" | "published" | null
next_steprequiredstringWhat happens next, in plain English.
deadlinesrequiredobject
deadlines.web_live_byrequiredstring (date-time) | nullPromised web launch date; null before kickoff.
deadlines.published_byrequiredstring (date-time) | nullPromised app store date; null before kickoff.
materials_missingrequiredarray of "logo" | "colors" | "services" | "photos" | "bio" | "hours" | "store"
historyrequiredarray of object
history[].stagerequired"paid" | "materials_received" | "preview_ready" | "review" | "web_live" | "submitted_to_stores" | "published"
history[].atrequiredstring (date-time)
history[].noterequiredstring | null
portal_urlrequiredstringClient portal, where the same data is shown.

Materials

FieldTypeDescription
objectrequired"materials"
completerequiredbooleanTrue when no required item is missing.
missingrequiredarray of "logo" | "colors" | "services" | "photos" | "bio" | "hours" | "store"
used_bytesrequiredinteger
quota_bytesrequiredinteger
itemsrequiredarray of MaterialItem

MaterialItem

FieldTypeDescription
idrequired"logo" | "colors" | "services" | "photos" | "bio" | "hours" | "store"
titlerequiredstring
hintrequiredstringWhat we need for this item.
requiredrequiredboolean
statusrequired"missing" | "received" | "approved" | "needs_changes"
textrequiredstring | null
noterequiredstring | nullNote from our team (e.g. what to fix).
acceptsrequiredobject
accepts.textrequiredobject | null
accepts.text.max_lengthrequiredinteger
accepts.filesrequiredobject | null
accepts.files.formatsrequiredarray of object
accepts.files.formats[].formatrequired"svg" | "png" | "jpeg" | "webp" | "heic" | "pdf" | "csv" | "txt" | "docx" | "xlsx"
accepts.files.formats[].content_typerequiredstring
accepts.files.max_bytesrequiredinteger
accepts.files.max_filesrequiredinteger
filesrequiredarray of object
files[].idrequiredstring
files[].namerequiredstring
files[].sizerequiredinteger
files[].uploaded_atrequiredstring (date-time)