Skip to content

REST API reference

Businesses

Read businesses and their current portal status.

List businesses

GET/businesses/

Parameters

Name Location Type Required
search query string No
ordering query string No
page_size query integer No
cursor query string No
created_after query string No
created_before query string No
updated_after query string No
updated_before query string No

Request

curl --request GET \
  --url 'https://api.staging.levr.ai/api/external/v1/businesses/' \
  --header 'Authorization: Bearer $LEVR_API_TOKEN'

Responses

Status Description
200 Businesses available to this portal API token.
401 The request was not completed.
403 The request was not completed.
429 The request was not completed.
500 The request was not completed.

Get a business and its portal status

GET/businesses/{business_id}/

Parameters

Name Location Type Required
business_id path string Yes

Request

curl --request GET \
  --url 'https://api.staging.levr.ai/api/external/v1/businesses/{business_id}/' \
  --header 'Authorization: Bearer $LEVR_API_TOKEN'

Responses

Status Description
200 The business status visible in this portal.
401 The request was not completed.
403 The request was not completed.
404 The request was not completed.
409 The request was not completed.
429 The request was not completed.
500 The request was not completed.

Early access

Request a capability

Tell us what you need your integration to do. Add an email if you want a reply.