MEmetorial
Provider Setup Sessions

List provider setup sessions

Returns a paginated list of provider setup sessions.

get/provider-setup-sessions

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Query parameters

limitnumber
afterstring
beforestring
cursorstring
order'asc' | 'desc'
string
OR
string[]

Filter by setup session ID(s)

string
OR
string[]

Filter by provider ID(s)

string
OR
string[]

Filter by provider deployment ID(s)

string
OR
string[]

Filter by auth method ID(s)

string
OR
string[]

Filter by provider auth config ID(s)

string
OR
string[]

Filter by provider auth credentials ID(s)

'archived' | 'failed' | 'completed' | 'expired' | 'pending'
OR
string[]

Filter by session status (archived, failed, completed, expired, pending)

'auth_only' | 'config_only' | 'auth_and_config' | 'admin'
OR
string[]

Filter by session type (auth_only, config_only, auth_and_config, admin), matching either the requested or the resolved type

gtstring date-time

Only include records after this timestamp for provider setup session creation time

ltstring date-time

Only include records before this timestamp for provider setup session creation time

Filter provider setup session creation time by date range

gtstring date-time

Only include records after this timestamp for provider setup session last update time

ltstring date-time

Only include records before this timestamp for provider setup session last update time

Filter provider setup session last update time by date range

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Response

Successful response

Example response

{
  "items": [
    {
      "id": "pas_6eFgHjKlMnPqRsTu",
      "url": "https://provider.metorial.com/setup/pas_6eFgHjKlMnPqRsTu",
      "error": {
        "code": "consent_required",
        "message": "consent_required: AADSTS90094: Admin consent is required."
      },
      "name": "GitHub OAuth Setup",
      "description": "Connect your GitHub account",
      "provider_id": "pro_5gHjKlMnPqRsTuVw",
      "identity_id": "idn_3nOpRsTuVwXyZaBc",
      "identity_credential_id": "idc_3nOpRsTuVwXyZaBc",
      "auth_method": {
        "id": "pam_2mNpQrStUvWxYzAb",
        "key": "oauth2",
        "name": "OAuth 2.0",
        "description": "Authenticate using OAuth 2.0",
        "scopes": [
          {
            "id": "pams_8tUvWxYzAbCdEfGh",
            "scope": "repo",
            "name": "Repository Access",
            "description": "Full control of private repositories"
          }
        ],
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "provider_specification_id": "psp_9gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "deployment": {
        "id": "pde_1aBcDeFgHjKlMnPq",
        "name": "Production",
        "description": "Production deployment",
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "credentials": {
        "id": "par_4sTuVwXyZaBcDeFg",
        "is_default": true,
        "is_managed": true,
        "name": "GitHub OAuth",
        "description": "OAuth credentials for GitHub API",
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "auth_config": {
        "id": "pac_8pQrStUvWxYzAbCd",
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "name": "GitHub OAuth Token",
        "description": "OAuth token for GitHub API access",
        "deployment": {
          "id": "pde_1aBcDeFgHjKlMnPq",
          "name": "Production",
          "description": "Production deployment",
          "provider_id": "pro_5gHjKlMnPqRsTuVw",
          "created_at": "2025-09-15T10:30:00.000Z",
          "updated_at": "2026-01-10T14:45:00.000Z"
        },
        "credentials": {
          "id": "par_4sTuVwXyZaBcDeFg",
          "is_default": true,
          "is_managed": true,
          "name": "GitHub OAuth",
          "description": "OAuth credentials for GitHub API",
          "provider_id": "pro_5gHjKlMnPqRsTuVw",
          "created_at": "2025-09-15T10:30:00.000Z",
          "updated_at": "2026-01-10T14:45:00.000Z"
        },
        "auth_method": {
          "id": "pam_2mNpQrStUvWxYzAb",
          "key": "oauth2",
          "name": "OAuth 2.0",
          "description": "Authenticate using OAuth 2.0",
          "scopes": [
            {
              "id": "pams_8tUvWxYzAbCdEfGh",
              "scope": "repo",
              "name": "Repository Access",
              "description": "Full control of private repositories"
            }
          ],
          "provider_id": "pro_5gHjKlMnPqRsTuVw",
          "provider_specification_id": "psp_9gHjKlMnPqRsTuVw",
          "created_at": "2025-09-15T10:30:00.000Z",
          "updated_at": "2026-01-10T14:45:00.000Z"
        },
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "config": {
        "id": "pcf_7dEfGhJkLmNpQrSt",
        "name": "Production Config",
        "description": "Configuration for production environment",
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "specification_id": "psp_9gHjKlMnPqRsTuVw",
        "deployment": {
          "id": "pde_1aBcDeFgHjKlMnPq",
          "name": "Production",
          "description": "Production deployment",
          "provider_id": "pro_5gHjKlMnPqRsTuVw",
          "created_at": "2025-09-15T10:30:00.000Z",
          "updated_at": "2026-01-10T14:45:00.000Z"
        },
        "from_vault": {
          "id": "pcvt_3bCdEfGhJkLmNpQr",
          "name": "Production Secrets",
          "description": "Secure storage for production credentials",
          "provider_id": "pro_5gHjKlMnPqRsTuVw",
          "deployment": {
            "id": "pde_1aBcDeFgHjKlMnPq",
            "name": "Production",
            "description": "Production deployment",
            "provider_id": "pro_5gHjKlMnPqRsTuVw",
            "created_at": "2025-09-15T10:30:00.000Z",
            "updated_at": "2026-01-10T14:45:00.000Z"
          },
          "created_at": "2025-09-15T10:30:00.000Z",
          "updated_at": "2026-01-10T14:45:00.000Z"
        },
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "redirect_url": "https://app.example.com/callback",
      "created_at": "2025-09-15T10:30:00.000Z",
      "updated_at": "2026-01-10T14:45:00.000Z",
      "expires_at": "2025-09-15T11:30:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.