Skip to main content

Paligo API

Parameters

Name

In

Type

Required

Description

body

body

SearchRequestPostPayload

false

none

» resource

body

string

true

The target resource.

» per_page

body

integer

false

Items to return per page.

» page

body

integer

false

The result page.

» where

body

[anyOf]

false

Array of search parameters.

»» anonymous

body

SearchRequestWhereHas

false

none

»»» operator

body

string

true

The search operator.

»»» property

body

string

true

The property to run the comparison on.

»»» value

body

string

false

The value to compare against. Used when comparing against a single value.

»»» values

body

[string]

false

The values to compare against. Used when comparing against multiple values.

»» anonymous

body

SearchRequestWhereEquals

false

none

»»» operator

body

string

true

The search operator.

»»» property

body

string

true

The property to run the comparison on.

»»» value

body

string

true

The value to compare against.

»» anonymous

body

SearchRequestWhereAfter

false

none

»»» operator

body

string

true

The search operator.

»»» property

body

string

true

The date property to perform the comparison on.

»»» value

body

string

true

The Unix timestamp to compare against.

»» anonymous

body

SearchRequestWhereBefore

false

none

»»» operator

body

string

true

The search operator.

»»» property

body

string

true

The date property to perform the comparison on.

»»» value

body

string

true

The Unix timestamp to compare against.

»» anonymous

body

SearchRequestWhereBetween

false

none

»»» operator

body

string

true

The search operator.

»»» property

body

string

true

The date property to perform the comparison on.

»»» start

body

string

true

The starting Unix timestamp.

»»» end

body

string

true

The ending Unix timestamp.

»» anonymous

body

SearchRequestWhereContainsBlockElement

false

none

»»» operator

body

string

true

The search operator.

»»» property

body

string

true

The property to perform the XML search query on.

»»» value

body

string

true

The target block element.