Skip to main content
GET
List business-establishments
OAuth 2.0 scopes
or

Authorizations

Authorization
string
header
required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

Api-Version
enum<string>
required

Set the API version.

Available options:
2024-11-01
Allowed value: "2024-11-01"
Maximum string length: 10
Example:

"2024-11-01"

If-None-Match
string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

If-Match
string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding
string

List of compression algorithms you support.

Query Parameters

Only return business-establishments belonging to one of the given legal-entity id.

Minimum string length: 1
Example:

Filter business-establishments by their name and/or remoteId. The search is case insensitive and looks for partial matches.

Minimum string length: 1
isArchived
boolean

When omitted: return both archived and non-archived resources. When true: only return archived resources. When false: only return non-archived resources.

page
string

Cursor of the page to retrieve. Read more about pagination.

limit
integer
default:25

Number of items per page. Defaults to 25. Maximum is 100. Read more about pagination.

Required range: 0 <= x <= 100
include
enum<string>[]

Include metadata:

  • embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
  • links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
  • totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Read more about expanding responses.

Available options:
embedded,
links,
totalCount

Response

OK

A collection of business-establishment resources.

type
string
Allowed value: "business-establishments"
url
string<uri>
totalCount
integer<int64> | null

Total number of business-establishment resources across all pages that satisfy query parameters.

Required range: x >= 0
items
business-establishment · object[]
Maximum array length: 100

Links to related resources

embedded
object | null

Embeds the representation of resources related to the business-establishment(s).

Only returned if requested by the API client: ?include=embedded.