Epic Games Connect API

The Connect API from Epic Games — 1 operation(s) for connect.

OpenAPI Specification

epic-games-connect-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Epic Online Services Web Achievements Connect API
  version: 1.0.0
  description: REST surface of Epic Online Services (EOS). Provides cross-platform game backend capabilities including OAuth-based authentication, the Connect Interface (product user ID exchange), Player Data and Title Storage, Achievements, Stats, Leaderboards, Friends, Lobby/Sessions, Sanctions, and Ecom entitlements. All requests are gated behind an Epic developer organization, sandbox, and client credentials issued in the EOS Developer Portal. Best-effort spec derived from publicly documented surfaces; not exhaustive.
  contact:
    name: Epic Online Services
    url: https://dev.epicgames.com/docs/web-api-ref
  license:
    name: Proprietary
servers:
- url: https://api.epicgames.dev
  description: Epic Online Services production base URL
security:
- oauthClientCredentials: []
- bearerAuth: []
tags:
- name: Connect
paths:
  /connect/v1/{deploymentId}/users:
    get:
      tags:
      - Connect
      summary: Look up product user IDs for external accounts
      operationId: queryConnectUsers
      parameters:
      - in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - in: query
        name: externalAccountType
        schema:
          type: string
      - in: query
        name: externalAccountId
        schema:
          type: string
      responses:
        '200':
          description: Connect user mappings
components:
  securitySchemes:
    oauthClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.epicgames.dev/auth/v1/oauth/token
          scopes:
            basic_profile: Basic profile access
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: EOS bearer access token issued by the OAuth token endpoint.