Skip to main content
Version: 1.1beta1

Response format

type: object


jsonrpcstring("2.0")AlwaysWill always be "2.0".
idanyAlwaysThe client-side ID used for the request.
resultResultOn successThe result of a successful method call. In Clarify, the return type is always an object. The exact structure of the object depend on the method that was called.
errorErrorOn failureThe result of a failed RPC method. In Clarify, we define our own structure for the error data field.
response body example
"jsonrpc": "2.0",
"id": 1,
"result": {...}
response body example (error)
"jsonrpc": "2.0",
"id": 1,
"error": {
"code": -32602,
"message": "Invalid params",
"data": {
"trace": "00000000000000000000",
"params": {
"integration": ["required"]


type: object

In Clarify, the result of an RPC request is always an object. The exact keys that are present depend on the method that was called and the parameters that where provided. If a result is present, it means the call succeeded.


Error describe the standardized JSON RPC 2.0 error format, as well as a clarify specific data field and error codes. When an error is present, the result portion will be empty.

type: object


codeintegerYesA code describing the error type.
messagestringYesA textual description of the error.
dataError DataNoAn object describing more details related to the error. The structure of the ErrorData object is Clarify specific.

Error Data

Error Data is a Clarify specific format for embedding useful error information.

type: object

tracestringAlwaysA unique ID that can be supplied to the Clarify Support team to help us debug what happened for a particular failed request.
paramsmap of string => array of stringOptionalPresent when the error code and message can be traced back to specified parameters.

Error codes

Below is a list of the possible values for the code field. Codes written with a bold font are specific to Clarify, while the other codes are defined by the JSON RPC 2.0 specification.

-32700ErrParseInvalidJSONIndicates invalid JSON is received by the server.
-32600ErrInvalidRequestIndicates the sent JSON is not a valid Request object.
-32601ErrMethodNotFoundIndicates the method does not exist / is not available.
-32602ErrInvalidParamsIndicates invalid method parameter(s).
-32603ErrInternalIndicates an internal JSON-RPC error.
-32000ErrServerIndicates a generic server error.
-32001ErrProduceInvalidResourcesProduce invalid resource(s) in Clarify.
-32002ErrFoundInvalidResourceFound invalid resource(s) or code issue in Clarify.
-32003ErrForbiddenIndicates that the requested operation is not permitted by your current access token, or that the input parameters are referencing a resource that isn't accessible / doesn't exist.
-32009ErrConflictIndicates a conflicts with current state of Clarify resource(s).
-32015TryAgainIndicates that the response should be called again later. Maybe returned in the case of temporal errors or rate limited requests.