Cirqll Core
HomeCirqll
HomeCirqll
  1. Template
  • 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
      • Show
      • Create
      • Update
      • 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
      GET
    • Show
      GET
    • Update
      PATCH
    • Create
      POST
    • Delete
      DELETE
  • Setting
    • Index
    • Update
  • Webhook
    • Index
    • Show
    • Create
    • Update
    • Delete
  1. Template

Index

GET
/template
This endpoint allows you to fetch all the templates 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/template?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
array of:
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
name
string 
required
<= 255 characters
user_id
integer <uint32>
required
user
object 
User
optional
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
name
string 
required
<= 255 characters
Examples:
Casey DachMakayla BashirianMiracle Langworth
email
string 
required
<= 255 characters
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
company_id
integer <uint32>
required
company
object 
Company
read-onlyoptional
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
notes
array[object (Note) {10}] 
read-onlyrequired
ID
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
description
string 
required
<= 255 characters
template_id
integer 
required
>= 0<= 4294967296
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
name
string 
required
<= 255 characters
user_id
integer <uint32>
required
user
object 
User
optional
notes
array[object (Note) {10}] 
read-onlyrequired
ID
tasks
array[object (Task) {9}] 
read-onlyrequired
tasks
array[object (Task) {9}] 
read-onlyrequired
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
name
string 
required
<= 255 characters
template_id
integer 
required
>= 0<= 4294967296
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
notes
array[object (Note) {10}] 
read-onlyrequired
ID
tasks
array[object (Task) {9}] 
read-onlyrequired
Example
[
  {
    "id": 1,
    "name": "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"
      }
    },
    "created_at": "2024-05-18 13:38:35",
    "updated_at": "2024-05-18 13:38:35",
    "notes": [
      {
        "id": 1,
        "description": "string",
        "template_id": 0,
        "created_at": "2024-05-18 13:38:35",
        "updated_at": "2024-05-18 13:38:35"
      }
    ],
    "tasks": [
      {
        "id": 1,
        "name": "string",
        "template_id": 0,
        "created_at": "2024-05-18 13:38:35",
        "updated_at": "2024-05-18 13:38:35"
      }
    ]
  }
]
🟠401Not Logged In
🔴500Server Error
Modified at 2025-05-06 02:34:32
Previous
Template
Next
Show
Built with