List Licenses

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Query parameters

includestringOptional

Optional: Relationships to include - comma separated - createdBy,updatedBy

searchstringOptional

Optional: Search term across name, display_name, issuing_authority, license_code - example: Commercial

license_typestringOptional

Optional: Filter by license type - commercial|residential|specialty

issuing_authoritystringOptional

Optional: Filter by issuing authority - example: State Board, County

requires_renewalstringOptional

Optional: Filter by renewal requirement - true|false|1|0

is_activebooleanOptional

Optional: Filter by active status - true|false|1|0 - default: all

tenant_location_idstringOptional

Optional: Filter by tenant location ID - numeric ID

per_pageintegerOptional

Optional: Results per page - default 15

pageintegerOptional

Optional: Page number - default 1

Response

Successful response