Skip to main content

API Overview

Collect API provides reach options to work with data through the API.

There are different APIs to accomplish different things:

Records API​

Create​

Create single Record. Learn more at Records API.

POST /api/v1/record

Create single Record under specific Record as child. Learn more at Records API.

POST /api/v1/record/:id

Read​

Get single Record. Learn more at Records API.

GET /api/v1/record/:id

Get list of all parents of Record. Learn more at Records API.

GET /api/v1/record/:id/traverse-parents

Update​

Update single Record. Learn more at Records API.

PATCH /api/v1/record/:id

Delete​

Delete single Record. Learn more at Records API.

DELETE /api/v1/record/:id

Retrieve Record in the way you need them, followed by flexible criteria. Learn more at Records API. From root (all data in project will be searched according to provided parameters):

POST /api/v1/record/search

Search from a specific Record to all its nested children (assuming you have Nested Data):

POST /api/v1/record/:id/search

Properties API​

POST /api/v1/record/properties
POST /api/v1/record/:id/properties
POST /api/v1/property

Labels API​

POST /api/v1/label
POST /api/v1/label/:name

Import API​

POST /api/v1/collect/json
POST /api/v1/import/json
POST /api/v1/collect/csv
POST /api/v1/import/csv

Export API​

POST /api/v1/export/csv

Dynamic API​

Equals​

Find Records that have a Property with the name :name and a value equal to :value.

GET /api/v1/property/:name/equals/:value
POST /api/v1/property/:name/equals/:value

Not Equals​

Find Records that have a Property with the name :name and a value not equal to :value.

GET /api/v1/property/:name/not-equals/:value
POST /api/v1/property/:name/not-equals/:value

Contains​

Find Records that have a Property with the name :name and a value containing the substring :value.

GET /api/v1/property/:name/contains/:value
POST /api/v1/property/:name/contains/:value

Not Contains​

Find Records that have a Property with the name :name and a value not containing the substring :value.

GET /api/v1/property/:name/not-contains/:value
POST /api/v1/property/:name/not-contains/:value

LT (Less Than)​

Find Records that have a Property with the name :name and a value (of type number or datetime) less than :value.

GET /api/v1/property/:name/lt/:value
POST /api/v1/property/:name/lt/:value

LE (Less Than or Equal)​

Find Records that have a Property with the name :name and a value (of type number or datetime) less than or equal to :value.

GET /api/v1/property/:name/le/:value
POST /api/v1/property/:name/le/:value

GT (Greater Than)​

Find Records that have a Property with the name :name and a value (of type number or datetime) greater than :value.

GET /api/v1/property/:name/gt/:value
POST /api/v1/property/:name/gt/:value

GE (Greater Than or Equal)​

Find Records that have a Property with the name :name and a value (of type number or datetime) greater than or equal to :value.

GET /api/v1/property/:name/ge/:value
POST /api/v1/property/:name/ge/:value

Range​

Find Records that have a Property with the name :name and a values (of type number or datetime) within the range of :value.

GET /api/v1/property/:name/range/:min/:max
POST /api/v1/property/:name/range/:min/:max

Exclude Range​

Find Records that have a Property with the name :name and a values (of type number or datetime) outside the range of :value.

GET /api/v1/property/:name/exclude-range/:min/:max
POST /api/v1/property/:name/exclude-range/:min/:max

Relations API​

Create relations between Records. Learn more at Relations API

POST /api/v1/record/:id/link

Delete relations between Records. Learn more at Relations API

POST /api/v1/record/:id/unlink