Skip to content
aimrack

Tag

The tag resource.

Base/tag
GET/tag

List tags

Retrieve a paginated list of tags. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/tag
curl --request GET \
  --url '<your-host>/tag?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "name": "Example",
    "table": "string",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "updatedBy": "string"
  }
]
GET/tag

Retrieve a tag

Fetch a single tag by filtering on `name`.

Query parameters

namestring

Match on the tag's `name`, e.g. `eq.{id}`.

GET/tag
curl --request GET \
  --url '<your-host>/tag?name=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "name": "Example",
  "table": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "updatedBy": "string"
}
POST/tag

Create a tag

Create a new tag.

POST/tag
curl --request POST \
  --url <your-host>/tag \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "name": "Example",
  "table": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "updatedBy": "string"
}
PATCH/tag

Update a tag

Update an existing tag, matched on `name`.

PATCH/tag
curl --request PATCH \
  --url '<your-host>/tag?name=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "name": "Example",
  "table": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "updatedBy": "string"
}
DELETE/tag

Delete a tag

Delete a tag, matched on `name`. Returns 204 No Content.

Query parameters

namestring

The `name` of the tag to delete, e.g. `eq.{id}`.

DELETE/tag
curl --request DELETE \
  --url '<your-host>/tag?name=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content