Zweftly API Documentation

OpenAPI spec →

Introduction

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer YOUR_API_KEY".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Create an API Key in Settings > API Keys

Alerts

GET v1/alerts

GET
https://api.zweftly.com
/v1/alerts
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/alerts" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"active\": true
}"
Example response:
{
    "data": [
        {
            "id": null,
            "assignee_id": null,
            "assignee": null,
            "status": "New",
            "is_active": true,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": null,
            "assignee_id": null,
            "assignee": null,
            "status": "New",
            "is_active": true,
            "created_at": null,
            "updated_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/alerts/{id}

GET
https://api.zweftly.com
/v1/alerts/{id}
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the alert.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/alerts/1" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": null,
        "assignee_id": null,
        "assignee": null,
        "status": "New",
        "is_active": true,
        "created_at": null,
        "updated_at": null
    }
}

Customers

GET v1/customers

GET
https://api.zweftly.com
/v1/customers
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/customers" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": 91,
            "name": "Morgan Hirthe",
            "address": "38862 Ferne Locks Suite 058\nChristianshire, IA 97161",
            "gps_coordinate": "-76.431377,175.370149",
            "tags": [
                "voluptatem"
            ],
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z"
        },
        {
            "id": 92,
            "name": "Janick Schultz DDS",
            "address": "282 Ankunding Station\nBatzbury, CO 61747-3805",
            "gps_coordinate": "8.661523,73.533948",
            "tags": [
                "officia"
            ],
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/customers/{id}

GET
https://api.zweftly.com
/v1/customers/{id}
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the customer.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/customers/1" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": 93,
        "name": "Morgan Hirthe",
        "address": "38862 Ferne Locks Suite 058\nChristianshire, IA 97161",
        "gps_coordinate": "-76.431377,175.370149",
        "tags": [
            "voluptatem"
        ],
        "created_at": "2024-10-08T10:52:15.000000Z",
        "updated_at": "2024-10-08T10:52:15.000000Z"
    }
}

GET v1/customers/{customer_id}/templates

GET
https://api.zweftly.com
/v1/customers/{customer_id}/templates
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

customer_id
integer
required

The ID of the customer.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/customers/1/templates" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": 1,
            "title": "Morning Job",
            "description": "",
            "customer_id": 1,
            "start_at": "10:00:00",
            "end_at": "10:30:00",
            "num_scheduled_users": 1,
            "apply_from": null,
            "applied_at": null,
            "created_at": "2024-09-27T10:29:16.000000Z",
            "updated_at": "2024-09-27T10:29:16.000000Z",
            "deleted_at": null,
            "tasks": [
                {
                    "id": 1,
                    "title": "Task 1",
                    "description": "",
                    "completed_at": null
                },
                {
                    "id": 2,
                    "title": "Task 2",
                    "description": "",
                    "completed_at": null
                }
            ],
            "tags": []
        },
        {
            "id": 1,
            "title": "Morning Job",
            "description": "",
            "customer_id": 1,
            "start_at": "10:00:00",
            "end_at": "10:30:00",
            "num_scheduled_users": 1,
            "apply_from": null,
            "applied_at": null,
            "created_at": "2024-09-27T10:29:16.000000Z",
            "updated_at": "2024-09-27T10:29:16.000000Z",
            "deleted_at": null,
            "tasks": [
                {
                    "id": 1,
                    "title": "Task 1",
                    "description": "",
                    "completed_at": null
                },
                {
                    "id": 2,
                    "title": "Task 2",
                    "description": "",
                    "completed_at": null
                }
            ],
            "tags": []
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/customers/{customer_id}/user-list

GET
https://api.zweftly.com
/v1/customers/{customer_id}/user-list
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

customer_id
integer
required

The ID of the customer.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/customers/1/user-list" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": 79,
            "name": "Morgan Hirthe",
            "forename": "Morgan",
            "surname": "Hirthe",
            "username": "dare.emelie",
            "email": "alayna44@example.org",
            "tags": [
                "autem"
            ],
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z"
        },
        {
            "id": 80,
            "name": "Christian Tromp",
            "forename": "Christian",
            "surname": "Tromp",
            "username": "nstokes",
            "email": "tleuschke@example.net",
            "tags": [
                "adipisci"
            ],
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/customers/{customer_id}/tasks

GET
https://api.zweftly.com
/v1/customers/{customer_id}/tasks
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

customer_id
integer
required

The ID of the customer.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/customers/1/tasks" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "title": null,
            "description": null,
            "type_id": null,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": null,
            "title": null,
            "description": null,
            "type_id": null,
            "created_at": null,
            "updated_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/customers/{customer_id}/notes

GET
https://api.zweftly.com
/v1/customers/{customer_id}/notes
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

customer_id
integer
required

The ID of the customer.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/customers/1/notes" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "note_type_id": null,
            "body": null,
            "user_id": null,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": null,
            "note_type_id": null,
            "body": null,
            "user_id": null,
            "created_at": null,
            "updated_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/customers/{customer_id}/forms/{form_id}/submission

GET
https://api.zweftly.com
/v1/customers/{customer_id}/forms/{form_id}/submission
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

customer_id
integer
required

The ID of the customer.

Example:
1
form_id
integer
required

The ID of the form.

Example:
16
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/customers/1/forms/16/submission" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": null,
        "form_id": null,
        "answers": null,
        "created_at": null,
        "updated_at": null,
        "deleted_at": null
    }
}

