Os documentos públicos de uma associação

GET

/v1/aps/{slug}/documents

curl --request GET \
  --url https://api.vimine.network/v1/aps/example/documents

• Vimine API

Os documentos que a associação tornou públicos em sua biblioteca — um ato constitutivo, um statuto anterior, outros atos — cada um com tipo, título, data e o endereço do original. Uma ata ou as contas aprovadas nunca estão aqui. Somente leitura; o statuto e o regolamento em vigor têm suas próprias rotas.

Parâmetros

Parâmetros de caminho

slug

obrigatório

string

Respostas

200

Os documentos públicos

Tipo de mídiaapplication/json

object

aps

obrigatório

object

slug

obrigatório

string

name

obrigatório

string

documents

obrigatório

Array<object>

object

uid

obrigatório

string formato: uuid

kind

obrigatório

Founding_act · past_statute · other (uma ata ou as contas nunca são públicas)

string

Valores permitidos: founding_act past_statute accounts minutes other

title

obrigatório

string

act_date

A data do ato

string formato: date

nullable

period

O exercício das contas (2025, 2025/2026)

string

nullable

pages

integer

nullable

bytes

integer

nullable

content_type

Application/pdf, image/jpeg ou image/png

string

nullable

sha256

SHA-256 do original tal como foi enviado

string

nullable

url

obrigatório

GET responde 302 para um link ao original válido por quinze minutos — peça-o quando precisar, não o guarde

string formato: uri

Exemplo

{
  "documents": [
    {
      "kind": "founding_act"
    }
  ]
}

400

Requisição inválida

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

404

Associação desconhecida, ou sem presença pública

429

Limite de requisições excedido

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

500

Erro interno

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}