collections

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-collections"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/e2f58d04-15fb-4d60-b6f4-c06414519ada/social-card.svg?v=3e7ae33eec8b" alt="collections" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/collections

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/collections" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "rowCount": 0,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsPostV1CollectionsResponse[]required
Show child parameters
idstringrequired
namestringrequired
descriptionstringrequired
rowCountintegerrequired
createdAtstringrequired
updatedAtstringrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/collections

POSThttps://hermeticor.com/v1/collections

Request body

application/json
namestringrequired
descriptionstring
rowsobject[]
csvstring
{
  "name": "string",
  "description": "string",
  "rows": [
    {}
  ],
  "csv": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/collections" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","rows":[{}],"csv":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "rowCount": 0,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
descriptionstringrequired
rowCountintegerrequired
createdAtstringrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/collections

5XX Default Response

Same as 4XX · GET /v1/collections

GEThttps://hermeticor.com/v1/collections/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/collections/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/collections

4XX Default Response

Same as 4XX · GET /v1/collections

5XX Default Response

Same as 4XX · GET /v1/collections

PUThttps://hermeticor.com/v1/collections/{id}

Parameters

idstringpathrequired

Request body

application/json
namestring
descriptionstring
{
  "name": "string",
  "description": "string"
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/collections/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/collections

4XX Default Response

Same as 4XX · GET /v1/collections

5XX Default Response

Same as 4XX · GET /v1/collections

DELETEhttps://hermeticor.com/v1/collections/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/collections/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/collections

5XX Default Response

Same as 4XX · GET /v1/collections

GEThttps://hermeticor.com/v1/collections/{id}/content

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/collections/{id}/content" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "rows": [
    {}
  ]
}
Schema
rowsobject[]required
4XX Default Response

Same as 4XX · GET /v1/collections

5XX Default Response

Same as 4XX · GET /v1/collections

PUThttps://hermeticor.com/v1/collections/{id}/content

Replaces every row (JSON array of objects, or CSV text with a header row)

Parameters

idstringpathrequired

Request body

application/json
rowsobject[]
csvstring
{
  "rows": [
    {}
  ],
  "csv": "string"
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/collections/{id}/content" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{}],"csv":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/collections

4XX Default Response

Same as 4XX · GET /v1/collections

5XX Default Response

Same as 4XX · GET /v1/collections

Updated