Show - Cirqll Core

This endpoint allows you to fetch a field 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

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:

Example:

Query Params

with[]

array[string] | null

optional

Eager load related items

See parameters for more info

Example:

["address","user"]

show[]

array[string]

optional

Select specific fields to show in the response object

See parameters for more info

Example:

["name","id","phone"]

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

integer <uint32>

read-onlyrequired

Unique identifier of entity

>= 1<= 4294967296

Example:

name

string

required

name

<= 255 characters

type

enum<string>

required

<= 65535 characters

Allowed values:

textselectdateyesnopricemultiselecturl

category

enum<string>

required

Allowed values:

customercontactfinancial

required

boolean

optional

Default:

false

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

integer <uint32>

read-onlyrequired

Unique identifier of entity

>= 1<= 4294967296

Example:

name

string

required

<= 255 characters

Examples:

Casey DachMakayla BashirianMiracle Langworth

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

company_id

integer <uint32>

required

company

object

Company

read-onlyoptional

Example

{
  "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": {
    "name": "Casey Dach",
    "email": "string",
    "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
      }
    }
  },
  "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
    }
  }
}

🟠404Record Not Found

🟠401Not Logged In

🔴500Server Error