App - Public Pages

GET

/public/v2/{bucket}/web

All pages (and index pages) are accessed through a single endpoint. The path is a required parameter and the response will be a page config block and zero or more resources. User credentials are optional but may be required if the page is not public or is only for members.

Parameters

Path Parameters

bucket

required

The bucket (client) name

string

Example

example

Query Parameters

path

string

Example

archive-introduction/

The URL path (after the domain name). All paths should end with a trailing slash.

user_query

A dictionary of query terms which are merged with the base query for the index page (if present).

object

creator

string

Example

John Smith

date_lower

A date in the format YYYY-MM-DD

string

Example

2020-01-01

date_upper

A date in the format YYYY-MM-DD

string

Example

2020-01-01

legacy_uid

A third part or external unique identifier, sometimes from a legacy system. Can also be a psuedo-random string to enforce uniqueness.

string

Example

1234567890

tags

Array<string>

Example

[
  "tag1",
  "tag2"
]

title

string

Example

My Title

sort

Sort the results by title or date (default). To specify descending order for a field, prefix the field with a - e.g. -date

string

Allowed values: title date -title -date

Example

title

Responses

200

Successful operation - a page response

object

page_status

string

Example

OK

allowed_access

boolean

Example

true

page_type

string

Example

single

resource

string

user_context

object

contact_uri

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

is_logged_in

boolean

is_member

boolean

user_account

object

email

string

Example

bob@example.com

first_name

string

last_name

string

last_login_date

A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm

string

Example

2023-09-05T11:27:06.437000

session_expiry

A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm

string

Example

2023-09-05T11:27:06.437000

uri

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

username

string

username

string

page_config

object

active

boolean

archive_date

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

body

string

fallback_body

string

file

A fully qualified URL including the protocol e.g. https

string

Example

https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg

filter

object

legacy_uid

string

member_only

boolean

meta

object

path

string

photo

A fully qualified URL including the protocol e.g. https

string

Example

https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg

public

boolean

publish_date

A date in the format YYYY-MM-DD

string

Example

2020-01-01

resource_type

The type of resource, usually the second element in the URI e.g person, organisation, member, payment

string

Example

person

secondary_photos

Array<string>

table_config

tags

Array<string>

template

string

thumbnail

A fully qualified URL including the protocol e.g. https

string

Example

https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg

title

string

uri

URIs are unique identifiers for resources in the system, they are structured as follows /bucket/resource_type/uid/

string

Example

/example/person/6305f074683e800f3abe809e/

path_elements

object

400

A standard error message

401

Authentication error