Skip to content

List businesses, or find one by external_id

View as Markdown

Returns your platform’s businesses, a page at a time. Pass the previous page’s next_cursor as cursor to get the next page; Pagination explains the rules.

To find one business by your own ID, pass external_id instead. The response is then a page with that business, or an empty page when no business of your platform has that external_id. Its next_cursor is always null.

GET https://embedded-api.lazyinvoice.co.il/v1/businesses
Name Type Required Description
external_id string No Return only the business with this external ID: a page of zero or one, with no next page. Cannot be combined with cursor.
cursor string No The next_cursor of the previous page.
limit integer No Businesses per page, 1 to 100. Minimum 1. Maximum 100. Default 20.

A page of businesses. The body has these fields.

Name Type Description
businesses array of Business object The businesses on this page.
next_cursor string or null Pass as cursor to get the next page; null on the last page.

Every error body is the error envelope. Any endpoint can also return 401, 429 and 500; Errors explains them.

Status Code, cause and what to do
400 validation_error: an unknown query parameter, a limit that is not an integer from 1 to 100, an invalid cursor, an empty external_id, or cursor combined with external_id. Fix the request; param names the field at fault when there is one.

Safe to retry. It changes nothing.

None. This endpoint only reads.

Added in: October 2026