Paginação e filtros

Parâmetros de consulta para paginar, ordenar e filtrar a lista de páginas de conteúdo, incluindo a visão em árvore e a lista sem conteúdo.

Use estes parâmetros na chamada de listagem para encontrar páginas com propriedades específicas e devolvê-las do jeito que a sua aplicação precisa. Eles valem para GET /api/2.0/pages, que obtém uma lista de páginas conforme os critérios de filtro que você enviar.

GET/api/2.0/pagesAdmin

Obter uma lista de páginas conforme os critérios de filtro informados

Parâmetros de consulta

pageintegerpadrão: 1

Mostra as páginas da página de saída com o número informado.

items_per_pageintegerpadrão: 10

Quantidade de páginas exibidas na página de saída.

sort_bystringpadrão: position

positionnametimestamptypemulti_level

Ordena as páginas por este campo.

sort_orderstringpadrão: desc

ascdesc

Ordem crescente ou decrescente.

parent_idinteger

Filtra as páginas pelo id do elemento pai.

page_typestring

TLFB

Filtra as páginas por tipo: T página, L link, F formulário (só com o add-on Form Builder), B post de blog (só com o add-on Blog).

simplestring

Adicione este parâmetro se não quiser que a resposta inclua o conteúdo das páginas.

qstring

Filtro por texto completo.

statusstring

AHD

Filtra as páginas por status: A ativa, H oculta, D desativada.

item_idsstring

Mostra apenas páginas específicas. Separe os ids com vírgulas.

get_treestring

trueplain

Mostra as páginas em árvore.

Parâmetros de consulta

Parâmetros de paginação

Parâmetro	Valor padrão	Descrição
`page`	`1`	Mostra as páginas da página de saída com o número informado.
`items_per_page`	`10`	Quantidade de páginas exibidas na página de saída.

Parâmetros de ordenação

Parâmetro	Valor padrão	Descrição
`sort_by`	`position`	Ordena as páginas por `position`, `name`, `timestamp`, `type` ou `multi_level`.
`sort_order`	`desc`	Ordem crescente ou decrescente: `asc` ou `desc`.

Parâmetros de filtro de conteúdo

Parâmetro	Descrição
`parent_id`	Filtra as páginas pelo id do elemento pai.
`page_type`	Filtra as páginas por tipo: `T` página, `L` link, `F` formulário (só com o add-on Form Builder), `B` post de blog (só com o add-on Blog).
`simple`	Adicione este parâmetro se não quiser que a resposta inclua o conteúdo das páginas.
`q`	Filtro por texto completo.
`status`	Filtra as páginas por status: `A` ativa, `H` oculta, `D` desativada.
`item_ids`	Mostra apenas páginas específicas. Separe os ids com vírgulas.
`get_tree`	Mostra as páginas em árvore. Valores: `true`, `plain`.

Exemplos

Paginação

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/2.0/pages?page=5"

A resposta é um array com 10 páginas da 5ª página de saída.

Personalizando o número de resultados por página

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/2.0/pages?items_per_page=20"

A resposta é um array com 20 páginas da primeira página.

Paginação combinada

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/2.0/pages?page=5&items_per_page=20"

A resposta é um array com 20 páginas da 5ª página.

Paginação e filtros

Parâmetros de consulta para paginar, ordenar e filtrar a lista de páginas de conteúdo, incluindo a visão em árvore e a lista sem conteúdo.

GET/api/2.0/pagesAdmin

Obter uma lista de páginas conforme os critérios de filtro informados

Parâmetros de consulta

pageintegerpadrão: 1

Mostra as páginas da página de saída com o número informado.

items_per_pageintegerpadrão: 10

Quantidade de páginas exibidas na página de saída.

sort_bystringpadrão: position

positionnametimestamptypemulti_level

Ordena as páginas por este campo.

sort_orderstringpadrão: desc

ascdesc

Ordem crescente ou decrescente.

parent_idinteger

Filtra as páginas pelo id do elemento pai.

page_typestring

TLFB

Filtra as páginas por tipo: T página, L link, F formulário (só com o add-on Form Builder), B post de blog (só com o add-on Blog).

simplestring

Adicione este parâmetro se não quiser que a resposta inclua o conteúdo das páginas.

qstring

Filtro por texto completo.

statusstring

AHD

Filtra as páginas por status: A ativa, H oculta, D desativada.

item_idsstring

Mostra apenas páginas específicas. Separe os ids com vírgulas.

get_treestring

trueplain

Mostra as páginas em árvore.

Parâmetros de consulta

Parâmetros de paginação

Parâmetro	Valor padrão	Descrição
`page`	`1`	Mostra as páginas da página de saída com o número informado.
`items_per_page`	`10`	Quantidade de páginas exibidas na página de saída.

Parâmetros de ordenação

Parâmetro	Valor padrão	Descrição
`sort_by`	`position`	Ordena as páginas por `position`, `name`, `timestamp`, `type` ou `multi_level`.
`sort_order`	`desc`	Ordem crescente ou decrescente: `asc` ou `desc`.

Parâmetros de filtro de conteúdo

Parâmetro	Descrição
`parent_id`	Filtra as páginas pelo id do elemento pai.
`page_type`	Filtra as páginas por tipo: `T` página, `L` link, `F` formulário (só com o add-on Form Builder), `B` post de blog (só com o add-on Blog).
`simple`	Adicione este parâmetro se não quiser que a resposta inclua o conteúdo das páginas.
`q`	Filtro por texto completo.
`status`	Filtra as páginas por status: `A` ativa, `H` oculta, `D` desativada.
`item_ids`	Mostra apenas páginas específicas. Separe os ids com vírgulas.
`get_tree`	Mostra as páginas em árvore. Valores: `true`, `plain`.

Exemplos

Paginação

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/2.0/pages?page=5"

A resposta é um array com 10 páginas da 5ª página de saída.

Personalizando o número de resultados por página

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/2.0/pages?items_per_page=20"

A resposta é um array com 20 páginas da primeira página.

Paginação combinada

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/2.0/pages?page=5&items_per_page=20"

A resposta é um array com 20 páginas da 5ª página.