Errors

Errors are returned as part of the GraphQL response. You can find them in the errors field of the response object.

Errors can be returned in a variety of situations, such as when a query is invalid, when an argument is missing, when a field is not available, or if the server is unable to fulfill the request.

Always check the errors field of the response object to see if there are any errors. Errors can contain positional information about where the error occurred in the query, which can be useful for debugging.

WARNING

Even if you receive an HTTP status code of 200, you may still receive an error. This is because the GraphQL server may return an error even if the request was successful.

Example

{
  "errors": [
    {
      "message": "Cannot query field \"team\" on type \"PortfolioV2\". Did you mean \"teamId\"?",
      "extensions": {
        "code": "GRAPHQL_VALIDATION_FAILED",
      }
    }
  ]
}

Validation Errors

When making a request that doesn't pass our validation rules, you'll receive a similar error to the one above.

You may display the error messages to the user if you wish.

{
  "errors": [
    {
      "message": "Argument \"teamId\" has invalid value \"abc\".",
      "locations": {
        "0": {
          "line": 3,
          "column": 25
        }
      },
      "extensions": {
        "code": "INTERNAL_SERVER_ERROR"
      }
    }
  ]
}