API Get Tags
From zFairs Contest Management
Get Tags
Returns existing tags that can be applied to people or projects (entries), grouped by type.
Authentication
All data API calls are POST (unless noted) with JSON body:
| Field | Required | Description |
|---|---|---|
ApiKey |
Yes | Private API key for your site. |
FairId |
Yes | Fair GUID from the site URL (f query parameter).
|
Body |
Depends | Request payload. Use {} when no body fields are needed.
|
Calls must be run server-side — do not expose your API key in a browser.
Response envelope
Most endpoints return:
{
Success: true,
Message: null, // error text when Success is false
Body: { ... } // endpoint-specific payload
}
Request
fetch('/api/data/tags', {
method:'POST',
headers:{'Content-Type': 'application/json'},
body: JSON.stringify({
ApiKey:'<Private key>',
FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
Body: {}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});Response
On success Body looks like:
{
Success: true,
Message: null,
Body: {
tags: {
projectTags: [{ Id: 31, Value: "Review Needed" }],
personTags: [{ Id: 3, Value: "Best Judge Ever" }],
autoTags: [{ Id: 99, Value: "Auto: Incomplete" }],
allTags: [{ Id: 31, Value: "Review Needed", Type: "project", Color: "#ff0000" }]
}
}
}
Field notes
- Use tag
Idwith API Set Tags and API Remove Tags. allTagsincludes every tag withTypeandColor.- Tag names also appear on API Get Projects, API Get participants, judges, and teachers as string arrays.
Related APIs