Get All Records

Returns a paginated list of records for a workflow-type entity. This is a v2 native-entity endpoint served from the /v2/api/entity base and authenticated with a Bearer token.

Workflow-type entities are configurable record types (for example maintenance orders or service requests). The workflow_id path segment selects the workflow type, and the resource prefix plus that id form the entity key le_workflow-type-entity-{workflow_id}. Each record is a work-order-based row belonging to that type. The available fields — including any custom fields — are defined by the selected workflow type's configuration, so the record shape varies between workflow types; custom fields are returned under the le_workflow-type-entity-{workflow_id}_custom_data object.

The trailing path segment is the data level — how deeply related records are loaded — not a page number or a response-format extension. Pagination is controlled by the page and per_page query parameters; results can be narrowed with filter[...], ordered with sort[...], and trimmed with fields.

Filter and sort act on the record's own columns. The fields below are an example for a maintenance-order workflow — the exact set is workflow-specific. Custom-data fields (returned under le_workflow-type-entity-{workflow_id}_custom_data) are not filterable or sortable through this endpoint.

Filterable fields (example). filter[<field>]=<value> (exact) or filter[<field>][<operator>]=<value>:

Field	Type	Example
`number`	string	`filter[number][like]=000`
`title`	string	`filter[title][like]=order`
`start_date`	date	`filter[start_date][greater_than_equal]=2026-01-01`
`client_id`	integer	`filter[client_id][equal]=5`

(filter[status] is currently ineffective for this entity, and a search query parameter has no effect — use filter[...].)

Sorting. Sort with sort[<field>]=asc|desc (e.g. sort[number]=desc) on the record's columns. The scalar sort=field / sort=-field form is not supported (HTTP 400), and no default order is guaranteed — always pass sort[...] for stable ordering.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --globoff 'https://.daftara.com/v2/api/entity/le_workflow-type-entity-56/list/?page=1&per_page=20&filter=&sort=&fields=&version=2' \ --header 'Accept: application/json' \ --header 'apikey: ' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json'

{ "current_page": 0, "data": [ { "id": 0, "client_id": 0, "number": "string", "title": "string", "start_date": "string", "description": "string", "delivery_date": "string", "delivery_appointment_id": null, "follow_up_status_id": null, "budget_currency": "string", "budget": 0, "status": 0, "created": "string", "modified": "string", "staff_id": 0, "client_data": null, "extra_details": null, "branch_id": 0, "workflow_type_id": 0, "le_workflow-type-entity-{{workflow_id}}_custom_data": { "id": null, "reference_id": null }, "workflow_type": { "id": 0, "name": "string", "status": 0, "icon": null, "created": "string", "modified": "string", "singular_title": "string", "entity_key": "string", "app_related_data": { "id": null, "record_id": null } }, "staff": { "id": 0, "added_by": 0, "role_id": 0, "name": "string", "middle_name": "string", "last_name": "string", "photo": null, "can_access_system": 0, "home_phone": "string", "business_Phone": null, "mobile": "string", "fax": null, "country_code": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "postal_code": "string", "note": null, "email_address": "string", "last_login": "string", "active": 0, "created": "string", "hourly_rate": null, "hourly_rate_currency_code": null, "default_store_id": 0, "default_treasury_id": 0, "maximum_general_discount": 0, "language_code": 0, "branch_id": 0, "full_name": "string", "attendance_restriction_id": null, "type": "string", "default_account_id": null, "citizenship_status": "string", "residence_expiry_date": null, "nationality": null, "code": "string", "official_id": null, "staff_info": { "staff_id": 0, "department_id": null, "employment_level_id": null, "employment_type_id": null, "designation_id": null, "birth_date": null, "gender": null, "personal_email": null, "permanent_address1": null, "permanent_address2": null, "permanent_city": null, "permanent_state": null, "permanent_postal_code": null, "created": "string", "modified": "string", "attendance_shift_id": null, "leave_policy_id": null, "has_secondary_shift": 0, "secondary_shift_id": null, "direct_manager_id": null }, "staff_job": { "staff_id": 0, "join_date": null, "probation_end_date": null, "contract_duration": 0, "contract_duration_period": null, "exit_date": null, "exit_reason": null, "fiscal_type": null, "fiscal_day": "string", "fiscal_month": "string", "created": "string", "modified": "string" }, "staff_custom_data": { "id": null, "allow_printing": null, "reference_id": null, "time": null } }, "work_order_client": { "id": 0, "group_price_id": null, "is_offline": 0, "client_number": "string", "staff_id": 0, "business_name": "string", "first_name": "string", "last_name": "string", "email": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "postal_code": "string", "phone1": "string", "phone2": "string", "country_code": "string", "notes": "string", "active_secondary_address": 0, "secondary_name": "string", "secondary_address1": "string", "secondary_address2": "string", "secondary_city": "string", "secondary_state": "string", "secondary_postal_code": "string", "secondary_country_code": "string", "language_code": null, "default_currency_code": "string", "last_login": null, "suspend": 0, "last_ip": null, "created": "string", "modified": "string", "follow_up_status": null, "category": "string", "bn1": "string", "bn1_label": "string", "bn2_label": "string", "bn2": "string", "starting_balance": null, "photo": null, "birth_date": null, "gender": null, "map_location": null, "type": 0, "credit_limit": 0, "credit_period": 0, "branch_id": 0, "national_id": null, "category_id": 0, "secondary_follow_up_status": null, "timezone": null, "client_photo_s3": { "id": null, "entity_key": null, "entity_id": null, "file_id": null, "deleted_at": null }, "client_custom_data": { "id": 0, "building_no": "string", "reference_id": "string", "client_name_en": "string", "vat_category": "string", "customer_service_contact": "string", "customer_reference": "string", "custom_price_list": null } }, "branch": { "id": 0, "name": "string", "status": 0, "created": "string", "modified": "string" }, "work_order_follow_up_status": { "id": null, "item_type": null, "name": null, "color": null, "status": null, "staff_id": null, "created": null, "modified": null, "deleted": null, "entity_key": null, "display_order": null }, "assigned_users": { "id": 0, "item_id": 0, "item_type": 0, "entity_key": "string", "entity_field_key": "string", "staff_id": 0, "group_id": 0, "assigned_by": 0, "created": "string", "modified": "string" }, "tags": { "id": 0, "item_id": 0, "item_type": 0, "tag_id": 0, "branch_id": 0, "created": "string", "modified": "string", "entity_key": "string", "entity_field_key": "string" } } ], "first_page_url": "string", "from": 0, "last_page": 0, "last_page_url": "string", "links": [ { "url": "string", "label": "string", "page": 0, "active": true } ], "next_page_url": null, "path": "string", "per_page": 0, "prev_page_url": null, "to": 0, "total": 0 }

Request

Responses