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

Show

GET
/todo/{id}
This endpoint allows you to fetch a todo based on the passed id

Request

Authorization
Add the parameter
Authorization
to Headers，whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Path Params
id
integer <uint32>
required
ID field represents an entity in the database and is also the primary key which can be used to load relations.
Default:
1
Example:
5
Query Params
with[]
array[string] | null 
optional
Eager load related items
See parameters for more info
Example:
["user"]
show[]
array[string]
optional
Select specific fields to show in the response object
See parameters for more info
Example:
["id","description"]
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 --request GET 'https://api.cirqll.nl/api/todo/5' \
--header 'Accept: application/json'

Responses

🟢200Success
application/json
Body
id
integer <uint32>
read-onlyrequired
Unique identifier of entity
>= 1<= 4294967296
Example:
1
description
string 
required
<= 65535 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
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
Example
{
  "id": 1,
  "description": "string",
  "user_id": 0,
  "user": {
    "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": {
      "name": "string",
      "phone": "1-310-793-5469",
      "coc": "string",
      "financial_goal": 0,
      "address_id": 0,
      "address": {
        "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"
}
🟠404Record Not Found
🟠401Not Logged In
🔴500Server Error
Modified at 2025-05-06 02:34:32
Previous
Index
Next
Create
Built with