Get Deal Stage - Gofive OpenAPI

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

boardId

integer

optional

your board Id

Header Params

Ocp-Apim-Subscription-Key

string

optional

Example:

<Your-Subscription-Key>

Content-Type

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.gofive.co.th/v1/deals/stages?boardId' \
--header 'Ocp-Apim-Subscription-Key: <Your-Subscription-Key>' \
--header 'Content-Type: application/json'

Responses

🟢200Success

application/json

Body

data

array [object {4}]

required

id

integer

required

stageName

string

required

ชื่อสถานะดีล

stageType

integer

required

ประเภทสถานะดีล

seq

integer

required

สำดับของสถานะ

statusCode

integer

required

httpStatusCode

integer

required

สถานะ code ของ httpเช่น 200 Ok 201 Created 400 BadRequest 401 Unauthorized 403 Forbidden 404 Record not found 500 Internal Server Error

Example

{
    "data": [
        {
            "id": 701,
            "stageName": "Open",
            "stageType": 2,
            "seq": -2
        },
        {
            "id": 702,
            "stageName": "InProgress",
            "stageType": 2,
            "seq": -1
        },
        {
            "id": 703,
            "stageName": "Won",
            "stageType": 2,
            "seq": 97
        },
        {
            "id": 704,
            "stageName": "Missed",
            "stageType": 2,
            "seq": 98
        }
    ],
    "statusCode": 1000,
    "httpStatusCode": 200
}

🟠401User authentication required V2.