Search Applications

Overview

Search and filter applications with pagination.

Truncated Response: The search endpoint returns a simplified version of application data. For complete application details including all customer fields and customer devices, use the Get Application endpoint.

For more information and best practices, see the Applications API Guide.

Authorizations

x-api-key

string

header

required

API key for authentication. Include your Leap API key in the x-api-key header: x-api-key: leap_live_...

Query Parameters

refId

string

Reference ID to filter applications for a specific customer within your organization

Example:

"982734ihksjhfwoe8u"

customer_id

integer

Filter by customer ID

Example:

609

application_status

enum<string>

Filter by application status

Available options:

not_started,

in_progress,

awaiting_partner,

completed,

submitted,

approved,

rejected

Example:

"awaiting_partner"

page_token

string

Token for pagination to fetch the next page of results

Example:

"242c3e24-43e6-4ad7-88b3-666cda21582b"

limit

integer

default:50

Maximum number of results to return per page

Required range: 1 <= x <= 100

Example:

50

Response

Successful response with list of applications

results

object[]

required

Array of applications matching the search criteria

Show child attributes

results.id

integer

required

Unique identifier for the application

Example:

123

results.program_id

integer

required

ID of the rebate program this application is for

Example:

45

results.customer_id

integer

required

ID of the customer who owns this application

Example:

456

results.status

enum<string>

default:not_started

required

Current status of the application

Available options:

not_started,

in_progress,

awaiting_partner,

completed,

submitted,

approved,

rejected

Example:

"submitted"

results.organization_id

string<uuid> | null

Organization ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

results.customer_device_id

integer[]

Array of customer device IDs associated with this application

Example:

[10, 11]

results.rebate_type

string | null

Type of rebate being requested

Example:

"point_of_sale"

results.payee_type

enum<string> | null

Who will receive the rebate payment

Available options:

customer,

contractor,

instant

Example:

"customer"

results.submission_date

string<date> | null

Date the application was submitted

Example:

"2025-01-15"

results.approval_date

string<date> | null

Date the application was approved

Example:

"2025-01-20"

results.total_requested_amount

number<decimal> | null

Total rebate amount being requested

Example:

1500

results.equipment_complete

boolean | null

Whether all equipment documentation is complete

results.permit_complete

boolean | null

Whether all permit documentation is complete

results.utility_complete

boolean | null

Whether all utility documentation is complete

results.created_at

string<date-time>

Timestamp when application was created

Example:

"2025-01-10T10:00:00Z"

results.updated_at

string<date-time>

Timestamp when application was last updated

Example:

"2025-01-15T14:30:00Z"

results.customer

object

Truncated customer information returned in search results

Show child attributes

results.customer.id

integer

required

Unique identifier for the customer

Example:

456

results.customer.address_line1

string

required

Street address line 1

Example:

"123 Main St"

results.customer.city

string

required

City

Example:

"San Francisco"

results.customer.state

string

required

State code (2 letters)

Example:

"CA"

results.customer.zip_code

string

required

ZIP code

Example:

"94102"

results.customer.first_name

string | null

Customer's first name

Example:

"Jane"

results.customer.last_name

string | null

Customer's last name

Example:

"Doe"

results.customer.email

string<email> | null

Customer's email address

Example:

"[email protected]"

results.customer.phone

string | null

Customer's phone number

Example:

"+15551234567"

next_page_token

string | null

Token to fetch the next page of results. Null if no more pages available.

Example:

"242c3e24-43e6-4ad7-88b3-666cda21582b"

Getting Started

API Reference

Guides

Overview

Authorizations

Query Parameters

Response

Getting Started

API Reference

Guides

​Overview

Authorizations

Query Parameters

Response

Overview