API v1

List competitors

List tracked competitors across all projects for the authenticated user, alphabetically, paged with limit (1-100, default 100) and offset. pagination.total is the full count, so a caller pages until offset + data.length reaches it. By default only active competitors are returned; pass include_inactive=true to also include removed (soft-deleted) competitors. A project_id that is not one of your projects is a 404 PROJECT_NOT_FOUND.

get/api/v1/competitors

Request

  • Base URL: https://api.rivalize.ai
  • URL: https://api.rivalize.ai/api/v1/competitors
  • Auth: HTTP bearer

Query parameters

project_idstring uuid

Filter by project ID

include_inactiveboolean

Include removed (soft-deleted) competitors. Default false.

limitinteger

Page size, 1-100 (default 100).

offsetinteger

Rows to skip (default 0).

Response

Default Response

dataobject[]

Changes

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