HTTP responses

HTTP STATUS

The API uses HTTP responses to indicate success or error.

HTTP status	Description	Detail description
200	OK	- Standard response for successful HTTP requests.
202	Accepted	- The request has been accepted for processing, but the processing has not been completed.
400	Bad Request	- Invalid JSON request - Business logic error - No operation/data permission - Parameter error
401	Unauthorized	- OAuth token/API key is missing or invalid/expired.
404	Not Found	- The requested resource could not be found but may be available in the future.
429	Too Many Requests	- The user has sent too many requests in a given amount of time.
500	Server Error	- Internal service error.

RESPONSE BODY OBJECT

Property	Type	Description
code	integer	Service status code, represents the status code of the API response. It is used to indicate the result of the request and whether it was successful or encountered an error.
message	string	Provides a human-readable description of the result or error encountered during the API request.
data	object	Contains the actual data returned by the API request.

SERVICE STATUS

Service status code	Description	Detail Description
0	OK	Request successful
10000	SYSTEM_ERROR	Internal service error.
10001	BAD_REQUEST	- Invalid JSON request - Business logic error - Parameter error
10002	UNAUTHORIZED	OAuth token/API key is missing or invalid/expired.
10003	NO_PERMISSION	No operation/data permission
10004	EMAIL_NOT_VERIFIED	The user's mailbox is not verified
10005	PLAN_EXHAUSTED	Exceed the plan usage limit
10006	TOO_MANY_REQUESTS	The user has sent too many requests in a given amount of time.

RESPONSE EXAMPLE

JSON

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "jkdakdqc1vb",
    "name": "Aaron",
    "email": "[email protected]",
    "defaultWorkspaceId": "7e3ydi936o",
    "timezone": "UTC",
    "language": "en",
    "emailVerified": true,
    "emailVerifiedAt": "2023-06-02 08:09:12",
    "createdAt": "2023-06-02 08:06:08",
    "updatedAt": "2023-06-18 00:21:16"
  }
}