Data

Get a collection

One collection with its access, triggers, schema and document_count. The path takes the id or the name.

get/collections/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/collections/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: data:read)

Path parameters

idstring required

The id of the collection, or its name.

Response

The collection.

idstring uuid required

The id of the collection. Its name works in the path as well.

namestring required

The name, unique in the project. A form posts to it by this name.

descriptionstring nullable required

What the collection is for, or null.

schemaobject nullable required

The JSON Schema every document must match, or null.

personal_databoolean

true for a collection with personal data imported from WordPress (form entries, orders, customers, users, reviews). It always stays private.

document_countinteger required

How many documents the collection has now.

created_atstring date-time required

When the collection was created.

updated_atstring date-time required

When the collection last changed.

testboolean required

true for a collection of a test project.

Changes

No recorded changes to this operation across all 1 revision of this API.