Index - Cirqll Core

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://api.cirqll.nl/api/field?with[]=customer&with[]=user&show[]=name&show[]=id&show[]=price&order_by[]=id:desc&order_by[]=name&order_by[]=price:asc&filter=customer_id:in:28;29;30&limit=100&offset=0' \
--header 'Accept: application/json'

Responses

🟢200Success

application/json

Body

Example

{
    "data": [
        {
            "id": 1,
            "name": "string",
            "type": "text",
            "category": "customer",
            "required": false,
            "created_at": "2024-05-18 13:38:35",
            "updated_at": "2024-05-18 13:38:35",
            "user_id": 0,
            "user": {
                "id": 1,
                "name": "Casey Dach",
                "email": "string",
                "created_at": "2024-05-18 13:38:35",
                "updated_at": "2024-05-18 13:38:35",
                "company_id": 0,
                "company": {
                    "id": 1,
                    "name": "string",
                    "phone": "1-310-793-5469",
                    "coc": "string",
                    "financial_goal": 0,
                    "address_id": 0,
                    "address": {
                        "id": 1,
                        "street": "Georgianna Loop",
                        "house_number": 12,
                        "addition": "A",
                        "zipcode": "45668",
                        "city": "Lake Quentinmouth",
                        "province": "DR",
                        "country": "NL",
                        "extra_address_line_one": "string",
                        "extra_address_line_two": "string",
                        "lat": 0,
                        "lon": 0,
                        "created_at": "2024-05-18 13:38:35",
                        "updated_at": "2024-05-18 13:38:35"
                    },
                    "created_at": "2024-05-18 13:38:35",
                    "updated_at": "2024-05-18 13:38:35"
                }
            },
            "company_id": 0,
            "company": {
                "id": 1,
                "name": "string",
                "phone": "1-310-793-5469",
                "coc": "string",
                "financial_goal": 0,
                "address_id": 0,
                "address": {
                    "id": 1,
                    "street": "Georgianna Loop",
                    "house_number": 12,
                    "addition": "A",
                    "zipcode": "45668",
                    "city": "Lake Quentinmouth",
                    "province": "DR",
                    "country": "NL",
                    "extra_address_line_one": "string",
                    "extra_address_line_two": "string",
                    "lat": 0,
                    "lon": 0,
                    "created_at": "2024-05-18 13:38:35",
                    "updated_at": "2024-05-18 13:38:35"
                },
                "created_at": "2024-05-18 13:38:35",
                "updated_at": "2024-05-18 13:38:35"
            }
        }
    ],
    "limit": 100,
    "total": 0,
    "offset": 0
}

🟠401Not Logged In

🔴500Server Error