Daftra API

GET All Work Orders

Production

https://{{subdomain}}.daftra.com/api2

GET

/work_orders{format}

Work Orders

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://.daftra.com/api2/work_orders' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "code": 200,
    "result": "successful",
    "data": [
        {
            "WorkOrder": {
                "id": 0,
                "client_id": 15,
                "number": "string",
                "title": "string",
                "start_date": "2019-08-24",
                "description": "string",
                "delivery_date": "2019-08-24",
                "delivery_appointment_id": 0,
                "follow_up_status_id": null,
                "budget": 0,
                "budget_currency": "string",
                "status": "1=>Open",
                "created": "2018-05-10 00:42:00",
                "modified": "2018-05-12 13:05:06",
                "staff_id": 0
            }
        }
    ],
    "pagination": {
        "prev": "/api2/clients/?page=1",
        "next": "/api2/clients/?page=3",
        "page": 2,
        "page_count": 5,
        "total_results": 98
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

format

string

required

Query Params

limit

integer

optional

The collection items limit

>= 1<= 1000

Default:

page

integer

optional

The collection items page

>= 1

Default:

Header Params

string

optional

Default:

application/json

Content-Type

string

optional

Default:

application/json

apikey

string

deprecated

You can find/generate your apikey(s) from inside your Daftra Account

Default:

Responses

🟢200OK

application/json

Body

code

integer

optional

Example:

200

result

string

optional

Example:

successful

data

array [object {1}]

optional

WorkOrder

object

optional

pagination

object (Pagination)

optional

string | null

optional

Example:

/api2/clients/?page=1

string | null

optional

Example:

/api2/clients/?page=3

page

integer

optional

Example:

page_count

integer

optional

Example:

total_results

integer

optional

Example:

🟠401Unauthorized

🟠403Forbidden

Delete Work Orders

Add New Work Order