GET
/
v2
/
citations

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Fleet-Id
string

ID of the fleet to which the request is scoped.

Query Parameters

vehicle
string

Filters tickets by vehicle plate number or state. Example vehicle=ABC123 or vehicle=NY.

issuing_authority
string

Filters tickets by the name of the issuing authority. Example issuing_authority=City Police.

ticket_type
integer

Filters tickets by ticket type. Pass the numeric value representing the type. Example ticket_type=1. Options are 1 - Parking, 2 - Moving, 3 - Toll, 4 - Violation, 5 - Other.

notice_number
string

Filters tickets by notice number using partial or full match. Example notice_number=W123456.

violation_number
string

Filters tickets by violation number using partial or full match. Example violation_number=V12345678.

received_date
string

Filters tickets by the date they were received. Use received_date=YYYY-MM-DD for exact match, or received_date__gte=YYYY-MM-DD and received_date__lte=YYYY-MM-DD for range.

ticket_date
string

Filters tickets by the date of the ticket. Use ticket_date=YYYY-MM-DD for exact match, or ticket_date__gte=YYYY-MM-DD and ticket_date__lte=YYYY-MM-DD for range.

ticket_time
string

Filters tickets by the time of the ticket. Use ticket_time=HH:MM:SS for exact match, or ticket_time__gte=HH:MM:SS and ticket_time__lte=HH:MM:SS for range.

description
string

Filters tickets by description using partial or full match. Example description=Tow Away Zone.

issue_date
string

Filters tickets by the issue date. Use issue_date=YYYY-MM-DD for exact match, or issue_date__gte=YYYY-MM-DD and issue_date__lte=YYYY-MM-DD for range.

fine_amount
number

Filters tickets by the fine amount. Use fine_amount=50.00 for exact match, or fine_amount__gt=50.00, fine_amount__lt=50.00, fine_amount__gte=50.00, and fine_amount__lte=50.00 for range.

penalty_amount
number

Filters tickets by the penalty amount. Use penalty_amount=0.00 for exact match, or penalty_amount__gt=0.00, penalty_amount__lt=0.00, penalty_amount__gte=0.00, and penalty_amount__lte=0.00 for range.

ordering
string

Orders the results based on specified fields. Prefix with - for descending order. Example ordering=-ticket_date.

column
string

Selects only specific columns to be returned in the response. Separate multiple column names with a comma. Example column=id,vehicle,ticket_date.

rename_column
string

Renames specified columns in the response. Format as rename_oldName=newName. Separate multiple renamings with a comma. Example rename_vehicle=vehicle_info,rename_issuing_authority=authority.

limit
integer

Limits the number of results returned. Example limit=25.

offset
integer

Specifies the starting point within the collection of results. Example offset=0.

Response

200 - application/json
count
integer
next
string
previous
string
results
object[]