API Reference

Tags

Tags, listed and read.

Prefix /cdna-api/common ReferenceTag model GuideTaxonomy, URLs and SEO
Tags in Postman

List tags#

GET /cdna-api/common/tags

Lists tags. Without limit every match comes back.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
Tag, in the Reference

Parameters

propertiesquery
selector
The fields and relations to return, such as {id,name}.
filtersquery
name=value
Any stored field, or a relation with a dot, such as parent.id=12. Prefix the name with !, >, <, % or |. Use stored field names exactly as in the model, and compare totalCount with the unfiltered list's to confirm a filter applied.
orderByquery
string
field:ASC or field:DESC, comma-separated. Stored fields only.
limitquery
integer
Records per response. There is no default.
offsetquery
integer
Records to skip.

Example

List tags 
GET /cdna-api/common/tags?limit=2&properties={id,name} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "totalCount": 14,
  "data": [
    {
      "id": 9,
      "name": "api-reference"
    },
    {
      "id": 11,
      "name": "developer-docs"
    }
  ]
}
Open in Postman docs Real response from this documentation site

Learn more

GuideFilters, ordering and paging FAQMy filter returned every record

Show a tag#

GET /cdna-api/common/tag/{id}

Reads one tag by its id.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
Tag, in the Reference

Parameters

idpathrequired
integer
The tag id.
propertiesquery
selector
The fields and relations to return, such as {id,name}.

Example

Show a tag 
GET /cdna-api/common/tag/9?properties={id,name} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "data": {
    "id": 9,
    "name": "api-reference"
  }
}
Open in Postman docs Real response from this documentation site

Learn more

GuideShaping the response with properties FAQMy properties fields come back as "Error: Getter for property … not found", or glued together

Check that a tag slug is free#

POST /cdna-api/common/check-tag-slug

Answers {"result":"success"} when no tag uses the slug. A slug in use, or one with characters a slug cannot have, answers HTTP 200 too, with "result": "error" and a message.

Access
Admin users and integrations, with an OAuth access token or an API key.

Parameters

slugbodyrequired
string
The slug to check.
idbody
integer
A record to leave out of the check, when renaming it.
sitebody
integer
The site to check in.

Example

Check that a tag slug is free 
POST /cdna-api/common/check-tag-slug HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Content-Type: application/json

{
  "slug": "api-sandbox-tag"
}
Response 200 OKFree 
{
  "result": "success"
}
Real response from this documentation site