Skip to main content
Docs

ClerkAPIResponseError

An interface that represents an error returned by the Clerk API.

Properties

  • Name
    clerkError
    Type
    true
    Description

    Always true, marks this as a Clerk API error.

  • Name
    status
    Type
    number
    Description

    The HTTP status code returned by the API.

  • Name
    message
    Type
    string
    Description

    The main error message.

  • Name
    clerkTraceId?
    Type
    string
    Description

    Optional. A trace ID from Clerk for debugging or support.

  • Name
    retryAfter?
    Type
    number
    Description

    Optional. If set, tells you how many seconds to wait before retrying (from Retry-After header).

  • Name
    errors
    Type
    ClerkAPIError[]
    Description

    An array of error objects with more details about what went wrong.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on