Search docs/

Listar Publicações

{...}

Listar as publicações existentes

GET https://api.layers.digital/v1/post
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota. O app deve estar cadastrado para usar a API com a permissão member:read

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade
  • createdAt
    (query)
    Data de criação do documento
  • updateAt
    (query)
    Data da última modificação do documento
  • viewAt
    (query)
    Data na qual a publicação ficou visível para o público alvo
  • date
    (query)
    Data da publicação. (Apenas para publicações da agenda e eventos)
  • userId
    (query)
    Identificador do documento
  • active
    (query)
    Indicador do estado do documento. Quando verdadeiro o documento está ativo e quando falso o documento está apagado.
  • approved
    (query)
    Indica se o post já foi aprovado para ser publicado ou ainda aguarda autorização
  • roles
    (query)
    Permissão que o usuário possui
  • season
    (query)
    Temporada do documento. Geralmente é o ano letivo.
  • tags
    (query)
    Array contendo os identificadores de todo público alvo que pode ver essa publicação (grupos, usuários, alunos e turmas)
  • updateAt
    (query)
    Data da última modificação do documento
  • updateAt
    (query)
    Data da última modificação do documento
  • author.name
    (query)
    Nome do autor da publicação
  • author.id
    (query)
    Id do autor da publicação

Resposta

Especificação

  • [].idString

    Identificador do documento da publicação

  • [].createdAtString

    Data de criação da publicação

  • [].updatedAtString

    Data da última edição da publicação

  • [].typeStringobrigatório

    Tipo da publicação

  • [].titleStringobrigatório

    Título da publicação

  • [].textStringobrigatório

    Texto de corpo da publicação

  • [].targets[ ]obrigatório

    Público alvo da publicação

  • [].rolesArrayobrigatório

    Perfís de usuários no público alvo que poderão ver essa publicação.

  • [].viewAtString

    Data quando a publicação deve ser vista.

  • [].dateStringobrigatório

    Data do evento

  • [].eventObjectobrigatório

Exemplo

[
  {
    "id": "5bb2575199d7179dfe85be02",
    "createdAt": "2020-09-15T14:14:14.277Z",
    "updatedAt": "2020-09-15T14:14:14.277Z",
    "type": "exemplo",
    "title": "exemplo",
    "text": "exemplo",
    "targets": [
      {
        "id": "exemplo",
        "kind": "exemplo"
      },
      {
        "email": "exemplo",
        "kind": "exemplo"
      },
      {
        "alias": "exemplo",
        "kind": "exemplo"
      }
    ],
    "roles": [
      "guardian"
    ],
    "viewAt": "exemplo",
    "date": "2020-09-15T14:14:14.277Z",
    "event": {
      "endDate": "2020-09-15T14:14:14.277Z",
      "allDay": true
    }
  }
]
CopiarCopiado