Forms

GET v1/forms

GET
https://api.zweftly.com
/v1/forms
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/forms" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "name": null,
            "is_enabled": null,
            "is_tiled": null,
            "display": null,
            "created_at": null,
            "updated_at": null,
            "deleted_at": null
        },
        {
            "id": null,
            "name": null,
            "is_enabled": null,
            "is_tiled": null,
            "display": null,
            "created_at": null,
            "updated_at": null,
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/forms/{id}

GET
https://api.zweftly.com
/v1/forms/{id}
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the form.

Example:
16
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/forms/16" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": null,
        "name": null,
        "is_enabled": null,
        "is_tiled": null,
        "display": null,
        "created_at": null,
        "updated_at": null,
        "deleted_at": null
    }
}

GET v1/form-submissions/{id}

GET
https://api.zweftly.com
/v1/form-submissions/{id}
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the form submission.

Example:
16
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/form-submissions/16" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": null,
        "form_id": null,
        "answers": null,
        "created_at": null,
        "updated_at": null,
        "deleted_at": null
    }
}

Jobs

GET v1/jobs

GET
https://api.zweftly.com
/v1/jobs
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/jobs" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"from\": \"2024-10-08T10:52:15\",
    \"to\": \"2024-10-08T10:52:15\",
    \"customer_id\": 16,
    \"scheduled_user_id\": 16,
    \"actual_user_id\": 16,
    \"not_assigned\": false,
    \"tags\": \"architecto\"
}"
Example response:
{
    "data": [
        {
            "id": 49,
            "title": "Et animi quos velit et fugiat.",
            "description": "Accusantium harum mollitia modi deserunt aut ab. Perspiciatis quo omnis nostrum aut adipisci quidem nostrum qui. Incidunt iure odit et et modi ipsum.",
            "status": "Overdue",
            "is_complete": false,
            "is_overdue": false,
            "is_assigned": true,
            "customer_id": 94,
            "customer": {
                "id": 94,
                "name": "Prof. Annabelle Kshlerin",
                "address": "4706 Madisen Avenue Suite 636\nNew Josianetown, WV 49408-0159",
                "gps_coordinate": "-10.414664,52.758837",
                "created_at": "2024-10-08T10:52:15.000000Z",
                "updated_at": "2024-10-08T10:52:15.000000Z"
            },
            "scheduled_user_id": 84,
            "scheduled_user": {
                "id": 84,
                "name": "Skylar Kuvalis",
                "forename": "Skylar",
                "surname": "Kuvalis",
                "username": "doris.franecki",
                "email": "art04@example.com",
                "created_at": "2024-10-08T10:52:15.000000Z",
                "updated_at": "2024-10-08T10:52:15.000000Z"
            },
            "actual_user_id": 85,
            "actual_user": {
                "id": 85,
                "name": "Henderson Dibbert",
                "forename": "Henderson",
                "surname": "Dibbert",
                "username": "sibyl38",
                "email": "tfadel@example.com",
                "created_at": "2024-10-08T10:52:15.000000Z",
                "updated_at": "2024-10-08T10:52:15.000000Z"
            },
            "scheduled_start_at": "2024-10-08T10:52:00.000000Z",
            "scheduled_end_at": "2024-10-08T11:22:00.000000Z",
            "scheduled_duration_minutes": 30,
            "scheduled_duration_hours": "0.50",
            "actual_start_at": null,
            "actual_end_at": null,
            "actual_duration_minutes": null,
            "actual_duration_hours": null,
            "arrival_time_at": null,
            "departure_time_at": null,
            "gps_coordinate_start": null,
            "gps_accuracy_start": null,
            "gps_coordinate_end": null,
            "gps_accuracy_end": null,
            "template_id": null,
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z",
            "cancelled_at": null,
            "deleted_at": null,
            "tags": [
                "et"
            ]
        },
        {
            "id": 50,
            "title": "Quia maiores assumenda odit.",
            "description": "Officiis corporis nesciunt ut. Iure impedit molestiae ut rem est esse sint. Molestiae sunt suscipit doloribus fugiat ut aut.",
            "status": "Overdue",
            "is_complete": false,
            "is_overdue": false,
            "is_assigned": true,
            "customer_id": 95,
            "customer": {
                "id": 95,
                "name": "Juvenal O'Kon",
                "address": "168 Cordia Landing\nLake Dominic, IA 73644-9666",
                "gps_coordinate": "12.313731,-132.540472",
                "created_at": "2024-10-08T10:52:15.000000Z",
                "updated_at": "2024-10-08T10:52:15.000000Z"
            },
            "scheduled_user_id": 86,
            "scheduled_user": {
                "id": 86,
                "name": "Garfield Marquardt",
                "forename": "Garfield",
                "surname": "Marquardt",
                "username": "wondricka",
                "email": "skyla.fahey@example.com",
                "created_at": "2024-10-08T10:52:15.000000Z",
                "updated_at": "2024-10-08T10:52:15.000000Z"
            },
            "actual_user_id": 87,
            "actual_user": {
                "id": 87,
                "name": "Fausto Ritchie",
                "forename": "Fausto",
                "surname": "Ritchie",
                "username": "litzy.kertzmann",
                "email": "kenna.ortiz@example.org",
                "created_at": "2024-10-08T10:52:15.000000Z",
                "updated_at": "2024-10-08T10:52:15.000000Z"
            },
            "scheduled_start_at": "2024-10-08T10:52:00.000000Z",
            "scheduled_end_at": "2024-10-08T11:22:00.000000Z",
            "scheduled_duration_minutes": 30,
            "scheduled_duration_hours": "0.50",
            "actual_start_at": null,
            "actual_end_at": null,
            "actual_duration_minutes": null,
            "actual_duration_hours": null,
            "arrival_time_at": null,
            "departure_time_at": null,
            "gps_coordinate_start": null,
            "gps_accuracy_start": null,
            "gps_coordinate_end": null,
            "gps_accuracy_end": null,
            "template_id": null,
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z",
            "cancelled_at": null,
            "deleted_at": null,
            "tags": [
                "iusto"
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/jobs/{id}

GET
https://api.zweftly.com
/v1/jobs/{id}
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the job.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/jobs/1" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": null,
        "title": "Consectetur id a consectetur assumenda eaque.",
        "description": "Sunt nihil accusantium odit ut. Rem dolorem aut quis. Dolores omnis et earum consequatur asperiores est vel id. Officiis eos voluptatem et qui unde et esse.",
        "status": "Overdue",
        "is_complete": false,
        "is_overdue": false,
        "is_assigned": true,
        "customer_id": 97,
        "scheduled_user_id": 91,
        "actual_user_id": 92,
        "scheduled_start_at": "2024-10-08T10:52:00.681381Z",
        "scheduled_end_at": "2024-10-08T11:22:00.681383Z",
        "scheduled_duration_minutes": null,
        "scheduled_duration_hours": null,
        "actual_start_at": null,
        "actual_end_at": null,
        "actual_duration_minutes": null,
        "actual_duration_hours": null,
        "arrival_time_at": null,
        "departure_time_at": null,
        "gps_coordinate_start": null,
        "gps_accuracy_start": null,
        "gps_coordinate_end": null,
        "gps_accuracy_end": null,
        "template_id": null,
        "created_at": null,
        "updated_at": null,
        "cancelled_at": null,
        "deleted_at": null
    }
}

Organisation

GET v1/organisation

GET
https://api.zweftly.com
/v1/organisation
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/organisation" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "name": "Price Ltd"
    }
}

