The Orbit4 API

Introduction

Base URL: https://api.orbit4.org

The Orbit4 API is a public-facing API intended to be used by Orbit4 partners to enable their customers to use the Orbit4 platform while ensuring seamless data synchronization with their respective systems.

This API is structured according to key RESTful principles, selectively incorporating guidelines from the JSON API Specification. We accept request data for POST and PUT methods in two formats: application/x-www-form-urlencoded and application/json. Every response from the API, including error notifications, is formatted in JSON.

When errors occur, they are signaled through a specific HTTP status code accompanied by an error object in the response. This object contains a distinctive error code as a string and a user-friendly message, designed to be easily understood by end users.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

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

You can retrieve your token by navigating to the API Tokens section within your profile menu and then clicking on Generate API Token.

Assets

The following set of endpoints are engineered for efficient management of your clubs' asset registers on the Orbit4 platform. They simplify the process of creating, updating, and even deleting assets that are no longer needed within your gym operator accounts. The main purpose of these operations is facilitating the synchronization of your system's assets with Orbit4.

Search for assets.

GET

https://api.orbit4.org

/v1/assets

requires authentication

This endpoint allows you to search for assets within the specified gym operator account. You can filter the results by club specifying the user_id and other optional parameters.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

Query Parameters

user_id

integer

required

The ID of the gym operator the assets belong to.

Example:

string

Search for assets by qr_code, brand, range, or product name.

qr_code

string

Filter assets by qr code.

sort

string

Results can be sorted by the following fields:

id
qr_code
installation_date
manufacturing_date
warranty_end_date
created_at

The default sorting order is ascending, but the direction can be reversed by prefixing a dash (-) like so: ?sort=-id

metadata[metadata_key]

string

Filter results by metadata. Replace metadata_key with the key of the metadata you want to filter by.

page

integer

The page number of results to be returned.

per_page

integer

The number of results to be returned for each page of results.

Response Fields

data

array

An array of paginated items.

object

An object representing a paginated item.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

links

object

Pagination links.

meta

object

Pagination meta data.

current_page

integer

Current page number.

from

integer

Starting record number.

last_page

integer

Last page number.

links

array

An array of links.

path

integer

The path of the request.

per_page

integer

Records per page.

integer

Ending record number.

total

integer

Total number of records.

Example request:

curl --request GET \
    --get "https://api.orbit4.org/v1/assets?user_id=2" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 53

{
    "data": [
        {
            "id": 1,
            "brand": "Hammer Strength",
            "range": "Plateloaded Iso-Lateral",
            "product": "Seated Leg Press",
            "product_id": 5,
            "qr_code": "O4-513",
            "serial_number": "MSN-603",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£5,964.15",
            "fitness_product": 0,
            "has_odometer": 1,
            "residual_price": "£247.91",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 2,
            "brand": "Hammer Strength",
            "range": "Plateloaded Iso-Lateral",
            "product": "Seated Leg Press",
            "product_id": 5,
            "qr_code": "O4-927",
            "serial_number": "MSN-321",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£4,753.35",
            "fitness_product": 0,
            "has_odometer": 0,
            "residual_price": "£247.91",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 3,
            "brand": "Hammer Strength",
            "range": "Plateloaded Iso-Lateral",
            "product": "Seated Leg Press",
            "product_id": 5,
            "qr_code": "O4-247",
            "serial_number": "MSN-238",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£5,828.42",
            "fitness_product": 0,
            "has_odometer": 0,
            "residual_price": "£247.91",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 4,
            "brand": "Precor",
            "range": "C-Line Strength",
            "product": "Chest Press",
            "product_id": 3,
            "qr_code": "O4-043",
            "serial_number": "MSN-124",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£4,104.03",
            "fitness_product": 0,
            "has_odometer": 0,
            "residual_price": "£913.95",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 5,
            "brand": "Life Fitness",
            "range": "IC7 Spin Bike",
            "product": "Studio Bike",
            "product_id": 1,
            "qr_code": "O4-427",
            "serial_number": "MSN-719",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£5,609.74",
            "fitness_product": 0,
            "has_odometer": 1,
            "residual_price": "£575.32",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 6,
            "brand": "Technogym",
            "range": "Excite JOG 700 LED",
            "product": "Treadmill",
            "product_id": 4,
            "qr_code": "O4-923",
            "serial_number": "MSN-717",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£4,368.87",
            "fitness_product": 1,
            "has_odometer": 1,
            "residual_price": "£334.10",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 7,
            "brand": "Hammer Strength",
            "range": "Plateloaded Iso-Lateral",
            "product": "Seated Leg Press",
            "product_id": 5,
            "qr_code": "O4-748",
            "serial_number": "MSN-015",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£3,570.45",
            "fitness_product": 1,
            "has_odometer": 0,
            "residual_price": "£247.91",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 8,
            "brand": "Technogym",
            "range": "Excite JOG 700 LED",
            "product": "Treadmill",
            "product_id": 4,
            "qr_code": "O4-081",
            "serial_number": "MSN-585",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£6,773.51",
            "fitness_product": 1,
            "has_odometer": 0,
            "residual_price": "£334.10",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 9,
            "brand": "Hammer Strength",
            "range": "Plateloaded Iso-Lateral",
            "product": "Seated Leg Press",
            "product_id": 5,
            "qr_code": "O4-429",
            "serial_number": "MSN-628",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£5,982.36",
            "fitness_product": 0,
            "has_odometer": 0,
            "residual_price": "£247.91",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 10,
            "brand": "Precor",
            "range": "C-Line Strength",
            "product": "Chest Press",
            "product_id": 3,
            "qr_code": "O4-538",
            "serial_number": "MSN-174",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£2,267.24",
            "fitness_product": 1,
            "has_odometer": 1,
            "residual_price": "£913.95",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        }
    ],
    "links": {
        "first": "https://api.orbit4.org/v1/assets?page=1",
        "last": "https://api.orbit4.org/v1/assets?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://api.orbit4.org/v1/assets?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://api.orbit4.org/v1/assets",
        "per_page": 25,
        "to": 10,
        "total": 10
    }
}

Fetch asset details.

GET

https://api.orbit4.org

/v1/assets/{asset}

requires authentication

This endpoint allows you to retrieve details of a specific asset by their ID.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

URL Parameters

asset

string

required

The ID of the asset.

Example:

Response Fields

data

object

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

Example request:

curl --request GET \
    --get "https://api.orbit4.org/v1/assets/2" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 52

{
    "data": {
        "id": 2,
        "brand": "Hammer Strength",
        "range": "Plateloaded Iso-Lateral",
        "product": "Seated Leg Press",
        "product_id": 5,
        "qr_code": "O4-927",
        "serial_number": "MSN-321",
        "installation_date": "20/01/2022",
        "manufacturing_date": "20/01/2021",
        "warranty_end_date": "20/01/2027",
        "current_spend": "£0",
        "max_spend": "£4,753.35",
        "fitness_product": 0,
        "has_odometer": 0,
        "residual_price": "£247.91",
        "image": null,
        "metadata": [],
        "created_at": "2025-01-20T19:58:18+00:00"
    }
}

Create new asset.

POST

https://api.orbit4.org

/v1/assets

requires authentication

This endpoint allows you to add a new asset to the gym operator account. The user_id must be specified when adding a new asset.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

Body Parameters

user_id

integer

required

The ID of the gym operator the assets belong to.

Example:

qr_code

string

required

The qr code number used on the sticker of the equipment.

Example:

O4-123456

serial_number

string

The manufacturer serial number of the equipment.

Example:

123456

installation_date

string

The installation date of the equipment.

Example:

2025-01-20

manufacturing_date

string

The manufacturing date of the equipment.

Example:

2025-01-20

warranty_end_date

string

The warranty end date of the equipment.

Example:

2025-01-20

brand

string

The brand of the equipment. This field will be automatically populated if the product_id is provided.

Example:

Life Fitness

range

string

The model/range of the equipment. This field will be automatically populated if the product_id is provided.

Example:

Signature Series

product

string

The name of the equipment. This field will be automatically populated if the product_id is provided.

Example:

Chest Press

product_id

integer

The ID of the equipment in the Orbit4 database.

Example:

metadata

string

A JSON object with metadata, which can be used for filtering. This will also be included in API responses and webhook payloads.

Example:

{"integration_id":"ABC123"}

Response Fields

data

object

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

Example request:

