Skip to main content

PaginatedResponse_ExternalApiConnectorWithEndpointCountArray

successboolean
Constant value: true
meta object
currentPageinteger
totalinteger
perPageinteger
lastPageinteger
data object[]
  • Array [
    • idinteger
    namestring
    slugstring
    descriptionstring | nullnullable
    baseUrlstring<uri>
    authTypeConnectorAuthType (string)

    Possible values: [api-key, api-key-query, bearer-token, oauth2-client-credentials, none]

    authParamNamestring
    authSchemestring | nullnullable
    oauthTokenUrlstring,null<uri>nullable
    oauthClientIdstring | nullnullable
    oauthScopestring | nullnullable
    oauthClientAuthMethod object
    oneOf
    OAuthClientAuthMethod (string)

    How the connector authenticates to its OAuth2 token endpoint: basic sends credentials in an Authorization: Basic header, body sends client_id/client_secret in the form body.

    Possible values: [basic, body]

    oauthTokenExpiresAtstring,null<date-time>nullable
    defaultHeaders object
    property name*string
    openApiSpecobject | nullnullable
    specVersionstring | nullnullable

    Possible values: [2.0, 3.0, 3.1, null]

    statusConnectorStatus (string)

    Possible values: [active, paused, suspended]

    isPublicboolean
    defaultTimeoutinteger
    organizationIdinteger
    createdAtstring<date-time>
    updatedAtstring<date-time>
    deletedAtstring,null<date-time>nullable
    endpointCountinteger

    Count of this connector's non-deleted, enabled endpoints.

  • ]
    • PaginatedResponse_ExternalApiConnectorWithEndpointCountArray
    {
      "success": true,
      "meta": {
        "currentPage": 0,
        "total": 0,
        "perPage": 0,
        "lastPage": 0
      },
      "data": [
        {
          "id": 0,
          "name": "string",
          "slug": "string",
          "description": "string",
          "baseUrl": "string",
          "authType": "api-key",
          "authParamName": "string",
          "authScheme": "string",
          "oauthTokenUrl": "string",
          "oauthClientId": "string",
          "oauthScope": "string",
          "oauthClientAuthMethod": "basic",
          "oauthTokenExpiresAt": "2024-07-29T15:51:28.071Z",
          "defaultHeaders": {},
          "openApiSpec": "Unknown Type: object,null",
          "specVersion": "2.0",
          "status": "active",
          "isPublic": true,
          "defaultTimeout": 0,
          "organizationId": 0,
          "createdAt": "2024-07-29T15:51:28.071Z",
          "updatedAt": "2024-07-29T15:51:28.071Z",
          "deletedAt": "2024-07-29T15:51:28.071Z",
          "endpointCount": 0
        }
      ]
    }