Skip to main content
GET
/
product
curl --request GET \
  --url 'https://sell.ia.proativia.com/api/v1/product?categoryId=cat_abc123' \
  --header 'Token: SEU_TOKEN_DE_API'
[
  {
    "id": "prod_001",
    "accountId": "acc_123",
    "accountCategoryId": "cat_abc123",
    "name": "Consulta Inicial",
    "description": "Consulta de 1 hora para novos clientes",
    "images": null,
    "price": 150.00,
    "billingType": "ONE_TIME",
    "hourlyAppointments": 1,
    "status": "active",
    "createdAt": "2025-05-10T09:00:00.000Z",
    "updatedAt": "2025-05-10T09:00:00.000Z"
  }
]

Requisição

Token
string
required
Seu token de autenticação.

Query Parameters

categoryId
string
Filtra produtos pelo ID de uma categoria específica.

Resposta

Retorna um array de objetos de produto, ordenados do mais recente para o mais antigo. Os campos accountId e updatedAt são omitidos.
id
string
Identificador único do produto.
accountCategoryId
string
ID da categoria do produto.
name
string
Nome do produto.
description
string | null
Descrição do produto.
images
array | null
Lista de URLs de imagens do produto.
price
number
Preço do produto.
billingType
string
Tipo de cobrança do produto. Valores possíveis: ONE_TIME, WEEKLY, MONTHLY, YEARLY.
hourlyAppointments
number | null
Duração em horas para agendamentos (quando aplicável).
status
string
Status do produto. Padrão: active.
createdAt
string
Data de criação (ISO 8601).

Exemplos

curl --request GET \
  --url 'https://sell.ia.proativia.com/api/v1/product?categoryId=cat_abc123' \
  --header 'Token: SEU_TOKEN_DE_API'
[
  {
    "id": "prod_001",
    "accountId": "acc_123",
    "accountCategoryId": "cat_abc123",
    "name": "Consulta Inicial",
    "description": "Consulta de 1 hora para novos clientes",
    "images": null,
    "price": 150.00,
    "billingType": "ONE_TIME",
    "hourlyAppointments": 1,
    "status": "active",
    "createdAt": "2025-05-10T09:00:00.000Z",
    "updatedAt": "2025-05-10T09:00:00.000Z"
  }
]

Authorizations

Token
string
header
required

Token de autenticacao gerado na plataforma Sell.IA.

Query Parameters

categoryId
string

Filtra produtos por categoria.

Response

Lista de produtos retornada com sucesso.

id
string
name
string
description
string | null
price
number | null
categoryId
string | null
createdAt
string<date-time>