Cirqll Core
HomeCirqll
HomeCirqll
  1. Contract
  • Query Parameters
    • Eager Loading
    • Partial Data
    • Count Relations
    • Pagination
      • Filter
      • Order By
  • Authentication
    • OAuth2
      • Authorize
        • Authorize
      • User
        • Me
      • Client
        • Index
        • Create
        • Update
        • Delete
      • Token
        • Create
        • Refresh
        • Index
      • Scopes
  • User
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Role
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Customer
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Contact
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Appointment
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Task
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Financial
    • Chance
      • Index
      • Show
      • Create
      • Update
      • Delete
    • Assignment
      • Index
      • Show
      • Create
      • Update
      • Delete
    • Contract
      • Index
        GET
      • Show
        GET
      • Create
        POST
      • Update
        PATCH
      • Delete
        DELETE
  • Email
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Field
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Note
    • Index
    • Show
    • Create
    • Update
    • Delete
  • To-do
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Template
    • Index
    • Show
    • Update
    • Create
    • Delete
  • Setting
    • Index
    • Update
  • Webhook
    • Index
    • Show
    • Create
    • Update
    • Delete
  1. Contract

Index

GET
/contract
Financial
This endpoint allows you to fetch all the contracts 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"]
show[]
array[string]
optional
Select specific fields to show in the response object
See parameters for more info
Example:
["name","id","price"]
order_by[]
array[string]
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","price:asc"]
filter
string 
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 
optional
Specify how many items you want to fetch at a time
Example:
100
offset
integer 
optional
To fetch more than limit you need to increment this offset value each time you make a follow-up request.
Example:
0
Header Params
Accept
string 
optional
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.cirqll.nl/api/contract?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
data
array[object (Contract) {21}] 
required
The items
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
calculated_price
number 
read-onlyoptional
calculated value, read only
description
string 
optional
<= 65535 characters
end_date
string <date-time>
required
import_id
integer 
optional
>= 0<= 4294967296
name
string 
required
<= 255 characters
price
number 
required
price_type
integer 
required
1: monthly, 12: yearly
>= -2147483648<= 2147483647
Default:
1
reminder_date
string <date-time>
optional
start_date
string <date-time>
required
customer_id
integer <uint32>
required
customer
object 
Customer
read-onlyoptional
contact_id
integer <uint32>
required
contact
object 
Contact
required
chance_id
integer <uint32>
required
chance
object 
Chance
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
archived_at
string <date-time> | null 
required
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:
0
Example
{
  "data": [
    {
      "id": 1,
      "calculated_price": 0,
      "description": "string",
      "end_date": "2019-08-24T14:15:22Z",
      "import_id": 0,
      "name": "string",
      "price": 0,
      "price_type": "1",
      "reminder_date": "2019-08-24T14:15:22Z",
      "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"
      },
      "contact_id": 0,
      "contact": {
        "id": 1,
        "archived_at": "2019-08-24T14:15:22Z",
        "email": "string",
        "first_name": "string",
        "function": "string",
        "import_id": 0,
        "last_name": "string",
        "more_info": "string",
        "phone": "string",
        "created_at": "2024-05-18 13:38:35",
        "updated_at": "2024-05-18 13:38:35"
      },
      "chance_id": 0,
      "chance": {
        "id": 1,
        "name": "string",
        "price": 0,
        "description": "string",
        "percentage": 0,
        "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"
          }
        },
        "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",
      "archived_at": "2019-08-24T14:15:22Z",
      "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
Modified at 2025-05-06 02:34:32
Previous
Contract
Next
Show
Built with