curl --request POST \
    "https://api.orbit4.org/v1/assets" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json" \
    --data "{
    \"user_id\": 2,
    \"qr_code\": \"O4-123456\",
    \"serial_number\": \"123456\",
    \"installation_date\": \"2025-01-20\",
    \"manufacturing_date\": \"2025-01-20\",
    \"warranty_end_date\": \"2025-01-20\",
    \"brand\": \"Life Fitness\",
    \"range\": \"Signature Series\",
    \"product\": \"Chest Press\",
    \"product_id\": 1,
    \"metadata\": \"{\\\"integration_id\\\":\\\"ABC123\\\"}\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 51

{
    "data": {
        "id": 16,
        "brand": "Life Fitness",
        "range": "IC7 Spin Bike",
        "product": "Studio Bike",
        "product_id": 1,
        "qr_code": "O4-123456",
        "serial_number": "123456",
        "installation_date": "20/01/2025",
        "manufacturing_date": "20/01/2025",
        "warranty_end_date": "20/01/2025",
        "current_spend": "£0",
        "max_spend": "£0",
        "fitness_product": null,
        "has_odometer": null,
        "residual_price": "£412.16",
        "image": null,
        "metadata": {
            "integration_id": "ABC123"
        },
        "created_at": "2025-01-20T19:58:19+00:00"
    }
}

Update asset.

PUT

https://api.orbit4.org

/v1/assets/{asset}

requires authentication

This endpoint allows you to update details of a specific asset by their ID. Only the fields that need to be updated should be provided.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

URL Parameters

asset

string

required

The ID of the asset.

Example:

Body Parameters

qr_code

string

The qr code number used on the sticker of the equipment.

Example:

O4-123456

serial_number

string

The manufacturer serial number of the equipment.

Example:

123456

installation_date

string

The installation date of the equipment.

Example:

2025-01-20

manufacturing_date

string

The manufacturing date of the equipment.

Example:

2025-01-20

warranty_end_date

string

The warranty end date of the equipment.

Example:

2025-01-20

brand

string

The brand of the equipment. This field will be automatically populated if the product_id is provided.

Example:

Life Fitness

range

string

The model/range of the equipment. This field will be automatically populated if the product_id is provided.

Example:

Signature Series

product

string

The name of the equipment. This field will be automatically populated if the product_id is provided.

Example:

Chest Press

product_id

integer

The ID of the equipment in the Orbit4 database.

Example:

metadata

string

A JSON object with metadata, which can be used for filtering. This will also be included in API responses and webhook payloads.

Example:

{"integration_id":"ABC123"}

Response Fields

data

object

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

Example request:

curl --request PUT \
    "https://api.orbit4.org/v1/assets/2" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json" \
    --data "{
    \"qr_code\": \"O4-123456\",
    \"serial_number\": \"123456\",
    \"installation_date\": \"2025-01-20\",
    \"manufacturing_date\": \"2025-01-20\",
    \"warranty_end_date\": \"2025-01-20\",
    \"brand\": \"Life Fitness\",
    \"range\": \"Signature Series\",
    \"product\": \"Chest Press\",
    \"product_id\": 1,
    \"metadata\": \"{\\\"integration_id\\\":\\\"ABC123\\\"}\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 50

{
    "data": {
        "id": 2,
        "brand": "Life Fitness",
        "range": "IC7 Spin Bike",
        "product": "Studio Bike",
        "product_id": 1,
        "qr_code": "O4-123456",
        "serial_number": "123456",
        "installation_date": "20/01/2025",
        "manufacturing_date": "20/01/2025",
        "warranty_end_date": "20/01/2025",
        "current_spend": "£0",
        "max_spend": "£4,753.35",
        "fitness_product": 0,
        "has_odometer": 0,
        "residual_price": "£412.16",
        "image": null,
        "metadata": {
            "integration_id": "ABC123"
        },
        "created_at": "2025-01-20T19:58:18+00:00"
    }
}

Delete asset.

DELETE

https://api.orbit4.org

/v1/assets/{asset}

requires authentication

This endpoint allows you to delete a specific asset from your account by their ID.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

URL Parameters

asset

string

required

The ID of the asset.

Example:

Example request:

curl --request DELETE \
    "https://api.orbit4.org/v1/assets/2" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 49

[Empty response]

Contracts

The following set of endpoints are designed to facilitate the management of your service contracts between your gym operators and service providers on the Orbit4 platform. They simplify the process of searching and creating contracts.

Search for contracts.

GET

https://api.orbit4.org

/v1/contracts

requires authentication

This endpoint allows you to search for contracts within the specified user account. You can filter the results by gym operator, service provider or a specific asset.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

Query Parameters

gym_operator_id

integer

The ID of the gym operator the service contract belong to.

Example:

service_provider_id

integer

The ID of the service provider the service contract belong to.

Example:

asset_id

integer

The ID of asset to filter contracts by.

Example:

active

boolean

Filter results by active/expired contracts.

Example:

sort

string

Results can be sorted by the following fields:

id
start_date
created_at

The default sorting order is ascending, but the direction can be reversed by prefixing a dash (-) like so: ?sort=-id

metadata[metadata_key]

string

Filter results by metadata. Replace metadata_key with the key of the metadata you want to filter by.

page

integer

The page number of results to be returned.

per_page

integer

The number of results to be returned for each page of results.

Response Fields

data

array

An array of paginated items.

object

An object representing a paginated item.

integer

The unique identifier for the contract within the Orbit4 system.

number

string

A user friendly identifier for the contract.

type

string

The type of contract.

gym_operator

object

An object representing the gym operator linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

service_provider

object

An object representing the service provider linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

active

boolean

A boolean indicating whether the contract is currently active.

start_date

string

The date the contract starts.

end_date

string

The date the contract ends.

items

array

An array of the assets included in the contract.

object

An object representing an asset.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

links

object

Pagination links.

meta

object

Pagination meta data.

current_page

integer

Current page number.

from

integer

Starting record number.

last_page

integer

Last page number.

links

array

An array of links.

path

integer

The path of the request.

per_page

integer

Records per page.

integer

Ending record number.

total

integer

Total number of records.

Example request:

curl --request GET \
    --get "https://api.orbit4.org/v1/contracts?gym_operator_id=2&service_provider_id=4&asset_id=1&active=1" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 48

{
    "data": [
        {
            "id": 1,
            "number": "WSGE123",
            "type": "",
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "active": true,
            "start_date": "2025-01-19",
            "end_date": "2026-01-19",
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        }
    ],
    "links": {
        "first": "https://api.orbit4.org/v1/contracts?page=1",
        "last": "https://api.orbit4.org/v1/contracts?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://api.orbit4.org/v1/contracts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://api.orbit4.org/v1/contracts",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}

Create new contract.

POST

https://api.orbit4.org

/v1/contracts

requires authentication

This endpoint allows you to create a new contract between a gym operator and a service provider.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

Body Parameters

gym_operator_id

integer

required

The ID of the gym operator the service contract belong to.

Example:

service_provider_id

integer

required

The ID of the service provider the service contract belong to.

Example:

start_date

string

required

The date the service contract becomes active. The end date will be a year from this date.

Example:

2025-01-20

type

string

required

The type of service contract.

Must be one of:

Full Annual
Labour only
One-Off Service – Labour Only
Adhoc Call-Out
Lease

Example:

Full Annual

assets

array

An array of assets included in this contract. The assets must belong to the specified gym operator.

metadata

string

A JSON object with metadata, which can be used for filtering. This will also be included in API responses and webhook payloads.

Example:

{"integration_id":"ABC123"}

Response Fields

data

object

integer

The unique identifier for the contract within the Orbit4 system.

number

string

A user friendly identifier for the contract.

type

string

The type of contract.

gym_operator

object

An object representing the gym operator linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

service_provider

object

An object representing the service provider linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

active

boolean

A boolean indicating whether the contract is currently active.

start_date

string

The date the contract starts.

end_date

string

The date the contract ends.

items

array

An array of the assets included in the contract.

object

An object representing an asset.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

Example request:

curl --request POST \
    "https://api.orbit4.org/v1/contracts" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json" \
    --data "{
    \"gym_operator_id\": 2,
    \"service_provider_id\": 3,
    \"start_date\": \"2025-01-20\",
    \"type\": \"Full Annual\",
    \"assets\": [
        1
    ],
    \"metadata\": \"{\\\"integration_id\\\":\\\"ABC123\\\"}\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 47

{
    "data": {
        "id": 2,
        "number": "WSGE1",
        "type": "Full Annual",
        "gym_operator": {
            "id": 2,
            "first_name": "Jett",
            "last_name": "Ziemann",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": {
                "id": 1,
                "name": "PulseForge Fitness",
                "address": "9409 Katelynn Circle",
                "address_2": null,
                "address_3": null,
                "city": "North Wilburnland",
                "country": "UK",
                "postcode": "40117-2392",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": "London Bridge",
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "service_provider": {
            "id": 3,
            "first_name": "Mason",
            "last_name": "Terry",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": {
                "id": 1,
                "name": "PulseForge Fitness",
                "address": "9409 Katelynn Circle",
                "address_2": null,
                "address_3": null,
                "city": "North Wilburnland",
                "country": "UK",
                "postcode": "40117-2392",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": "Notthing Hill Gate",
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "active": true,
        "start_date": "2025-01-20",
        "end_date": "2026-01-20",
        "metadata": {
            "integration_id": "ABC123"
        },
        "created_at": "2025-01-20T19:58:19+00:00"
    }
}

Fetch contract details.

GET

https://api.orbit4.org

/v1/contracts/{contract}

requires authentication

This endpoint allows you to retrieve details of a specific contract by their ID.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

URL Parameters

contract

string

required

The ID of the contract.

Example:

Response Fields

data

object

integer

The unique identifier for the contract within the Orbit4 system.

number

string

A user friendly identifier for the contract.

type

string

The type of contract.

gym_operator

object

An object representing the gym operator linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

service_provider

object

An object representing the service provider linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

active

boolean

A boolean indicating whether the contract is currently active.

start_date

string

The date the contract starts.

end_date

string

The date the contract ends.

items

array

An array of the assets included in the contract.

object

An object representing an asset.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

Example request:

curl --request GET \
    --get "https://api.orbit4.org/v1/contracts/1" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 46

{
    "data": {
        "id": 1,
        "number": "WSGE123",
        "type": "",
        "gym_operator": {
            "id": 2,
            "first_name": "Jett",
            "last_name": "Ziemann",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": {
                "id": 1,
                "name": "PulseForge Fitness",
                "address": "9409 Katelynn Circle",
                "address_2": null,
                "address_3": null,
                "city": "North Wilburnland",
                "country": "UK",
                "postcode": "40117-2392",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": "London Bridge",
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "service_provider": {
            "id": 4,
            "first_name": "Roslyn",
            "last_name": "Conn",
            "email": "[email protected]",
            "role": "service_provider",
            "company": {
                "id": 2,
                "name": "The Gym Fixers",
                "address": "2072 Lemke Ports Apt. 534",
                "address_2": null,
                "address_3": null,
                "city": "Port Herta",
                "country": "UK",
                "postcode": "04103-3783",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": null,
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "active": true,
        "start_date": "2025-01-19",
        "end_date": "2026-01-19",
        "assets": [
            {
                "id": 1,
                "brand": "Hammer Strength",
                "range": "Plateloaded Iso-Lateral",
                "product": "Seated Leg Press",
                "product_id": 5,
                "qr_code": "O4-513",
                "serial_number": "MSN-603",
                "installation_date": "20/01/2022",
                "manufacturing_date": "20/01/2021",
                "warranty_end_date": "20/01/2027",
                "current_spend": "£0",
                "max_spend": "£5,964.15",
                "fitness_product": 0,
                "has_odometer": 1,
                "residual_price": "£247.91",
                "image": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 2,
                "brand": "Hammer Strength",
                "range": "Plateloaded Iso-Lateral",
                "product": "Seated Leg Press",
                "product_id": 5,
                "qr_code": "O4-927",
                "serial_number": "MSN-321",
                "installation_date": "20/01/2022",
                "manufacturing_date": "20/01/2021",
                "warranty_end_date": "20/01/2027",
                "current_spend": "£0",
                "max_spend": "£4,753.35",
                "fitness_product": 0,
                "has_odometer": 0,
                "residual_price": "£247.91",
                "image": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 3,
                "brand": "Hammer Strength",
                "range": "Plateloaded Iso-Lateral",
                "product": "Seated Leg Press",
                "product_id": 5,
                "qr_code": "O4-247",
                "serial_number": "MSN-238",
                "installation_date": "20/01/2022",
                "manufacturing_date": "20/01/2021",
                "warranty_end_date": "20/01/2027",
                "current_spend": "£0",
                "max_spend": "£5,828.42",
                "fitness_product": 0,
                "has_odometer": 0,
                "residual_price": "£247.91",
                "image": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 4,
                "brand": "Precor",
                "range": "C-Line Strength",
                "product": "Chest Press",
                "product_id": 3,
                "qr_code": "O4-043",
                "serial_number": "MSN-124",
                "installation_date": "20/01/2022",
                "manufacturing_date": "20/01/2021",
                "warranty_end_date": "20/01/2027",
                "current_spend": "£0",
                "max_spend": "£4,104.03",
                "fitness_product": 0,
                "has_odometer": 0,
                "residual_price": "£913.95",
                "image": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 5,
                "brand": "Life Fitness",
                "range": "IC7 Spin Bike",
                "product": "Studio Bike",
                "product_id": 1,
                "qr_code": "O4-427",
                "serial_number": "MSN-719",
                "installation_date": "20/01/2022",
                "manufacturing_date": "20/01/2021",
                "warranty_end_date": "20/01/2027",
                "current_spend": "£0",
                "max_spend": "£5,609.74",
                "fitness_product": 0,
                "has_odometer": 1,
                "residual_price": "£575.32",
                "image": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 6,
                "brand": "Technogym",
                "range": "Excite JOG 700 LED",
                "product": "Treadmill",
                "product_id": 4,
                "qr_code": "O4-923",
                "serial_number": "MSN-717",
                "installation_date": "20/01/2022",
                "manufacturing_date": "20/01/2021",
                "warranty_end_date": "20/01/2027",
                "current_spend": "£0",
                "max_spend": "£4,368.87",
                "fitness_product": 1,
                "has_odometer": 1,
                "residual_price": "£334.10",
                "image": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 7,
                "brand": "Hammer Strength",
                "range": "Plateloaded Iso-Lateral",
                "product": "Seated Leg Press",
                "product_id": 5,
                "qr_code": "O4-748",
                "serial_number": "MSN-015",
                "installation_date": "20/01/2022",
                "manufacturing_date": "20/01/2021",
                "warranty_end_date": "20/01/2027",
                "current_spend": "£0",
                "max_spend": "£3,570.45",
                "fitness_product": 1,
                "has_odometer": 0,
                "residual_price": "£247.91",
                "image": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 8,
                "brand": "Technogym",
                "range": "Excite JOG 700 LED",
                "product": "Treadmill",
                "product_id": 4,
                "qr_code": "O4-081",
                "serial_number": "MSN-585",
                "installation_date": "20/01/2022",
                "manufacturing_date": "20/01/2021",
                "warranty_end_date": "20/01/2027",
                "current_spend": "£0",
                "max_spend": "£6,773.51",
                "fitness_product": 1,
                "has_odometer": 0,
                "residual_price": "£334.10",
                "image": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 9,
                "brand": "Hammer Strength",
                "range": "Plateloaded Iso-Lateral",
                "product": "Seated Leg Press",
                "product_id": 5,
                "qr_code": "O4-429",
                "serial_number": "MSN-628",
                "installation_date": "20/01/2022",
                "manufacturing_date": "20/01/2021",
                "warranty_end_date": "20/01/2027",
                "current_spend": "£0",
                "max_spend": "£5,982.36",
                "fitness_product": 0,
                "has_odometer": 0,
                "residual_price": "£247.91",
                "image": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 10,
                "brand": "Precor",
                "range": "C-Line Strength",
                "product": "Chest Press",
                "product_id": 3,
                "qr_code": "O4-538",
                "serial_number": "MSN-174",
                "installation_date": "20/01/2022",
                "manufacturing_date": "20/01/2021",
                "warranty_end_date": "20/01/2027",
                "current_spend": "£0",
                "max_spend": "£2,267.24",
                "fitness_product": 1,
                "has_odometer": 1,
                "residual_price": "£913.95",
                "image": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            }
        ],
        "metadata": [],
        "created_at": "2025-01-20T19:58:18+00:00"
    }
}

Media

The following set of endpoints are designed to facilitate the management of media files within the different resources.

Upload media.

POST

https://api.orbit4.org

/v1/media

requires authentication

This endpoint allows you to upload media files to the specified resource. Some media types are single-use, meaning that only one media file can be uploaded for that type on that resource. If a media file already exists for the specified type, it will be replaced with the new one.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Body Parameters

type

string

required

The type of media to be uploaded.

Must be one of:

image
audio
video
quote
worksheet
purchase_order
invoice

Example:

image

file

required

The file being uploaded.

Example:

/tmp/phpoMlo2n

resource_id

integer

required

The ID of the resource the media is being uploaded for.

Example:

resource_type

string

required

The type of resource the media is being uploaded for.

Must be one of:

asset
ticket

Example:

ticket

Response Fields

data

object

Example request:

curl --request POST \
    "https://api.orbit4.org/v1/media" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --form "type=image"\
    --form "resource_id=1"\
    --form "resource_type=ticket"\
    --form "file=@/tmp/phpoMlo2n"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 40

{
    "data": {
        "id": 3,
        "url": "https://cdn.orbit4.org/uploads/32990678eaadc7df784.95312653.jpg",
        "type": "image",
        "extra_properties": null,
        "created_at": "2025-01-20T19:58:20+00:00"
    }
}

Update media extra properties.

PUT

https://api.orbit4.org

/v1/media/{media}

requires authentication

This endpoint allows you to upload media metadata to the specified resource.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

URL Parameters

media

string

required

The ID of the media file.

Example:

Body Parameters

extra_properties

object

required

The extra properties to be updated.

Example:

{"approved":true}

Response Fields

data

object

Example request:

curl --request PUT \
    "https://api.orbit4.org/v1/media/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"extra_properties\": \"{\\\"approved\\\":true}\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 39

{
    "data": {
        "id": 2,
        "url": "https://cdn.orbit4.org/uploads/quote.pdf",
        "type": "quote",
        "extra_properties": {
            "approved": true
        },
        "created_at": "2025-01-20T19:58:19+00:00"
    }
}

Notes

The following set of endpoints are designed to facilitate the management of ticket notes. accounts.

Create ticket note.

POST

https://api.orbit4.org

/v1/notes

requires authentication

This endpoint allows you to create a new note for the specified ticket.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

Body Parameters

user_id

integer

required

The ID of the author of the note.

Example:

ticket_id

integer

required

The ID of the ticket the note is added to.

Example:

note

string

required

The message of the note.

Example:

Can you please provide more details about the issue?

Response Fields

data

object

integer

The unique identifier for the note within the Orbit4 system.

user

object

An object representing the user who sent the note.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

note

string

The content of the note.

is_system

boolean

A boolean indicating whether the note was generated by the system.

created_at

string

The date and time the note was created.

Example request:

curl --request POST \
    "https://api.orbit4.org/v1/notes" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json" \
    --data "{
    \"user_id\": 2,
    \"ticket_id\": 1,
    \"note\": \"Can you please provide more details about the issue?\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 41

{
    "data": {
        "id": 10,
        "user": {
            "id": 2,
            "first_name": "Jett",
            "last_name": "Ziemann",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": {
                "id": 1,
                "name": "PulseForge Fitness",
                "address": "9409 Katelynn Circle",
                "address_2": null,
                "address_3": null,
                "city": "North Wilburnland",
                "country": "UK",
                "postcode": "40117-2392",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": "London Bridge",
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "note": "Can you please provide more details about the issue?",
        "is_system": false,
        "created_at": "2025-01-20T19:58:20+00:00"
    }
}

Tickets

The following set of endpoints are designed to facilitate the management of tickets within your different user accounts. They allow you to search for tickets, fetch specific ticket details, create new tickets, update ticket details, and even change tickets' status. The main purpose of these operations is facilitating the synchronization of your system's tickets with Orbit4.

Search for tickets.

GET

https://api.orbit4.org

/v1/tickets

requires authentication

This endpoint allows you to search for tickets based on specified criteria. The search results will include all tickets that match the criteria.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

Query Parameters

user_id

integer

The ID of the user for whom the tickets are being fetched.

Example:

string

Search for tickets by ticket_number or description.

type

string

Filter tickets by their type.

Must be one of:

standard
ad-hoc
internal
service

status

string

Filter tickets by their status.

Must be one of:

open
parts_required
engineer_deployed
closed

sort

string

Results can be sorted by the following fields:

id
ticket_number
status
created_at

The default sorting order is ascending, but the direction can be reversed by prefixing a dash (-) like so: ?sort=-id

metadata[metadata_key]

string

Filter results by metadata. Replace metadata_key with the key of the metadata you want to filter by.

page

integer

The page number of results to be returned.

per_page

integer

The number of results to be returned for each page of results.

Response Fields

data

array

An array of paginated items.

object

An object representing a paginated item.

integer

The unique identifier for the ticket within the Orbit4 system.

number

string

A user friendly identifier for the ticket.

type

string

The type of ticket.

description

string

A description of the issue.

priority

string

The priority of the ticket based on the state of the equipment.

status

string

The current status of the ticket.

engineer_arrived_at

string

The date and time the engineer arrived at the location.

engineer_deployed_at

string

The date and time the engineer was deployed to the location.

closed_at

string

The date and time the ticket was closed.

service_provider

object

An object representing the service provider linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

gym_operator

object

An object representing the gym operator linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

ticket_admin

object

An object representing the ticket admin linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

engineer

object

An object representing the engineer linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

caretaker

object

An object representing the caretaker linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

asset

object

An object representing the asset linked to the ticket.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

contract

object

An object representing the contract linked to the ticket.

integer

The unique identifier for the contract within the Orbit4 system.

number

string

A user friendly identifier for the contract.

type

string

The type of contract.

gym_operator

object

An object representing the gym operator linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

service_provider

object

An object representing the service provider linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

active

boolean

A boolean indicating whether the contract is currently active.

start_date

string

The date the contract starts.

end_date

string

The date the contract ends.

items

array

An array of the assets included in the contract.

object

An object representing an asset.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

media

array

An array of objects representing the media linked to the ticket.

object

An object representing an piece of media.

images

array

An array of objects representing the images linked to the ticket.

object

An object representing an image.

notes

array

An array of objects representing the notes linked to the ticket.

object

An object representing a note.

integer

The unique identifier for the note within the Orbit4 system.

user

object

An object representing the user who sent the note.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

note

string

The content of the note.

is_system

boolean

A boolean indicating whether the note was generated by the system.

created_at

string

The date and time the note was created.

created_at

string

The date and time the ticket was created.

links

object

Pagination links.

meta

object

Pagination meta data.

current_page

integer

Current page number.

from

integer

Starting record number.

last_page

integer

Last page number.

links

array

An array of links.

path

integer

The path of the request.

per_page

integer

Records per page.

integer

Ending record number.

total

integer

Total number of records.

Example request:

curl --request GET \
    --get "https://api.orbit4.org/v1/tickets?user_id=2" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 45

{
    "data": [
        {
            "id": 1,
            "number": "WSGE123-001",
            "type": "standard",
            "description": null,
            "priority": "Faulty",
            "status": "open",
            "engineer_arrived_at": null,
            "engineer_deployed_at": null,
            "closed_at": null,
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": {
                "id": 1,
                "number": "WSGE123",
                "type": "",
                "gym_operator": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "service_provider": {
                    "id": 4,
                    "first_name": "Roslyn",
                    "last_name": "Conn",
                    "email": "[email protected]",
                    "role": "service_provider",
                    "company": {
                        "id": 2,
                        "name": "The Gym Fixers",
                        "address": "2072 Lemke Ports Apt. 534",
                        "address_2": null,
                        "address_3": null,
                        "city": "Port Herta",
                        "country": "UK",
                        "postcode": "04103-3783",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "active": true,
                "start_date": "2025-01-19",
                "end_date": "2026-01-19",
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            "media": [],
            "images": [],
            "notes": [
                {
                    "id": 1,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:18+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 2,
            "number": "WSGE123-002",
            "type": "standard",
            "description": null,
            "priority": "Faulty",
            "status": "open",
            "engineer_arrived_at": null,
            "engineer_deployed_at": null,
            "closed_at": null,
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": {
                "id": 1,
                "number": "WSGE123",
                "type": "",
                "gym_operator": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "service_provider": {
                    "id": 4,
                    "first_name": "Roslyn",
                    "last_name": "Conn",
                    "email": "[email protected]",
                    "role": "service_provider",
                    "company": {
                        "id": 2,
                        "name": "The Gym Fixers",
                        "address": "2072 Lemke Ports Apt. 534",
                        "address_2": null,
                        "address_3": null,
                        "city": "Port Herta",
                        "country": "UK",
                        "postcode": "04103-3783",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "active": true,
                "start_date": "2025-01-19",
                "end_date": "2026-01-19",
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            "media": [
                {
                    "id": 1,
                    "url": "https://cdn.orbit4.org/uploads/image.jpg",
                    "type": "image",
                    "extra_properties": null,
                    "created_at": "2025-01-20T19:58:19+00:00"
                }
            ],
            "images": [
                {
                    "id": 1,
                    "url": "https://cdn.orbit4.org/uploads/image.jpg",
                    "type": "image",
                    "extra_properties": null,
                    "created_at": "2025-01-20T19:58:19+00:00"
                }
            ],
            "notes": [
                {
                    "id": 2,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:18+00:00"
                },
                {
                    "id": 8,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Hey, this machine is now totally out of use. Can you come today?",
                    "is_system": false,
                    "created_at": "2025-01-20T19:58:19+00:00"
                },
                {
                    "id": 9,
                    "user": {
                        "id": 4,
                        "first_name": "Roslyn",
                        "last_name": "Conn",
                        "email": "[email protected]",
                        "role": "service_provider",
                        "company": {
                            "id": 2,
                            "name": "The Gym Fixers",
                            "address": "2072 Lemke Ports Apt. 534",
                            "address_2": null,
                            "address_3": null,
                            "city": "Port Herta",
                            "country": "UK",
                            "postcode": "04103-3783",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": null,
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Sure, no problem, I'll deploy one of my technicians out to you now.",
                    "is_system": false,
                    "created_at": "2025-01-20T19:58:19+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 3,
            "number": "WSGE123-003",
            "type": "standard",
            "description": null,
            "priority": "Faulty",
            "status": "open",
            "engineer_arrived_at": null,
            "engineer_deployed_at": null,
            "closed_at": null,
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": {
                "id": 1,
                "number": "WSGE123",
                "type": "",
                "gym_operator": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "service_provider": {
                    "id": 4,
                    "first_name": "Roslyn",
                    "last_name": "Conn",
                    "email": "[email protected]",
                    "role": "service_provider",
                    "company": {
                        "id": 2,
                        "name": "The Gym Fixers",
                        "address": "2072 Lemke Ports Apt. 534",
                        "address_2": null,
                        "address_3": null,
                        "city": "Port Herta",
                        "country": "UK",
                        "postcode": "04103-3783",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "active": true,
                "start_date": "2025-01-19",
                "end_date": "2026-01-19",
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            "media": [],
            "images": [],
            "notes": [
                {
                    "id": 3,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:18+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 4,
            "number": "WSGE123-004",
            "type": "standard",
            "description": null,
            "priority": "Faulty",
            "status": "engineer_deployed",
            "engineer_arrived_at": null,
            "engineer_deployed_at": "2025-01-20T19:58:18+00:00",
            "closed_at": null,
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": {
                "id": 1,
                "number": "WSGE123",
                "type": "",
                "gym_operator": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "service_provider": {
                    "id": 4,
                    "first_name": "Roslyn",
                    "last_name": "Conn",
                    "email": "[email protected]",
                    "role": "service_provider",
                    "company": {
                        "id": 2,
                        "name": "The Gym Fixers",
                        "address": "2072 Lemke Ports Apt. 534",
                        "address_2": null,
                        "address_3": null,
                        "city": "Port Herta",
                        "country": "UK",
                        "postcode": "04103-3783",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "active": true,
                "start_date": "2025-01-19",
                "end_date": "2026-01-19",
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            "media": [],
            "images": [],
            "notes": [
                {
                    "id": 4,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:18+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 5,
            "number": "WSGE123-005",
            "type": "standard",
            "description": null,
            "priority": "Faulty",
            "status": "parts_required",
            "engineer_arrived_at": null,
            "engineer_deployed_at": null,
            "closed_at": null,
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": {
                "id": 1,
                "number": "WSGE123",
                "type": "",
                "gym_operator": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "service_provider": {
                    "id": 4,
                    "first_name": "Roslyn",
                    "last_name": "Conn",
                    "email": "[email protected]",
                    "role": "service_provider",
                    "company": {
                        "id": 2,
                        "name": "The Gym Fixers",
                        "address": "2072 Lemke Ports Apt. 534",
                        "address_2": null,
                        "address_3": null,
                        "city": "Port Herta",
                        "country": "UK",
                        "postcode": "04103-3783",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "active": true,
                "start_date": "2025-01-19",
                "end_date": "2026-01-19",
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            "media": [],
            "images": [],
            "notes": [
                {
                    "id": 5,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:18+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        {
            "id": 6,
            "number": "WSGE123-006",
            "type": "standard",
            "description": null,
            "priority": "Faulty",
            "status": "closed",
            "engineer_arrived_at": null,
            "engineer_deployed_at": null,
            "closed_at": "2025-01-20T19:58:18+00:00",
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": {
                "id": 1,
                "number": "WSGE123",
                "type": "",
                "gym_operator": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "service_provider": {
                    "id": 4,
                    "first_name": "Roslyn",
                    "last_name": "Conn",
                    "email": "[email protected]",
                    "role": "service_provider",
                    "company": {
                        "id": 2,
                        "name": "The Gym Fixers",
                        "address": "2072 Lemke Ports Apt. 534",
                        "address_2": null,
                        "address_3": null,
                        "city": "Port Herta",
                        "country": "UK",
                        "postcode": "04103-3783",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "active": true,
                "start_date": "2025-01-19",
                "end_date": "2026-01-19",
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            "media": [],
            "images": [],
            "notes": [
                {
                    "id": 6,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:19+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:19+00:00"
        },
        {
            "id": 7,
            "number": "WSGE123-007",
            "type": "standard",
            "description": null,
            "priority": "Faulty",
            "status": "closed",
            "engineer_arrived_at": null,
            "engineer_deployed_at": null,
            "closed_at": "2025-01-20T19:58:19+00:00",
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": {
                "id": 1,
                "number": "WSGE123",
                "type": "",
                "gym_operator": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "service_provider": {
                    "id": 4,
                    "first_name": "Roslyn",
                    "last_name": "Conn",
                    "email": "[email protected]",
                    "role": "service_provider",
                    "company": {
                        "id": 2,
                        "name": "The Gym Fixers",
                        "address": "2072 Lemke Ports Apt. 534",
                        "address_2": null,
                        "address_3": null,
                        "city": "Port Herta",
                        "country": "UK",
                        "postcode": "04103-3783",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "active": true,
                "start_date": "2025-01-19",
                "end_date": "2026-01-19",
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            "media": [],
            "images": [],
            "notes": [
                {
                    "id": 7,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:19+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:19+00:00"
        }
    ],
    "links": {
        "first": "https://api.orbit4.org/v1/tickets?page=1",
        "last": "https://api.orbit4.org/v1/tickets?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://api.orbit4.org/v1/tickets?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://api.orbit4.org/v1/tickets",
        "per_page": 25,
        "to": 7,
        "total": 7
    }
}

Create new ticket.

POST

https://api.orbit4.org

/v1/tickets

requires authentication

This endpoint allows you to raise a new ticket from the specified sender to the specified recipient account. The ticket will be created with the provided details and assigned to the specified user.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

multipart/form-data

Body Parameters

sender_id

integer

required

The ID of the gym operator raising the ticket.

Example:

recipient_id

integer

required

The ID of the user the ticket is sent to. Only required if the ticket is sent to a user.

Example:

asset_id

integer

The ID of the asset the ticket is raised for

Example:

type

string

required

The type of ticket being raised.

Must be one of:

standard
ad-hoc
internal
service

Example:

standard

description

string

required

The description of the problem being raised in the ticket.

Example:

The treadmill is broken. Please fix it.

priority

string

The priority of the ticket based on the state of the equipment.

Must be one of:

Low
Faulty
Out of Order
Replacement

Example:

Faulty

images

file[]

A file to be attached to the ticket as an image. Supports jpeg, png, jpg, webp, heic formats. Must be an image. Must not be greater than 10240 kilobytes.

metadata

string

A JSON object with metadata, which can be used for filtering. This will also be included in API responses and webhook payloads.

Example:

{"integration_id":"ABC123"}

Response Fields

data

object

integer

The unique identifier for the ticket within the Orbit4 system.

number

string

A user friendly identifier for the ticket.

type

string

The type of ticket.

description

string

A description of the issue.

priority

string

The priority of the ticket based on the state of the equipment.

status

string

The current status of the ticket.

engineer_arrived_at

string

The date and time the engineer arrived at the location.

engineer_deployed_at

string

The date and time the engineer was deployed to the location.

closed_at

string

The date and time the ticket was closed.

service_provider

object

An object representing the service provider linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

gym_operator

object

An object representing the gym operator linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

ticket_admin

object

An object representing the ticket admin linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

engineer

object

An object representing the engineer linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

caretaker

object

An object representing the caretaker linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

asset

object

An object representing the asset linked to the ticket.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

contract

object

An object representing the contract linked to the ticket.

integer

The unique identifier for the contract within the Orbit4 system.

number

string

A user friendly identifier for the contract.

type

string

The type of contract.

gym_operator

object

An object representing the gym operator linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

service_provider

object

An object representing the service provider linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

active

boolean

A boolean indicating whether the contract is currently active.

start_date

string

The date the contract starts.

end_date

string

The date the contract ends.

items

array

An array of the assets included in the contract.

object

An object representing an asset.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

media

array

An array of objects representing the media linked to the ticket.

object

An object representing an piece of media.

images

array

An array of objects representing the images linked to the ticket.

object

An object representing an image.

notes

array

An array of objects representing the notes linked to the ticket.

object

An object representing a note.

integer

The unique identifier for the note within the Orbit4 system.

user

object

An object representing the user who sent the note.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

note

string

The content of the note.

is_system

boolean

A boolean indicating whether the note was generated by the system.

created_at

string

The date and time the note was created.

created_at

string

The date and time the ticket was created.

Example request:

curl --request POST \
    "https://api.orbit4.org/v1/tickets" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: multipart/form-data" \
    --form "sender_id=2"\
    --form "recipient_id=4"\
    --form "asset_id=1"\
    --form "type=standard"\
    --form "description=The treadmill is broken. Please fix it."\
    --form "priority=Faulty"\
    --form "metadata={"integration_id":"ABC123"}"\
    --form "images[]=@/tmp/phpELMcOQ"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 44

{
    "data": {
        "id": 8,
        "number": "WSGE123-008",
        "type": "standard",
        "description": "The treadmill is broken. Please fix it.",
        "priority": "Faulty",
        "status": "open",
        "engineer_arrived_at": null,
        "engineer_deployed_at": null,
        "closed_at": null,
        "service_provider": {
            "id": 4,
            "first_name": "Roslyn",
            "last_name": "Conn",
            "email": "[email protected]",
            "role": "service_provider",
            "company": {
                "id": 2,
                "name": "The Gym Fixers",
                "address": "2072 Lemke Ports Apt. 534",
                "address_2": null,
                "address_3": null,
                "city": "Port Herta",
                "country": "UK",
                "postcode": "04103-3783",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": null,
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "gym_operator": {
            "id": 2,
            "first_name": "Jett",
            "last_name": "Ziemann",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": {
                "id": 1,
                "name": "PulseForge Fitness",
                "address": "9409 Katelynn Circle",
                "address_2": null,
                "address_3": null,
                "city": "North Wilburnland",
                "country": "UK",
                "postcode": "40117-2392",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": "London Bridge",
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "ticket_admin": null,
        "engineer": null,
        "caretaker": null,
        "asset": {
            "id": 1,
            "brand": "Hammer Strength",
            "range": "Plateloaded Iso-Lateral",
            "product": "Seated Leg Press",
            "product_id": 5,
            "qr_code": "O4-513",
            "serial_number": "MSN-603",
            "installation_date": "20/01/2022",
            "manufacturing_date": "20/01/2021",
            "warranty_end_date": "20/01/2027",
            "current_spend": "£0",
            "max_spend": "£5,964.15",
            "fitness_product": 0,
            "has_odometer": 1,
            "residual_price": "£247.91",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        "contract": {
            "id": 1,
            "number": "WSGE123",
            "type": "",
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "active": true,
            "start_date": "2025-01-19",
            "end_date": "2026-01-19",
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        "media": [
            {
                "id": 3,
                "url": "https://cdn.orbit4.org/uploads/29710678eaadbe0e787.47384013.jpg",
                "type": "image",
                "extra_properties": null,
                "created_at": "2025-01-20T19:58:19+00:00"
            }
        ],
        "images": [
            {
                "id": 3,
                "url": "https://cdn.orbit4.org/uploads/29710678eaadbe0e787.47384013.jpg",
                "type": "image",
                "extra_properties": null,
                "created_at": "2025-01-20T19:58:19+00:00"
            }
        ],
        "notes": [
            {
                "id": 10,
                "user": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "note": "Ticket Raised",
                "is_system": true,
                "created_at": "2025-01-20T19:58:19+00:00"
            },
            {
                "id": 11,
                "user": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "note": "The treadmill is broken. Please fix it.",
                "is_system": false,
                "created_at": "2025-01-20T19:58:19+00:00"
            },
            {
                "id": 12,
                "user": {
                    "id": 1,
                    "first_name": "Finn",
                    "last_name": "Zieme",
                    "email": "[email protected]",
                    "role": "club_admin",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:15+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "note": "Image Uploaded",
                "is_system": true,
                "created_at": "2025-01-20T19:58:20+00:00"
            }
        ],
        "metadata": {
            "integration_id": "ABC123"
        },
        "created_at": "2025-01-20T19:58:19+00:00"
    }
}

Fetch ticket details.

GET

https://api.orbit4.org

/v1/tickets/{ticket}

requires authentication

This endpoint allows you to retrieve details of a specific ticket by their ID. The returned details include the ticket's status, assigned user, and other relevant information.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

URL Parameters

ticket

string

required

The ID of the ticket.

Example:

Response Fields

data

object

integer

The unique identifier for the ticket within the Orbit4 system.

number

string

A user friendly identifier for the ticket.

type

string

The type of ticket.

description

string

A description of the issue.

priority

string

The priority of the ticket based on the state of the equipment.

status

string

The current status of the ticket.

engineer_arrived_at

string

The date and time the engineer arrived at the location.

engineer_deployed_at

string

The date and time the engineer was deployed to the location.

closed_at

string

The date and time the ticket was closed.

service_provider

object

An object representing the service provider linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

gym_operator

object

An object representing the gym operator linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

ticket_admin

object

An object representing the ticket admin linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

engineer

object

An object representing the engineer linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

caretaker

object

An object representing the caretaker linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

asset

object

An object representing the asset linked to the ticket.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

contract

object

An object representing the contract linked to the ticket.

integer

The unique identifier for the contract within the Orbit4 system.

number

string

A user friendly identifier for the contract.

type

string

The type of contract.

gym_operator

object

An object representing the gym operator linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

service_provider

object

An object representing the service provider linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

active

boolean

A boolean indicating whether the contract is currently active.

start_date

string

The date the contract starts.

end_date

string

The date the contract ends.

items

array

An array of the assets included in the contract.

object

An object representing an asset.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

media

array

An array of objects representing the media linked to the ticket.

object

An object representing an piece of media.

images

array

An array of objects representing the images linked to the ticket.

object

An object representing an image.

notes

array

An array of objects representing the notes linked to the ticket.

object

An object representing a note.

integer

The unique identifier for the note within the Orbit4 system.

user

object

An object representing the user who sent the note.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

note

string

The content of the note.

is_system

boolean

A boolean indicating whether the note was generated by the system.

created_at

string

The date and time the note was created.

created_at

string

The date and time the ticket was created.

Example request:

curl --request GET \
    --get "https://api.orbit4.org/v1/tickets/2" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 43

{
    "data": {
        "id": 2,
        "number": "WSGE123-002",
        "type": "standard",
        "description": null,
        "priority": "Faulty",
        "status": "open",
        "engineer_arrived_at": null,
        "engineer_deployed_at": null,
        "closed_at": null,
        "service_provider": {
            "id": 4,
            "first_name": "Roslyn",
            "last_name": "Conn",
            "email": "[email protected]",
            "role": "service_provider",
            "company": {
                "id": 2,
                "name": "The Gym Fixers",
                "address": "2072 Lemke Ports Apt. 534",
                "address_2": null,
                "address_3": null,
                "city": "Port Herta",
                "country": "UK",
                "postcode": "04103-3783",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": null,
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "gym_operator": {
            "id": 2,
            "first_name": "Jett",
            "last_name": "Ziemann",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": {
                "id": 1,
                "name": "PulseForge Fitness",
                "address": "9409 Katelynn Circle",
                "address_2": null,
                "address_3": null,
                "city": "North Wilburnland",
                "country": "UK",
                "postcode": "40117-2392",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": "London Bridge",
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "ticket_admin": null,
        "engineer": null,
        "caretaker": null,
        "asset": null,
        "contract": {
            "id": 1,
            "number": "WSGE123",
            "type": "",
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "active": true,
            "start_date": "2025-01-19",
            "end_date": "2026-01-19",
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        "media": [
            {
                "id": 1,
                "url": "https://cdn.orbit4.org/uploads/image.jpg",
                "type": "image",
                "extra_properties": null,
                "created_at": "2025-01-20T19:58:19+00:00"
            }
        ],
        "images": [
            {
                "id": 1,
                "url": "https://cdn.orbit4.org/uploads/image.jpg",
                "type": "image",
                "extra_properties": null,
                "created_at": "2025-01-20T19:58:19+00:00"
            }
        ],
        "notes": [
            {
                "id": 2,
                "user": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "note": "Ticket Raised",
                "is_system": true,
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 8,
                "user": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "note": "Hey, this machine is now totally out of use. Can you come today?",
                "is_system": false,
                "created_at": "2025-01-20T19:58:19+00:00"
            },
            {
                "id": 9,
                "user": {
                    "id": 4,
                    "first_name": "Roslyn",
                    "last_name": "Conn",
                    "email": "[email protected]",
                    "role": "service_provider",
                    "company": {
                        "id": 2,
                        "name": "The Gym Fixers",
                        "address": "2072 Lemke Ports Apt. 534",
                        "address_2": null,
                        "address_3": null,
                        "city": "Port Herta",
                        "country": "UK",
                        "postcode": "04103-3783",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "note": "Sure, no problem, I'll deploy one of my technicians out to you now.",
                "is_system": false,
                "created_at": "2025-01-20T19:58:19+00:00"
            }
        ],
        "metadata": [],
        "created_at": "2025-01-20T19:58:18+00:00"
    }
}

Update ticket.

PUT

https://api.orbit4.org

/v1/tickets/{ticket}

requires authentication

This endpoint allows you to update details of a specific ticket by their ID. Only the fields that need to be updated should be provided.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

URL Parameters

ticket

string

required

The ID of the ticket.

Example:

Body Parameters

status

string

The status of the ticket.

Must be one of:

open
parts_required
engineer_deployed
closed

Example:

closed

engineer_id

integer

The ID of the external technician deployed by the service provider.

caretaker_id

integer

The ID of the internal technician deployed by the gym operator.

ticket_admin_id

integer

The ID of the ticket admin managing the ticket.

case_number

string

An optional alternative identifier.

priority

string

The level of priority based on the equipment damage.

Must be one of:

Low
Faulty
Out of Order
Replacement

Example:

Faulty

engineer_arrived_at

datetime

A timestamp indicating the time the technician arrived to the site.

engineer_completed_at

datetime

A timestamp indicating the time the technician left the site after completion.

engineer_deployed_at

datetime

A timestamp indicating the time the technician was deployed by the service provider.

closed_at

datetime

A timestamp indicating the time the ticket was marked as closed.

metadata

string

A JSON object with metadata, which can be used for filtering. This will also be included in API responses and webhook payloads.

Example:

{"integration_id":"ABC123"}

Response Fields

data

object

integer

The unique identifier for the ticket within the Orbit4 system.

number

string

A user friendly identifier for the ticket.

type

string

The type of ticket.

description

string

A description of the issue.

priority

string

The priority of the ticket based on the state of the equipment.

status

string

The current status of the ticket.

engineer_arrived_at

string

The date and time the engineer arrived at the location.

engineer_deployed_at

string

The date and time the engineer was deployed to the location.

closed_at

string

The date and time the ticket was closed.

service_provider

object

An object representing the service provider linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

gym_operator

object

An object representing the gym operator linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

ticket_admin

object

An object representing the ticket admin linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

engineer

object

An object representing the engineer linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

caretaker

object

An object representing the caretaker linked to the ticket.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

asset

object

An object representing the asset linked to the ticket.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

contract

object

An object representing the contract linked to the ticket.

integer

The unique identifier for the contract within the Orbit4 system.

number

string

A user friendly identifier for the contract.

type

string

The type of contract.

gym_operator

object

An object representing the gym operator linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

service_provider

object

An object representing the service provider linked to the contract.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

active

boolean

A boolean indicating whether the contract is currently active.

start_date

string

The date the contract starts.

end_date

string

The date the contract ends.

items

array

An array of the assets included in the contract.

object

An object representing an asset.

integer

The unique identifier for the asset within the Orbit4 system.

brand

string

The brand of the asset.

range

string

The range of the asset.

product

string

The name of the product.

product_id

integer

The unique identifier for the product within the Orbit4 system.

qr_code

string

The qr code number used on the sticker of the equipment.

serial_number

string

The manufacturer serial number of the equipment.

installation_date

string

The installation date of the equipment.

manufacturing_date

string

The manufacturing date of the equipment.

warranty_end_date

string

The warranty end date of the equipment.

current_spend

string

The current spend in services for the equipment.

max_spend

string

The maximum spend in services for the equipment until it's recommended to replace it.

fitness_product

boolean

A boolean indicating whether the asset is a fitness equipment.

has_odometer

boolean

A boolean indicating whether the asset has an odometer.

residual_price

string

The residual value of the asset.

image

object

An object representing the image of the asset

created_at

string

The date and time the asset was created.

media

array

An array of objects representing the media linked to the ticket.

object

An object representing an piece of media.

images

array

An array of objects representing the images linked to the ticket.

object

An object representing an image.

notes

array

An array of objects representing the notes linked to the ticket.

object

An object representing a note.

integer

The unique identifier for the note within the Orbit4 system.

user

object

An object representing the user who sent the note.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

note

string

The content of the note.

is_system

boolean

A boolean indicating whether the note was generated by the system.

created_at

string

The date and time the note was created.

created_at

string

The date and time the ticket was created.

Example request:

curl --request PUT \
    "https://api.orbit4.org/v1/tickets/2" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json" \
    --data "{
    \"status\": \"closed\",
    \"priority\": \"Faulty\",
    \"metadata\": \"{\\\"integration_id\\\":\\\"ABC123\\\"}\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 42

{
    "data": {
        "id": 2,
        "number": "WSGE123-002",
        "type": "standard",
        "description": null,
        "priority": "Faulty",
        "status": "closed",
        "engineer_arrived_at": null,
        "engineer_deployed_at": null,
        "closed_at": "2025-01-20T19:58:20+00:00",
        "service_provider": {
            "id": 4,
            "first_name": "Roslyn",
            "last_name": "Conn",
            "email": "[email protected]",
            "role": "service_provider",
            "company": {
                "id": 2,
                "name": "The Gym Fixers",
                "address": "2072 Lemke Ports Apt. 534",
                "address_2": null,
                "address_3": null,
                "city": "Port Herta",
                "country": "UK",
                "postcode": "04103-3783",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": null,
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "gym_operator": {
            "id": 2,
            "first_name": "Jett",
            "last_name": "Ziemann",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": {
                "id": 1,
                "name": "PulseForge Fitness",
                "address": "9409 Katelynn Circle",
                "address_2": null,
                "address_3": null,
                "city": "North Wilburnland",
                "country": "UK",
                "postcode": "40117-2392",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": "London Bridge",
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        "ticket_admin": null,
        "engineer": null,
        "caretaker": null,
        "asset": null,
        "contract": {
            "id": 1,
            "number": "WSGE123",
            "type": "",
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "active": true,
            "start_date": "2025-01-19",
            "end_date": "2026-01-19",
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        "media": [
            {
                "id": 1,
                "url": "https://cdn.orbit4.org/uploads/image.jpg",
                "type": "image",
                "extra_properties": null,
                "created_at": "2025-01-20T19:58:19+00:00"
            }
        ],
        "images": [
            {
                "id": 1,
                "url": "https://cdn.orbit4.org/uploads/image.jpg",
                "type": "image",
                "extra_properties": null,
                "created_at": "2025-01-20T19:58:19+00:00"
            }
        ],
        "notes": [
            {
                "id": 2,
                "user": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "note": "Ticket Raised",
                "is_system": true,
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            {
                "id": 8,
                "user": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "note": "Hey, this machine is now totally out of use. Can you come today?",
                "is_system": false,
                "created_at": "2025-01-20T19:58:19+00:00"
            },
            {
                "id": 9,
                "user": {
                    "id": 4,
                    "first_name": "Roslyn",
                    "last_name": "Conn",
                    "email": "[email protected]",
                    "role": "service_provider",
                    "company": {
                        "id": 2,
                        "name": "The Gym Fixers",
                        "address": "2072 Lemke Ports Apt. 534",
                        "address_2": null,
                        "address_3": null,
                        "city": "Port Herta",
                        "country": "UK",
                        "postcode": "04103-3783",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "note": "Sure, no problem, I'll deploy one of my technicians out to you now.",
                "is_system": false,
                "created_at": "2025-01-20T19:58:19+00:00"
            },
            {
                "id": 10,
                "user": {
                    "id": 1,
                    "first_name": "Finn",
                    "last_name": "Zieme",
                    "email": "[email protected]",
                    "role": "club_admin",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:15+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "note": "Ticket Closed",
                "is_system": true,
                "created_at": "2025-01-20T19:58:20+00:00"
            }
        ],
        "metadata": {
            "integration_id": "ABC123"
        },
        "created_at": "2025-01-20T19:58:18+00:00"
    }
}

Users

The following set of endpoints provide a comprehensive suite of tools for managing your users within your account. They are designed to handle a variety of operations, from searching for users based on specific roles, fetching detailed information about individual users, creating new users, updating existing user details, and even removing users from your account when no longer needed. The main purpose of these operations is facilitating the synchronization of your system's users with Orbit4.

Search for users.

GET

https://api.orbit4.org

/v1/users

requires authentication

This endpoint retrieves users associated with your account. The user role must be specified to fetch users of a specific role in the system. For users that are part of a parent account (like engineers and ticket admins), the parent_id parameter must be provided.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

Query Parameters

string

Search for users by first name, last name, company name, site name or email address.

parent_id

integer

Filter users by their parent account. This field is required when querying engineers or ticket admins.

role

string

required

Filter users by role.

Must be one of:

gym_operator
service_provider
engineer
ticket_admin

Example:

gym_operator

sort

string

Results can be sorted by the following fields:

id
first_name
last_name
company_name
site_name
email
role
created_at

The default sorting order is ascending, but the direction can be reversed by prefixing a dash (-) like so: ?sort=-id

metadata[metadata_key]

string

Filter results by metadata. Replace metadata_key with the key of the metadata you want to filter by.

page

integer

The page number of results to be returned.

per_page

integer

The number of results to be returned for each page of results.

Response Fields

data

array

An array of paginated items.

object

An object representing a paginated item.

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

links

object

Pagination links.

meta

object

Pagination meta data.

current_page

integer

Current page number.

from

integer

Starting record number.

last_page

integer

Last page number.

links

array

An array of links.

path

integer

The path of the request.

per_page

integer

Records per page.

integer

Ending record number.

total

integer

Total number of records.

Example request:

curl --request GET \
    --get "https://api.orbit4.org/v1/users?role=gym_operator" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 59

{
    "data": [
        {
            "id": 2,
            "first_name": "Jett",
            "last_name": "Ziemann",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": {
                "id": 1,
                "name": "PulseForge Fitness",
                "address": "9409 Katelynn Circle",
                "address_2": null,
                "address_3": null,
                "city": "North Wilburnland",
                "country": "UK",
                "postcode": "40117-2392",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": "London Bridge",
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        },
        {
            "id": 3,
            "first_name": "Mason",
            "last_name": "Terry",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": {
                "id": 1,
                "name": "PulseForge Fitness",
                "address": "9409 Katelynn Circle",
                "address_2": null,
                "address_3": null,
                "city": "North Wilburnland",
                "country": "UK",
                "postcode": "40117-2392",
                "created_at": "2025-01-20T19:58:15+00:00"
            },
            "site_name": "Notthing Hill Gate",
            "language": "en",
            "email_verified_at": "2025-01-20T19:58:16+00:00",
            "metadata": [],
            "created_at": "2025-01-20T19:58:16+00:00"
        }
    ],
    "links": {
        "first": "https://api.orbit4.org/v1/users?page=1",
        "last": "https://api.orbit4.org/v1/users?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://api.orbit4.org/v1/users?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://api.orbit4.org/v1/users",
        "per_page": 25,
        "to": 2,
        "total": 2
    }
}

Fetch user details.

GET

https://api.orbit4.org

/v1/users/{user}

requires authentication

This endpoint allows you to retrieve details of a specific user by their ID.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

URL Parameters

user

string

required

The ID of the user.

Example:

Response Fields

data

object

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

Example request:

curl --request GET \
    --get "https://api.orbit4.org/v1/users/2" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 59

{
    "data": {
        "id": 2,
        "first_name": "Jett",
        "last_name": "Ziemann",
        "email": "[email protected]",
        "role": "gym_operator",
        "company": {
            "id": 1,
            "name": "PulseForge Fitness",
            "address": "9409 Katelynn Circle",
            "address_2": null,
            "address_3": null,
            "city": "North Wilburnland",
            "country": "UK",
            "postcode": "40117-2392",
            "created_at": "2025-01-20T19:58:15+00:00"
        },
        "site_name": "London Bridge",
        "language": "en",
        "email_verified_at": "2025-01-20T19:58:16+00:00",
        "metadata": [],
        "created_at": "2025-01-20T19:58:16+00:00"
    }
}

Create new user.

POST

https://api.orbit4.org

/v1/users

requires authentication

This endpoint allows you to add a new user to your account. The user role must be specified when creating a new user.

And the parent_id parameter must be provided for users that are part of a parent account (like engineers and ticket admins).

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

Body Parameters

first_name

string

required

The first name of the user.

Example:

nbmjw

last_name

string

required

The last name of the user.

Example:

uhxdyvxqwckvrhqyk

string

required

The email address of the user.

Example:

[email protected]

company_id

numeric

The company id the user belongs to. Only for Service Providers.

site_name

string

The name of the club the user belongs to. Only for Gym Operators.

Example:

bgoncihrceevhvtj

language

string

required

The preferred language the user wants to receive their notifications.

Must be one of:

en
es
de
bg
pt
fr
jp
tr
ar
zh
hi
bn

Example:

parent_id

integer

The ID of the parent account. This field is required when creating engineers or ticket admins.

role

string

required

The role of the user.

Must be one of:

gym_operator
service_provider
gym_staff
caretaker
engineer
ticket_admin

Example:

gym_operator

metadata

string

A JSON object with metadata, which can be used for filtering. This will also be included in API responses and webhook payloads.

Example:

{"integration_id":"ABC123"}

Response Fields

data

object

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

Example request:

curl --request POST \
    "https://api.orbit4.org/v1/users" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json" \
    --data "{
    \"first_name\": \"nbmjw\",
    \"last_name\": \"uhxdyvxqwckvrhqyk\",
    \"email\": \"[email protected]\",
    \"site_name\": \"bgoncihrceevhvtj\",
    \"language\": \"de\",
    \"role\": \"gym_operator\",
    \"metadata\": \"{\\\"integration_id\\\":\\\"ABC123\\\"}\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 58

{
    "data": {
        "id": 17,
        "first_name": "nbmjw",
        "last_name": "uhxdyvxqwckvrhqyk",
        "email": "[email protected]",
        "role": "gym_operator",
        "company": {
            "id": 1,
            "name": "PulseForge Fitness",
            "address": "9409 Katelynn Circle",
            "address_2": null,
            "address_3": null,
            "city": "North Wilburnland",
            "country": "UK",
            "postcode": "40117-2392",
            "created_at": "2025-01-20T19:58:15+00:00"
        },
        "site_name": "bgoncihrceevhvtj",
        "language": "de",
        "email_verified_at": null,
        "metadata": {
            "integration_id": "ABC123"
        },
        "created_at": "2025-01-20T19:58:19+00:00"
    }
}

Update user.

PUT

https://api.orbit4.org

/v1/users/{user}

requires authentication

This endpoint allows you to update details of a specific user by their ID. Only the fields that need to be updated should be provided.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

URL Parameters

user

string

required

The ID of the user.

Example:

Body Parameters

first_name

string

required

The first name of the user.

Example:

qqzjgjhoziz

last_name

string

required

The last name of the user.

Example:

kbxxhfbionue

site_name

string

The name of the club the user belongs to. Only for Gym Operators.

Example:

cynlywfcwgcwsxykvheip

language

string

required

The preferred language the user wants to receive their notifications.

Must be one of:

en
es
de
bg
pt
fr
jp
tr
ar
zh
hi
bn

Example:

metadata

string

A JSON object with metadata, which can be used for filtering. This will also be included in API responses and webhook payloads.

Example:

{"integration_id":"ABC123"}

Response Fields

data

object

integer

The unique identifier for the user within the Orbit4 system.

first_name

string

The first name of the user.

last_name

string

The last name of the user.

string

The email address of the user.

role

string

The role of the user.

company

object

An object representing the company the user is associated with.

integer

The unique identifier for the company within the Orbit4 system.

name

string

The name of the company.

address

string

The first line of the company's address.

address_2

string

The second line of the company's address.

address_3

string

The third line of the company's address.

city

string

The city of the company's address.

country

string

The country of the company's address.

postcode

string

The postcode of the company's address.

created_at

string

The date and time the company was created.

language

string

The language the user prefers to use.

email_verified_at

string

The date and time the user verified their email address.

created_at

string

The date and time the user was created.

Example request:

curl --request PUT \
    "https://api.orbit4.org/v1/users/2" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json" \
    --data "{
    \"first_name\": \"qqzjgjhoziz\",
    \"last_name\": \"kbxxhfbionue\",
    \"site_name\": \"cynlywfcwgcwsxykvheip\",
    \"language\": \"de\",
    \"metadata\": \"{\\\"integration_id\\\":\\\"ABC123\\\"}\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 57

{
    "data": {
        "id": 2,
        "first_name": "qqzjgjhoziz",
        "last_name": "kbxxhfbionue",
        "email": "[email protected]",
        "role": "gym_operator",
        "company": {
            "id": 1,
            "name": "PulseForge Fitness",
            "address": "9409 Katelynn Circle",
            "address_2": null,
            "address_3": null,
            "city": "North Wilburnland",
            "country": "UK",
            "postcode": "40117-2392",
            "created_at": "2025-01-20T19:58:15+00:00"
        },
        "site_name": "cynlywfcwgcwsxykvheip",
        "language": "de",
        "email_verified_at": "2025-01-20T19:58:16+00:00",
        "metadata": {
            "integration_id": "ABC123"
        },
        "created_at": "2025-01-20T19:58:16+00:00"
    }
}

Delete user.

DELETE

https://api.orbit4.org

/v1/users/{user}

requires authentication

This endpoint allows you to delete a specific user from your account by their ID.

Headers

Authorization

Example:

Bearer client-admin-test-token

Content-Type

Example:

application/json

URL Parameters

user

string

required

The ID of the user.

Example:

Example request:

curl --request DELETE \
    "https://api.orbit4.org/v1/users/2" \
    --header "Authorization: Bearer client-admin-test-token" \
    --header "Content-Type: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 56

[Empty response]

Link user

POST

https://api.orbit4.org

/v1/users/{user}/link

requires authentication

This endpoint allows you to link a user to a parent user account. i.e. link an engineer to a service provider account.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

URL Parameters

user

string

required

The ID of the parent user.

Example:

Body Parameters

child_id

string

The ID of the user to be linked to the parent user account.

Example:

Example request:

curl --request POST \
    "https://api.orbit4.org/v1/users/3/link" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"child_id\": 5
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 55

[Empty response]

Unlink user

POST

https://api.orbit4.org

/v1/users/{user}/unlink

requires authentication

This endpoint allows you to unlink a user from a parent user account. i.e. unlink a ticket admin from a gym operator account.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

URL Parameters

user

string

required

The ID of the parent user.

Example:

Body Parameters

child_id

string

The ID of the user to be unlinked from the parent user account.

Example:

Example request:

curl --request POST \
    "https://api.orbit4.org/v1/users/3/unlink" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"child_id\": 7
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 54

[Empty response]

Webhooks

Webhooks are a way to provide Orbit4 partners with real-time information. When a specific event happens in Orbit4, we'll send a HTTP POST payload to the webhook's configured URL. In conjunction with our public API endpoints, Orbit4 supports fluid, two-way communication, ensuring that systems are kept in perfect sync.

Configuring Webhooks

To configure webhooks you need to navigate to the Webhooks section within your profile menu and then clicking on Create Webhook.
In this section, you can specify the URL to which the webhook will send the event payload. You also have the option to subscribe to specific events. When these events take place, the webhook will automatically dispatch an event payload to the designated URL. Upon creation, a unique secret key is generated. This key serves as a tool for verifying the webhook signature when it is processed on your end, ensuring that the request was genuinely initiated by Orbit4.

Events

These are the list of events you can subscribe to:

asset.created
asset.updated
note.created
ticket.closed
ticket.created
ticket.updated
user.created
user.updated

asset.created

This event is fired when a new asset is created. The payload contains the asset that was created.

Payload example:

{
    "event": "asset.created",
    "data": {
        "asset": {
            "id": 1,
            "brand": "Technogym",
            "range": "Excite JOG 700 LED",
            "product": "Treadmill",
            "product_id": 4,
            "qr_code": "O4-12345",
            "serial_number": "1234567890",
            "installation_date": null,
            "manufacturing_date": null,
            "warranty_end_date": null,
            "current_spend": "£0",
            "max_spend": "£0",
            "fitness_product": null,
            "has_odometer": null,
            "residual_price": "£0",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:21+00:00"
        }
    }
}

asset.updated

This event is fired when an asset is updated. The payload contains the asset that was updated.

Payload example:

{
    "event": "asset.updated",
    "data": {
        "asset": {
            "id": 1,
            "brand": "Technogym",
            "range": "Excite JOG 700 LED",
            "product": "Treadmill",
            "product_id": 4,
            "qr_code": "O4-12345",
            "serial_number": "1234567890",
            "installation_date": null,
            "manufacturing_date": null,
            "warranty_end_date": null,
            "current_spend": "£0",
            "max_spend": "£0",
            "fitness_product": null,
            "has_odometer": null,
            "residual_price": "£0",
            "image": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:21+00:00"
        }
    }
}

note.created

This event is fired when a new note is created. The payload contains the ticket that the note was created on and the note itself.

Payload example:

{
    "event": "note.created",
    "data": {
        "ticket": {
            "id": 1,
            "number": "WSGE123-001",
            "type": "standard",
            "description": null,
            "priority": "Faulty",
            "status": "open",
            "engineer_arrived_at": null,
            "engineer_deployed_at": null,
            "closed_at": null,
            "service_provider": {
                "id": 4,
                "first_name": "Roslyn",
                "last_name": "Conn",
                "email": "[email protected]",
                "role": "service_provider",
                "company": {
                    "id": 2,
                    "name": "The Gym Fixers",
                    "address": "2072 Lemke Ports Apt. 534",
                    "address_2": null,
                    "address_3": null,
                    "city": "Port Herta",
                    "country": "UK",
                    "postcode": "04103-3783",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": null,
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "gym_operator": {
                "id": 2,
                "first_name": "Jett",
                "last_name": "Ziemann",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": {
                    "id": 1,
                    "name": "PulseForge Fitness",
                    "address": "9409 Katelynn Circle",
                    "address_2": null,
                    "address_3": null,
                    "city": "North Wilburnland",
                    "country": "UK",
                    "postcode": "40117-2392",
                    "created_at": "2025-01-20T19:58:15+00:00"
                },
                "site_name": "London Bridge",
                "language": "en",
                "email_verified_at": "2025-01-20T19:58:16+00:00",
                "metadata": [],
                "created_at": "2025-01-20T19:58:16+00:00"
            },
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": {
                "id": 1,
                "number": "WSGE123",
                "type": "",
                "gym_operator": {
                    "id": 2,
                    "first_name": "Jett",
                    "last_name": "Ziemann",
                    "email": "[email protected]",
                    "role": "gym_operator",
                    "company": {
                        "id": 1,
                        "name": "PulseForge Fitness",
                        "address": "9409 Katelynn Circle",
                        "address_2": null,
                        "address_3": null,
                        "city": "North Wilburnland",
                        "country": "UK",
                        "postcode": "40117-2392",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": "London Bridge",
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "service_provider": {
                    "id": 4,
                    "first_name": "Roslyn",
                    "last_name": "Conn",
                    "email": "[email protected]",
                    "role": "service_provider",
                    "company": {
                        "id": 2,
                        "name": "The Gym Fixers",
                        "address": "2072 Lemke Ports Apt. 534",
                        "address_2": null,
                        "address_3": null,
                        "city": "Port Herta",
                        "country": "UK",
                        "postcode": "04103-3783",
                        "created_at": "2025-01-20T19:58:15+00:00"
                    },
                    "site_name": null,
                    "language": "en",
                    "email_verified_at": "2025-01-20T19:58:16+00:00",
                    "metadata": [],
                    "created_at": "2025-01-20T19:58:16+00:00"
                },
                "active": true,
                "start_date": "2025-01-19",
                "end_date": "2026-01-19",
                "metadata": [],
                "created_at": "2025-01-20T19:58:18+00:00"
            },
            "media": [],
            "images": [],
            "notes": [
                {
                    "id": 1,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:18+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:18+00:00"
        },
        "note": {
            "id": 1,
            "user": {
                "id": 1,
                "first_name": "John",
                "last_name": "Doe",
                "email": "[email protected]",
                "role": "gym_operator",
                "company": null,
                "site_name": null,
                "language": "en",
                "email_verified_at": null,
                "metadata": [],
                "created_at": "2025-01-20T19:58:21+00:00"
            },
            "note": "The treadmill is broken. Please fix it.",
            "is_system": false,
            "created_at": "2025-01-20T19:58:21+00:00"
        }
    }
}

ticket.closed

This event is fired when a ticket is closed. The payload contains the ticket that was closed.

Payload example:

{
    "event": "ticket.closed",
    "data": {
        "ticket": {
            "id": 1,
            "number": "WSGE123-001",
            "type": "standard",
            "description": "The treadmill is broken. Please fix it.",
            "priority": null,
            "status": "closed",
            "engineer_arrived_at": null,
            "engineer_deployed_at": null,
            "closed_at": "2025-01-20T19:58:21+00:00",
            "service_provider": null,
            "gym_operator": null,
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": null,
            "media": [],
            "images": [],
            "notes": [
                {
                    "id": 1,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:18+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:21+00:00"
        }
    }
}

ticket.created

This event is fired when a ticket is created. The payload contains the ticket that was created.

Payload example:

{
    "event": "ticket.created",
    "data": {
        "ticket": {
            "id": 1,
            "number": "WSGE123-001",
            "type": "standard",
            "description": "The treadmill is broken. Please fix it.",
            "priority": null,
            "status": "open",
            "engineer_arrived_at": null,
            "engineer_deployed_at": null,
            "closed_at": null,
            "service_provider": null,
            "gym_operator": null,
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": null,
            "media": [],
            "images": [],
            "notes": [
                {
                    "id": 1,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:18+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:21+00:00"
        }
    }
}

ticket.updated

This event is fired when a ticket is updated. The payload contains the ticket that was updated.

Payload example:

{
    "event": "ticket.updated",
    "data": {
        "ticket": {
            "id": 1,
            "number": "WSGE123-001",
            "type": "standard",
            "description": "The treadmill is broken. Please fix it.",
            "priority": null,
            "status": "open",
            "engineer_arrived_at": null,
            "engineer_deployed_at": null,
            "closed_at": null,
            "service_provider": null,
            "gym_operator": null,
            "ticket_admin": null,
            "engineer": null,
            "caretaker": null,
            "asset": null,
            "contract": null,
            "media": [],
            "images": [],
            "notes": [
                {
                    "id": 1,
                    "user": {
                        "id": 2,
                        "first_name": "Jett",
                        "last_name": "Ziemann",
                        "email": "[email protected]",
                        "role": "gym_operator",
                        "company": {
                            "id": 1,
                            "name": "PulseForge Fitness",
                            "address": "9409 Katelynn Circle",
                            "address_2": null,
                            "address_3": null,
                            "city": "North Wilburnland",
                            "country": "UK",
                            "postcode": "40117-2392",
                            "created_at": "2025-01-20T19:58:15+00:00"
                        },
                        "site_name": "London Bridge",
                        "language": "en",
                        "email_verified_at": "2025-01-20T19:58:16+00:00",
                        "metadata": [],
                        "created_at": "2025-01-20T19:58:16+00:00"
                    },
                    "note": "Ticket Raised",
                    "is_system": true,
                    "created_at": "2025-01-20T19:58:18+00:00"
                }
            ],
            "metadata": [],
            "created_at": "2025-01-20T19:58:21+00:00"
        }
    }
}

user.created

This event is fired when a new user is created. The payload contains the user that was created.

Payload example:

{
    "event": "user.created",
    "data": {
        "user": {
            "id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": null,
            "site_name": null,
            "language": "en",
            "email_verified_at": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:21+00:00"
        }
    }
}

user.updated

This event is fired when a user is updated. The payload contains the user that was updated.

Payload example:

{
    "event": "user.updated",
    "data": {
        "user": {
            "id": 1,
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "role": "gym_operator",
            "company": null,
            "site_name": null,
            "language": "en",
            "email_verified_at": null,
            "metadata": [],
            "created_at": "2025-01-20T19:58:21+00:00"
        }
    }
}

Security

To ensure the integrity of the request, each webhook call is signed using the secret key provided when the webhook was configured. You should validate the secret to make sure the request is from Orbit4.

To verify the signature, you need to implement a verification process on the receiving end of the webhook call. This process should take the payload and the signature from the headers, and use the SHA256 algorithm to calculate the signature from the payload. If the calculated signature matches the signature from the headers, the request is verified.

Here's an example of how to do this:

Example verify webhook signature Function:

def handle_webhook():
    payload = request.get_data()
    signature_from_headers = request.headers.get('X-Signature')

    secret = 'my-webhook-secret'
    calculated_signature = hmac.new(secret.encode(), payload, hashlib.sha256).hexdigest()

    if not hmac.compare_digest(signature_from_headers, calculated_signature):
        # 403, Invalid signature.
        return;

    if payload.event == 'ticket.created':
        # Handle ticket created event...

    # 200, Webhook received.
    return;

Handling Webhooks

Your server should respond to the webhook's POST request with a 2XX status code immediately after receiving the request. If the webhook request isn't acknowledged with a 2XX status code, Orbit4 will consider the webhook delivery a failure. In such cases, Orbit4 will try to send the webhook again.

As a best practice, we recommend storing the event payload upon receipt and processing it asynchronously. This approach prevents Orbit4 from repeatedly attempting to deliver the webhook due to immediate processing failures. By decoupling the receipt and processing of the webhook, you can enhance the reliability and efficiency of your webhook handling system.

Retries

If a webhook delivery fails, Orbit4 will retry sending the webhook. The retries begin with a 5-minute delay and subsequently double the waiting time after each failed attempt.

This pattern of increasing delays continues until the interval between retries reaches a maximum of 2 hours. Once this maximum delay is reached, any further retries that day occur at 2-hour intervals.

Orbit4 will make up to 13 attempts to deliver the webhook within a single day. If all attempts fail, the delivery is considered permanently unsuccessful for that day, and no further attempts will be made until the next scheduled event.