Get Custom Report Details

get

https://{dc-region}.zuperpro.com/api/reports/custom_reports/{report_uid}

Perform custom report details operation with comprehensive options

Path Params

report_uid

string

required

Custom report UID

Query Params

report_name

string

Custom report name

report_module

string

Report module (JOB, CUSTOMER, EMPLOYEE, etc.)

report_description

string

Report description

report_icon

string

Report icon URL

report_code

string

Custom report code

available_to_all

boolean

Available to all users

available_to

string

Available to user UIDs (comma-separated)

available_to_team

string

Available to team UIDs (comma-separated)

created_by

string

Creator user UID

created_at

string

Filter by creation date

updated_at

string

Filter by update date

is_deleted

boolean

Is report deleted

is_active

boolean

Is report active

keyword

string

Search keyword

page

number

Defaults to 1

Page number for pagination

count

number

Defaults to 10

Number of records per page

sort

string

Defaults to DESC

Sort order (ASC/DESC)

sort_by

string

Defaults to created_at

Sort field

Responses

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Custom Report Details operation completed successfully

201Custom Report Details created successfully

400Bad request - Invalid parameters

401Unauthorized - Missing or invalid authentication

404Resource not found