v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Listar capturas

Este recurso retorna uma lista com todas as capturas / cessões efetuadas.

get/concessions

Query parameters

q[createdAtGt]string date

Data da captura ou cessão maior que.

q[createdAtLt]string date

Data da captura ou cessão menor que.

q[statusEq]'pending' | 'approved' | 'rejected' | 'canceled' | 'expired'

Status da cessão de títulos igual a.

q[typeEq]'offering' | 'catching' | 'returning'

Tipo de operação, podendo ser uma cessão, uma captura ou uma devolução de títulos.

p[page]integer

Página que será retornada.

p[per_page]integer

Quantidade de itens que serão retornados por página.

Response

200

Example response

{
  "data": {
    "id": "d8d74d12-88db-4b51-a6ca-6ac7bdd6cc23",
    "type": "concession",
    "attributes": [
      {
        "createdAt": "2021-01-01T00:00:00.000-03:00",
        "updatedAt": "2021-01-01T00:00:00.000-03:00",
        "status": "pending",
        "accessId": "29f4817c-cd99-4e74-ba4a-c98f093ec29d",
        "type": "offering",
        "count": 1,
        "value": "20.0"
      }
    ]
  },
  "meta": {
    "search": {
      "filteredFieldEq": "grafeno"
    },
    "currentPage": 2,
    "previousPage": 1,
    "nextPage": 3,
    "totalPages": 5,
    "perPage": 10,
    "totalCount": 250
  }
}