Skip to main content

Paligo API

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[Document]

false

none

none

» id

integer

false

none

The ID of the document.

» name

string

false

none

The name of the document.

» uuid

string

false

none

The UUID of the document

» type

string

false

none

The resource type.

» creator

integer

false

none

The ID of the user that created the document.

» owner

integer

false

none

The ID of the user that owns the document.

» author

integer

false

none

The ID of the user that created the document.

» created_at

integer

false

none

The document creation time (as a unix timestamp).

» modified_at

integer

false

none

The document modification time (as a unix timestamp).

» checkout

boolean

false

none

The checkout status of the document.

» checkout_user

integer

false

none

User that has checked out document

» parent_resource

integer

false

none

The ID of the document’s parent resource.

» taxonomies

[Taxonomy]

false

none

The document’s taxonomies.

»» id

integer

false

none

The ID of the taxonomy.

»» title

string

false

none

The title of the taxonomy.

»» color

integer

false

none

The color of the taxonomy.

»» parent

integer

false

none

The ID of this taxonomy parent.

» content

string

false

none

Document XML content. Only returned when requesting a single document.

» languages

[string]

false

none

A list of all the documents translations.

» custom_attributes

[CustomAttribute]

false

none

A list of custom attributes on the document.

»» name

string

false

none

The name of the attribute.

»» value

string

false

none

The value of the attribute.

Enumerated Values

Property

Value

color

0

color

1

color

2

color

3

color

4