Skip to main content

getEnterpriseConnectionList()

Gets the list of enterprise connections for the instance. By default, the list is returned in descending order by creation date (newest first).

Returns a PaginatedResourceResponse object with a data property containing an array of EnterpriseConnection objects and a totalCount property containing the total number of enterprise connections for the instance.

function getEnterpriseConnectionList(params: EnterpriseConnectionListParams): Promise<PaginatedResourceResponse<EnterpriseConnection[]>>

EnterpriseConnectionListParams

  • Name
    active?
    Type
    boolean
    Description

    Filters enterprise connections by active status. If true, only active connections are returned. If false, only inactive connections are returned. If omitted, all connections are returned.

  • Name
    limit?
    Type
    number
    Description

    Maximum number of items returned per request. Must be an integer greater than zero and less than 501. Can be used for paginating the results together with offset. Defaults to 10.

  • Name
    offset?
    Type
    number
    Description

    Skip the first offset items when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit. Defaults to 0.

  • Name
    organizationId?
    Type
    string
    Description

    Filters enterprise connections by Organization ID.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const response = await clerkClient.enterpriseConnections.getEnterpriseConnectionList()

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET/enterprise_connections. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub