v1

latestOpenAPI 3.1.02026-07-24560263.9 KB

Listar Pastas

get/folders

Query parameters

filter[in_root]boolean

Informe por boleano se deseja listar apenas pastas na raiz de sua estrutura de pastas.

Headers

Authorizationstring

Access Token gerado pelo gestor da conta

Content-type'application/vnd.api+json'

Content-type padrão para todas requisições JSON:API

Response

200

Example response

{
  "data": [
    {
      "id": "da1bd331-93f2-4943-b239-3f3fe486852b",
      "type": "folders",
      "links": {
        "self": "https://sandbox.clicksign.com/api/v3/folders/da1bd331-93f2-4943-b239-3f3fe486852b"
      },
      "attributes": {
        "name": "Pasta Pessoal",
        "in_root": true,
        "created": "2024-12-20T15:49:10.089-03:00",
        "modified": "2024-12-20T15:49:10.093-03:00"
      }
    }
  ],
  "meta": {
    "record_count": 2
  },
  "links": {
    "first": "https://sandbox.clicksign.com/api/v3/folders?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://sandbox.clicksign.com/api/v3/folders?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}