Tags

List tags

get

Authorizations

api_key

AuthorizationstringRequired

Query parameters

product_idsstringOptional

Comma-separated product ids (max 20)

namestringOptional

Search tag name and associated product names

has_categorybooleanOptional

Tag has a category or not

Responses

200

tags listed

application/json

get/api/v1/tags

HTTPcURLJavaScriptPython

GET /api/v1/tags HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

tags listed

{
  "tags": [
    {
      "id": 1,
      "account_id": 1,
      "name": "text",
      "assigned_listings": [
        {
          "id": 1,
          "title": "text",
          "type": "text",
          "canvas_course_id": 1,
          "archived_at": "text"
        }
      ],
      "assigned_categories": [
        {
          "id": 1,
          "account_id": 1,
          "tag_id": 1,
          "created_at": "text",
          "updated_at": "text"
        }
      ],
      "created_at": "text",
      "updated_at": "text"
    }
  ]
}

Create a tag

post

Authorizations

api_key

AuthorizationstringRequired

Body

application/json

namestringRequired

Tag name (1-255 characters)

product_idsinteger[]Optional

Product ids to associate

Responses

200

tag created

application/json

idintegerRequired

Tag id

account_idintegerOptional

Account id

namestringOptional

Tag name

created_atstringRequired

Tag created at

updated_atstringRequired

Tag updated at

post/api/v1/tags

HTTPcURLJavaScriptPython

POST /api/v1/tags HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "product_ids": [
    1
  ]
}

200

tag created

{
  "id": 1,
  "account_id": 1,
  "name": "text",
  "assigned_listings": [
    {
      "id": 1,
      "title": "text",
      "type": "text",
      "canvas_course_id": 1,
      "archived_at": "text"
    }
  ],
  "assigned_categories": [
    {
      "id": 1,
      "account_id": 1,
      "tag_id": 1,
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "created_at": "text",
  "updated_at": "text"
}

Get a specific tag

get

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idintegerRequired

Tag id

Responses

200

tag found

application/json

idintegerRequired

Tag id

account_idintegerOptional

Account id

namestringOptional

Tag name

created_atstringRequired

Tag created at

updated_atstringRequired

Tag updated at

get/api/v1/tags/{id}

HTTPcURLJavaScriptPython

GET /api/v1/tags/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

tag found

{
  "id": 1,
  "account_id": 1,
  "name": "text",
  "assigned_listings": [
    {
      "id": 1,
      "title": "text",
      "type": "text",
      "canvas_course_id": 1,
      "archived_at": "text"
    }
  ],
  "assigned_categories": [
    {
      "id": 1,
      "account_id": 1,
      "tag_id": 1,
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "created_at": "text",
  "updated_at": "text"
}

Update a tag

put

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idintegerRequired

Tag id

Body

application/json

namestringRequired

New tag name (1-255 characters)

Responses

200

tag updated

application/json

idintegerRequired

Tag id

account_idintegerOptional

Account id

namestringOptional

Tag name

created_atstringRequired

Tag created at

updated_atstringRequired

Tag updated at

put/api/v1/tags/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/tags/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

200

tag updated

{
  "id": 1,
  "account_id": 1,
  "name": "text",
  "assigned_listings": [
    {
      "id": 1,
      "title": "text",
      "type": "text",
      "canvas_course_id": 1,
      "archived_at": "text"
    }
  ],
  "assigned_categories": [
    {
      "id": 1,
      "account_id": 1,
      "tag_id": 1,
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "created_at": "text",
  "updated_at": "text"
}

Delete a specific tag

delete

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idintegerRequired

Tag id

Responses

200

tag deleted

application/json

idintegerRequired

Tag id

account_idintegerOptional

Account id

namestringOptional

Tag name

created_atstringRequired

Tag created at

updated_atstringRequired

Tag updated at

is_deletedbooleanRequired

True to indicate the tag is deleted

delete/api/v1/tags/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/tags/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

tag deleted

{
  "id": 1,
  "account_id": 1,
  "name": "text",
  "assigned_listings": [
    {
      "id": 1,
      "title": "text",
      "type": "text",
      "canvas_course_id": 1,
      "archived_at": "text"
    }
  ],
  "assigned_categories": [
    {
      "id": 1,
      "account_id": 1,
      "tag_id": 1,
      "created_at": "text",
      "updated_at": "text"
    }
  ],
  "created_at": "text",
  "updated_at": "text",
  "is_deleted": true
}

Delete multiple tags

delete

Authorizations

api_key

AuthorizationstringRequired

Body

application/json

idsinteger[]Required

Tag IDs to delete

Responses

200

tags deleted

application/json

delete/api/v1/tags/bulk

HTTPcURLJavaScriptPython

DELETE /api/v1/tags/bulk HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "ids": [
    1
  ]
}

200

tags deleted

{
  "tags": [
    {
      "id": 1,
      "account_id": 1,
      "name": "text",
      "assigned_listings": [
        {
          "id": 1,
          "title": "text",
          "type": "text",
          "canvas_course_id": 1,
          "archived_at": "text"
        }
      ],
      "assigned_categories": [
        {
          "id": 1,
          "account_id": 1,
          "tag_id": 1,
          "created_at": "text",
          "updated_at": "text"
        }
      ],
      "created_at": "text",
      "updated_at": "text",
      "is_deleted": true
    }
  ]
}