GET Company usage

Changed on

Retorna o histórico mensal de uso (arquivos, disco e assinaturas) da empresa informada: a sua própria empresa ou, para contas revendedoras, uma de suas subcontas. Empresas fora desse escopo respondem 404.

Os dados são agrupados por mês (chave month, formato AAAA-MM), do mês mais recente para o mais antigo, com 50 registros por página. O registro do mês corrente é calculado no momento da consulta (arquivos e assinaturas do período; disco = soma do tamanho dos arquivos da empresa) e pode vir com id null.

get/api/companies/{company_id}/usage

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/companies/{company_id}/usage
  • Auth
    API key in header Authorization

Path parameters

company_idinteger required

ID da empresa.

Response

200

Example response

{
  "data": [
    {
      "id": 6,
      "company": 1,
      "files": 75,
      "disk": "7482",
      "signatures": 110,
      "month": "2026-07"
    }
  ],
  "links": {
    "first": "https://app.plugsign.com.br/api/companies/1/usage?page=1",
    "last": "https://app.plugsign.com.br/api/companies/1/usage?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "label": "« Previous"
      }
    ],
    "path": "https://app.plugsign.com.br/api/companies/1/usage",
    "per_page": 50,
    "to": 3,
    "total": 3
  }
}

Changes

    • breaking

      the // response's property type changed from integer to string for status

    • warning

      removed the optional property // from the response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status