openapi: 3.2.0
info:
  title: Livelike Leaderboards API
  version: '1'
  description: 'Operations tagged Leaderboards across 2 of this provider''s published API definitions: livelike-leaderboards-openapi.yml, livelike-programs-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://cf-blast.livelikecdn.com/api/v1/leaderboards
- url: https://cf-blast.livelikecdn.com/api/v1/programs
security:
- {}
tags:
- name: Leaderboards
paths:
  /:
    get:
      summary: List Leaderboards
      description: ''
      operationId: list-leaderboards
      parameters:
      - name: client_id
        in: query
        description: Filter results by client ID
        schema:
          type: string
      - name: program_id
        in: query
        description: Filter results by linked program IDs
        schema:
          type: string
      - name: attributes
        in: query
        description: Filter result by attributes, should be passed as attributes=key:value
        schema:
          type: string
      - name: is_locked
        in: query
        description: Filter result by whether a leaderboard is locked or not.
        schema:
          type: boolean
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"count\": 1,\n  \"next\": null,\n  \"previous\": null,\n  \"results\": [\n    {\n      \"id\": \"example-leaderboard-1\",\n      \"url\": \"https://cf-blast.livelikecdn.com/api/v1/leaderboards/example-leaderboard-1/\",\n      \"client_id\": \"example-app-1\",\n      \"name\": \"LiveLike Points Leaders\",\n      \"reward_item\": {\n          \"id\": \"5e1016ef-9cf8-450f-9ad6-5e3996f1cbb0\",\n          \"url\": \"https://cf-blast.livelikecdn.com/api/v1/reward-items/5e1016ef-9cf8-450f-9ad6-5e3996f1cbb0/\",\n          \"client_id\": \"example-app-1\",\n          \"name\": \"LiveLike Points\"\n      },\n      \"attributes\":[\n        {\n          \"key\": \"key1\",\n          \"value\": \"value1\"\n        }\n      ]\n      \"reward_item_id\": \"5e1016ef-9cf8-450f-9ad6-5e3996f1cbb0\",\n      \"is_locked\": false,\n      \"entries_url\": \"https://blastrt-prod-us-east-1.livelikecdn.com/services/leaderboards/{leaderboard_id}/entries\",\n      \"entry_detail_url_template\": \"https://blastrt-prod-us-east-1.livelikecdn.com/services/leaderboards/{leaderboard_id}/entries/{profile_id}\"\n    }\n\t]\n}"
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Leaderboards
    post:
      summary: Create Leaderboard
      description: ''
      operationId: create-leaderboard
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                reward_item_id:
                  type: string
                client_id:
                  type: string
                attributes:
                  type: array
                  items:
                    properties:
                      key:
                        type: string
                      value:
                        type: string
                    required:
                    - key
                    - value
                    type: object
                custom_id:
                  type: string
                  description: Custom Identifier for leaderboard
      responses:
        '201':
          description: '201'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"name\": \"new leaderboard\",\n  \"reward_item_id\": \"d4ea39c8-2530-410a-b770-212368d2fd45\",\n  \"client_id\": \"lom9db0XtQUhOZQq1vz8QPfSpiyyxppiUVGMcAje\",\n  \"attributes\":[\n        {\n          \"key\": \"key1\",\n          \"value\": \"value1\"\n        }\n      ]\n}"
              schema:
                type: object
                properties:
                  name:
                    type: string
                    example: new leaderboard
                  reward_item_id:
                    type: string
                    example: d4ea39c8-2530-410a-b770-212368d2fd45
                  client_id:
                    type: string
                    example: lom9db0XtQUhOZQq1vz8QPfSpiyyxppiUVGMcAje
                  attributes:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          example: key1
                        value:
                          type: string
                          example: value1
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Leaderboards
    servers:
    - url: https://cf-blast.livelikecdn.com/api/v1/leaderboards
  /{id}/:
    get:
      summary: Get Leaderboard Details
      description: Getting leaderboard details can be achieved by using the request below. Leaderboard details can be useful if you would like to know the name of the leaderboard or the type of reward a user can earn.
      operationId: get-leaderboard-details
      parameters:
      - name: id
        in: path
        description: The leaderboard ID
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"{leaderboard_id}\",\n    \"url\": \"https://cf-blast.livelikecdn.com/api/v1/leaderboards/{leaderboard_id}/\",\n    \"client_id\": \"{client_id}\",\n    \"name\": \"LiveLike Points Leaders\",\n    \"reward_item\": {\n        \"id\": \"5e1016ef-9cf8-450f-9ad6-5e3996f1cbb0\",\n        \"url\": \"https://cf-blast.livelikecdn.com/api/v1/reward-items/5e1016ef-9cf8-450f-9ad6-5e3996f1cbb0/\",\n        \"client_id\": \"client_id\",\n        \"name\": \"LiveLike Points\"\n    },\n    \"attributes\":[]\n    \"reward_item_id\": \"5e1016ef-9cf8-450f-9ad6-5e3996f1cbb0\",\n    \"is_locked\": false,\n    \"entries_url\": \"https://blastrt-prod-us-east-1.livelikecdn.com/services/leaderboards/{leaderboard_id}/entries\",\n    \"entry_detail_url_template\": \"https://blastrt-prod-us-east-1.livelikecdn.com/services/leaderboards/{leaderboard_id}/entries/{profile_id}\"\n}"
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      security: []
      tags:
      - Leaderboards
    patch:
      summary: Update a Leaderboard
      description: ''
      operationId: update-leaderboard
      parameters:
      - name: id
        in: path
        description: The leaderboard ID
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The descriptive name of the leaderboard
                is_locked:
                  type: boolean
                  description: Whether or not scores will update in the leaderboard
                attributes:
                  type: array
                  items:
                    properties:
                      key:
                        type: string
                      value:
                        type: string
                    required:
                    - key
                    - value
                    type: object
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"id\": \"{leaderboard_id}\",\n    \"url\": \"https://cf-blast.livelikecdn.com/api/v1/leaderboards/{leaderboard_id}/\",\n    \"client_id\": \"{client_id}\",\n    \"name\": \"LiveLike Points Leaders\",\n    \"reward_item\": {\n        \"id\": \"5e1016ef-9cf8-450f-9ad6-5e3996f1cbb0\",\n        \"url\": \"https://cf-blast.livelikecdn.com/api/v1/reward-items/5e1016ef-9cf8-450f-9ad6-5e3996f1cbb0/\",\n        \"client_id\": \"client_id\",\n        \"name\": \"LiveLike Points\"\n    },\n    \"attributes\":[\n      {\n        \"key\": \"key1\",\n        \"value\": \"value1\"\n      }\n    ]\n    \"reward_item_id\": \"5e1016ef-9cf8-450f-9ad6-5e3996f1cbb0\",\n    \"is_locked\": false,\n    \"entries_url\": \"https://blastrt-prod-us-east-1.livelikecdn.com/services/leaderboards/{leaderboard_id}/entries\",\n    \"entry_detail_url_template\": \"https://blastrt-prod-us-east-1.livelikecdn.com/services/leaderboards/{leaderboard_id}/entries/{profile_id}\"\n}"
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      security: []
      tags:
      - Leaderboards
    servers:
    - url: https://cf-blast.livelikecdn.com/api/v1/leaderboards
  /{program_id}/leaderboards/{leaderboard_id}/:
    put:
      summary: Link a Leaderboard with a Program
      description: ''
      operationId: link-a-leaderboard-with-a-program
      parameters:
      - name: program_id
        in: path
        description: Program ID
        schema:
          type: string
        required: true
      - name: leaderboard_id
        in: path
        description: Leaderboard ID
        schema:
          type: string
        required: true
      responses:
        '204':
          description: '204'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Leaderboards
    delete:
      summary: Unlink a leaderboard from a program
      description: ''
      operationId: unlink-a-leaderboard-from-a-program
      parameters:
      - name: program_id
        in: path
        description: Program ID
        schema:
          type: string
        required: true
      - name: leaderboard_id
        in: path
        description: Leaderboard ID
        schema:
          type: string
        required: true
      responses:
        '204':
          description: '204'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Leaderboards
    servers:
    - url: https://cf-blast.livelikecdn.com/api/v1/programs
x-refined-from:
- livelike-leaderboards-openapi.yml
- livelike-programs-openapi.yml
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.livelike.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.livelike.com/reference/create-an-application.md
  - https://docs.livelike.com/reference/create-multiplier-1.md
  - https://docs.livelike.com/reference/create-multiplier.md
  - https://docs.livelike.com/reference/delete-an-application.md
  - https://docs.livelike.com/reference/delete-comment-quality-rules.md
  - https://docs.livelike.com/reference/list-reward-multipliers.md
  - https://docs.livelike.com/reference/listing-applications-widgets.md
  - https://docs.livelike.com/reference/retrieve-reward-multiplier-1-1-1-1.md
  - https://docs.livelike.com/reference/retrieve-reward-multiplier-1-1-1.md
  - https://docs.livelike.com/reference/retrieve-reward-multiplier-1-1.md
  - https://docs.livelike.com/reference/retrieve-reward-multiplier-1.md
  - https://docs.livelike.com/reference/retrieve-reward-multiplier.md
  - https://docs.livelike.com/reference/update-an-application.md
  merge:
    pages: 13
    deduped: 12
    conflicts_kept_first: 0