Show

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

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"]

Header Params

string

optional

Default:

application/json

Responses

🟢200Success

application/json

Body

integer <uint32>

read-onlyrequired

Unique identifier of entity

>= 1<= 4294967296

Example:

name

string <char>

required

Name of the chance

>= 0 characters<= 255 characters

price

number <float>

required

Value of the chance, is used for the financial dashboard to get your earnings in the selected date frame

>= 0

description

string <char>

optional

Description which can be left to inform other colleagues of the progress or give context

<= 65535 characters

percentage

integer <int32>

required

Succesrate percentage of a chance completing

>= 0<= 100

customer_id

integer <uint32>

required

customer

object

Customer

read-onlyoptional

integer <uint32>

read-onlyrequired

Unique identifier of entity

>= 1<= 4294967296

Example:

name

string

required

next_contact

string <date-time>

required

string <email>

required

<= 255 characters

Example:

cleora42@gmail.com

phone

string

required

<= 255 characters

Example:

1-848-429-9425

show_on_map

boolean

required

Default:

true

coc

string <char>

optional

<= 8 characters

description

string

optional

user_id

integer <uint32>

required

user

object

User

optional

address_id

integer <uint32>

required

address

object

Address

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

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

Example

{
  "id": 1,
  "name": "string",
  "price": 0,
  "description": "string",
  "percentage": 0,
  "customer_id": 0,
  "customer": {
    "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": {
      "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"
      }
    },
    "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"
  },
  "created_at": "2024-05-18 13:38:35",
  "updated_at": "2024-05-18 13:38:35",
  "archived_at": "2019-08-24T14:15:22Z"
}

🟠404Record Not Found

🟠401Not Logged In

🔴500Server Error

Request

Request samples

Responses