find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/antavo-leaderboard-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    email: support@antavo.com
  title: Antavo Leaderboard API
  version: 1.0.0
servers:
- url: https://api.staging.antavo.com
  description: The Antavo staging environment
security:
- api_key: []
tags:
- name: Leaderboard
paths:
  /customers/leaderboard:
    get:
      tags:
      - Leaderboard
      summary: List best-performing customers
      description: 'The Leaderboard API allows you to retrieve rankings and scores of customers based on various metrics within the Antavo Loyalty Cloud.

        This API provides a way to showcase top performers, track progress, and foster competition among participants in your loyalty program.'
      parameters:
      - name: limit
        in: query
        description: The number of results to return. Values outside the acceptable range will be adjusted to the nearest boundary value.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      responses:
        '200':
          description: List of top performing customers
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SuccessResponse'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      description: UnauthorizedException
      type: object
      required:
      - type
      - code
      - message
      properties:
        type:
          type: string
          description: Type of the error.
          example: UnauthorizedException
        code:
          type: number
          description: Error code.
          example: 0
        message:
          type: string
          description: Human-readable error message.
          example: No api_key provided
    SuccessResponse:
      type: object
      description: Array of reward entries.
      properties:
        id:
          type: string
          description: The unique customer identifier.
          example: 280e674c-c4ea-4a30-987a-d9267d1a5018
        handler:
          type: string
          description: The customer's handler (nickname). If not set, this will return the customer's first name or null.
          example: john_doe
        image_url:
          type: string
          description: The avatar of the customer. Returns null if not set.
          example: https://example.com/avatar.jpg
        score:
          type: number
          description: The points earned by the customer in the given interval.
          example: 1500
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      description: Provides API Key access to the endpoint
      in: query