> ## Documentation Index
> Fetch the complete documentation index at: https://docs.platform.gamezop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Match Result API

> This API allows you to pull data from Gamezop's systems for any multiplayer match played by your users.

<Note>This feature is only available with paid plans. [Contact us](https://business.gamezop.com/contact-us/enquire-now) to know more.</Note>

## About this API

In addition to us [posting match winners' data to you](/publishers/gamezop/advanced/multiplayer-games/receive-winners-data) on your endpoint, you can use this API to pull data from Gamezop's systems for any match played by your users.

The `match_id` you query with is the same `match_id` that you return to us via your [Create Match API](/publishers/gamezop/advanced/multiplayer-games/receive-winners-data#create-match-api).

***

## API specification


## OpenAPI

````yaml /openapi-gzp.json get /v1/match-result
openapi: 3.1.0
info:
  title: Gamezop APIs
  version: 1.0.0
  description: >-
    OpenAPI specification for Gamezop endpoints including game catalog,
    leaderboard metadata, and other integration APIs.
servers:
  - url: https://api.gamezop.com
    description: Gamezop API
security:
  - bearerAuth: []
paths:
  /v1/match-result:
    get:
      summary: Get Match Result API
      description: >-
        This API allows you to pull data from Gamezop's systems for any
        multiplayer match played by your users.
      operationId: getMatchResult
      parameters:
        - name: match_id
          in: query
          required: true
          description: >-
            The `match_id` that you want match result for. This is the same
            `match_id` that you return to us via your [Create Match
            API](/publishers/gamezop/advanced/multiplayer-games/receive-winners-data#create-match-api).
          schema:
            type: string
          example: ab9ce5a2995c5da2047a
      responses:
        '200':
          description: HTTP 200 OK. Returns match result data for the requested match.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatchResultResponse'
              examples:
                sample:
                  summary: Example response
                  value:
                    data:
                      property_id: '1234'
                      game_code: rJWyhp79RS
                      room_id: SNAKE_AND_LADDERS_5e0
                      match_id: ab9ce5a2995c5da2047a
                      scores:
                        - sub: '1257722'
                          is_bot: false
                          rank: 1
                          score: 10
                        - sub: '3800'
                          is_bot: true
                          rank: 2
                          score: 9
                      match_status: COMPLETED
                      match_start_time: '2025-06-11T06:00:00.000Z'
                    success: true
                    message: ''
        '400':
          description: >-
            Bad Request. Occurs when the `match_id` parameter is invalid or
            missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidMatchId:
                  summary: match_id is invalid or missing
                  value:
                    message: match_id is invalid or missing.
                    success: false
        '401':
          description: Unauthorized. Occurs when the Bearer token is invalid or missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidToken:
                  summary: Bearer token is invalid or missing
                  value:
                    message: Bearer token is invalid or missing.
                    success: false
components:
  schemas:
    MatchResultResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MatchResultData'
        success:
          type: boolean
          description: >-
            Boolean value that is always `true`, unless there is an error in the
            API response.
        message:
          type: string
          description: >-
            String value that is always empty, unless there is an error in the
            API response.
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
        success:
          type: boolean
    MatchResultData:
      type: object
      properties:
        property_id:
          type: string
          description: >-
            Your Gamezop Property ID associated with the bearer token that you
            sent in the request.
        game_code:
          type: string
          description: >-
            The Gamezop game code on which the match was played. You can get
            game codes for all Gamezop games enabled for you via the [All Games
            API](/publishers/gamezop/types-of-integration/all-games-api).
        room_id:
          type: string
          description: >-
            The Room ID that you passed to us in the `roomDetails` object when
            [generating the game
            link](/publishers/gamezop/advanced/multiplayer-games#generating-game-links-for-multiplayer-games).
        match_id:
          type: string
          description: The `match_id` that you're requesting data for.
        scores:
          type: array
          description: >-
            Array of player score objects (one per participant). Each object
            includes `sub`, `is_bot`, `rank`, and `score`.
          items:
            $ref: '#/components/schemas/MatchScore'
        match_status:
          type: string
          enum:
            - COMPLETED
            - IN_PROGRESS
          description: Match status.
        match_start_time:
          type: string
          format: date-time
          description: UTC timestamp representing the time at which the match started.
    MatchScore:
      type: object
      properties:
        sub:
          type: string
          description: >-
            Your user identifier for the player. This is the identifier that you
            pass to us in the `roomDetails` object when [generating the game
            link](/publishers/gamezop/advanced/multiplayer-games#generating-game-links-for-multiplayer-games).
            Specifically, you pass this within the `user` object within
            `roomDetails`.
        is_bot:
          type: boolean
          description: Whether the player was a bot.
        rank:
          type: integer
          description: Player's rank within the match. Rank `1` is the winner.
        score:
          type: number
          description: Player's latest score within that match.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: UUID
      description: >-
        You can find the Bearer token for this API under Settings & Admin > API
        Tokens within the [Gamezop Business
        Dashboard](https://dashboard.gamezop.com).

````