Users

GET v1/users

GET
https://api.zweftly.com
/v1/users
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/users" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"group_id\": 16
}"
Example response:
{
    "data": [
        {
            "id": 81,
            "name": "Audra Crooks",
            "forename": "Audra",
            "surname": "Crooks",
            "username": "rempel.chadrick",
            "email": "jdach@example.org",
            "tags": [
                "aut"
            ],
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z"
        },
        {
            "id": 82,
            "name": "Lexus Breitenberg",
            "forename": "Lexus",
            "surname": "Breitenberg",
            "username": "lyric80",
            "email": "hirthe.theo@example.com",
            "tags": [
                "et"
            ],
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/users/{id}

GET
https://api.zweftly.com
/v1/users/{id}
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the user.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/users/1" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": 83,
        "name": "Morgan Hirthe",
        "forename": "Morgan",
        "surname": "Hirthe",
        "username": "dare.emelie",
        "email": "alayna44@example.org",
        "tags": [
            "autem"
        ],
        "created_at": "2024-10-08T10:52:15.000000Z",
        "updated_at": "2024-10-08T10:52:15.000000Z"
    }
}

GET v1/users/{user_id}/availability

GET
https://api.zweftly.com
/v1/users/{user_id}/availability
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

user_id
integer
required

The ID of the user.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/users/1/availability" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "user_id": null,
            "title": "Et et modi ipsum nostrum.",
            "times": [
                {
                    "from": "09:00",
                    "to": "17:00"
                }
            ],
            "start_date": "2024-10-08T10:52:15.000000Z",
            "end_date": null,
            "rrule": "FREQ=DAILY;INTERVAL=1",
            "created_at": null,
            "updated_at": null,
            "deleted_at": null
        },
        {
            "id": null,
            "user_id": null,
            "title": "Voluptatem laboriosam praesentium quis adipisci.",
            "times": [
                {
                    "from": "09:00",
                    "to": "17:00"
                }
            ],
            "start_date": "2024-10-08T10:52:15.000000Z",
            "end_date": null,
            "rrule": "FREQ=DAILY;INTERVAL=1",
            "created_at": null,
            "updated_at": null,
            "deleted_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/users/{user_id}/tasks

GET
https://api.zweftly.com
/v1/users/{user_id}/tasks
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

user_id
integer
required

The ID of the user.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/users/1/tasks" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "title": null,
            "description": null,
            "type_id": null,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": null,
            "title": null,
            "description": null,
            "type_id": null,
            "created_at": null,
            "updated_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/users/{user_id}/notes

GET
https://api.zweftly.com
/v1/users/{user_id}/notes
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

user_id
integer
required

The ID of the user.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/users/1/notes" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "note_type_id": null,
            "body": null,
            "user_id": null,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": null,
            "note_type_id": null,
            "body": null,
            "user_id": null,
            "created_at": null,
            "updated_at": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/users/{user_id}/groups

GET
https://api.zweftly.com
/v1/users/{user_id}/groups
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

user_id
integer
required

The ID of the user.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/users/1/groups" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": 23,
            "name": "Mr.",
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z"
        },
        {
            "id": 24,
            "name": "Miss",
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/users/{user_id}/forms/{form_id}/submission

GET
https://api.zweftly.com
/v1/users/{user_id}/forms/{form_id}/submission
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

user_id
integer
required

The ID of the user.

Example:
1
form_id
integer
required

The ID of the form.

Example:
16
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/users/1/forms/16/submission" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": null,
        "form_id": null,
        "answers": null,
        "created_at": null,
        "updated_at": null,
        "deleted_at": null
    }
}

GET v1/groups

GET
https://api.zweftly.com
/v1/groups
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/groups" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": 25,
            "name": "Mr.",
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z"
        },
        {
            "id": 26,
            "name": "Miss",
            "created_at": "2024-10-08T10:52:15.000000Z",
            "updated_at": "2024-10-08T10:52:15.000000Z"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "/",
        "per_page": 100,
        "to": 2
    }
}

GET v1/groups/{id}

GET
https://api.zweftly.com
/v1/groups/{id}
requires authentication

Headers

Authorization
Example:
Bearer YOUR_API_KEY
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the group.

Example:
1
Example request: 
curl --request GET \
    --get "https://api.zweftly.com/v1/groups/1" \
    --header "Authorization: Bearer YOUR_API_KEY" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": {
        "id": 27,
        "name": "Mr.",
        "created_at": "2024-10-08T10:52:15.000000Z",
        "updated_at": "2024-10-08T10:52:15.000000Z"
    }
}