List tag definitions
Lists tag definitions available to the current project.
/api/tag-definitionsLists tag definitions available to the current project. The response is ordered alphabetically by name and is intended for filter, tag picker, and settings screens.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
tag-definitions:read- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.
Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "data": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "vip", "color": "#A855F7", "projectScope": "selected", "projectIds": [ "11111111-1111-4111-8111-111111111111" ], "createdAt": "2026-06-23T08:00:00.000Z", "updatedAt": "2026-06-23T08:00:00.000Z" } ]}Request examples
curl
curl --request GET \
'https://api.convor.io/api/tag-definitions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/tag-definitions", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_..."
},
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?