Index - Cirqll Core

This endpoint allows you to fetch all the appointments with additional filters

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

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

Query Params

with[]

array[string] | null

optional

Eager load related items

See parameters for more info

Example:

["customer","user","chances","assignments","contacts","contracts","imports","users"]

show[]

array[string] | null

optional

Select specific fields to show in the response object

See parameters for more info

Example:

["id","name"]

order_by[]

array[string] | null

optional

Order the data by one or more fields

You can either order ascendingly or descendingly by using asc and desc. The default order_by is id:asc. Nested items are not supported. See parameters for more info.

Example:

["id:desc","name"]

filter

string | null

optional

Filter the results with a filter query like field:operator:value

See parameters for more info

Example:

customer_id:in:28;29;30

limit

integer <uint32>

optional

Specify how many items you want to fetch at a time

>= 1<= 100

Default:

100

Example:

100

offset

integer <uint32>

optional

To fetch more than limit you need to increment this offset value each time you make a follow-up request.

>= 0

Default:

Example:

Header Params

string

optional

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

array[object (Appointment) {13}]

required

The items

integer <uint32>

read-onlyrequired

Unique identifier of entity

>= 1<= 4294967296

Example:

description

string | null

optional

<= 65535 characters

end_date

string <date-time>

required

location

string | null

optional

<= 255 characters

name

string

required

<= 255 characters

start_date

string <date-time>

required

customer_id

integer <uint32>

required

customer

object

Customer

read-onlyoptional

archived_at

string <date-time> | null

required

created_at

string <date-time>

read-onlyrequired

Date at which the entity was created

Example:

2024-05-18 13:38:35

updated_at

string <date-time>

read-onlyrequired

Date at which the entity was last changed

Example:

2024-05-18 13:38:35

user_id

integer <uint32>

required

user

object

User

optional

limit

integer <uint>

required

The maximum amount of items that were fetched

The actual count of the data may be lower than this number

>= 1

Default:

100

total

integer <uint>

required

The total number of items that exist

filter is taken into account

>= 0

offset

integer <uint>

required

The item offset

If total is more than the limit, then the offset is used to fetch the other pages. pages=total/limit, to get page 3 use offset=total/limit*3

>= 0

Default:

Example

{
  "data": [
    {
      "id": 1,
      "description": "string",
      "end_date": "2019-08-24T14:15:22Z",
      "location": "string",
      "name": "string",
      "start_date": "2019-08-24T14:15:22Z",
      "customer_id": 0,
      "customer": {
        "id": 1,
        "name": "string",
        "next_contact": "2019-08-24T14:15:22Z",
        "email": "cleora42@gmail.com",
        "phone": "1-848-429-9425",
        "show_on_map": true,
        "coc": "string",
        "description": "string",
        "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"
          }
        },
        "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"
      },
      "archived_at": "2019-08-24T14:15:22Z",
      "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"
        }
      }
    }
  ],
  "limit": 100,
  "total": 0,
  "offset": 0
}

🟠401Not Logged In

🔴500Server Error