List Dispatches | propelone

statusstringOptional

recipient_customer_idstringOptional

Optional: Filter by recipient customer UUID - exists:customers,id

document_idstringOptional

Optional: Filter by document UUID - exists:documents,id

parent_record_typestringOptional

Optional: Polymorphic parent type - registered morph alias (e.g. estimate, work-order)

parent_record_idstringOptional

Optional: Parent record UUID - converted to int by middleware

created_afterstringOptional

Optional: Lower bound on created_at - date format

created_beforestringOptional

Optional: Upper bound on created_at - date format - after_or_equal created_after

pageintegerOptional

Optional: Page number - integer >= 1

per_pageintegerOptional

Optional: Results per page - integer 1-200 - default 15

Successful response

1	curl -G https://https//https/documents/dispatches \
2	-H "{{tenant_key_name}}: X-Tenant-Key" \
3	-H "Content-Type: application/json" \
4	-d status=SENT \
5	-d recipient_customer_id=a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f1a9d8c \
6	-d document_id=d9f8a7b6-c5e4-3d2c-1b0a-9f8e7d6c5b4a \
7	-d parent_record_type=work-order \
8	-d parent_record_id=1024 \
9	--data-urlencode created_after=2024-01-01T00:00:00Z \
10	--data-urlencode created_before=2024-04-01T23:59:59Z \
11	-d page=1 \
12	-d per_page=15