Docs

ClerkBackendApiResponse

A generic type that describes the response of a method that calls the Clerk Backend API.

Properties

  • Name
    data
    Type
    <T> | null
    Description

    The payload of the request. <T> represents the type of the data, which depends on which API request was made.

  • Name
    errors
    Type
    ClerkAPIError[] | null
    Description

    An array of errors that have occurred.

  • Name
    totalCount?
    Type
    never
    Description

    The number of items in the response. Useful because Clerk's API responses are paginated.

  • Name
    clerkTraceId?
    Type
    string
    Description

    The ID associated with the function trace for your API call. Clerk support can use this to check any logs associated with your API call and help you debug issues.

  • Name
    status?
    Type
    number
    Description
  • Name
    statusText?
    Type
    string
    Description

    The status message associated with the HTTP response code.

Feedback

What did you think of this content?