Badge Templates

New Badge template creation flow

Create a new Badge template

Creates a new badge template for an organization. This endpoint allows defining the characteristics and metadata of a badge, such as title, images, assignment criteria, and associated information.

POST: /api/v1/issuers/organization/badge_templates

Inactive badge templates cannot be assigned to users
Marked as Public badge templates are displayed at the Public org page

Key	Value
title	Shark Course A1
application_scope	Nature
assignment_criteria	Must know sharks
language	en
color_primary	#FFFFFF
code	DALP
type	skills
type_data[acquired_knowledge]	Test Knowledge
type_data[acquired_skills]	Test Skills
type_data[acquired_attitudes]	Test Attitudes
type_data[application_scope]	Test Scope
description	This is a test for learning path
other_org	Test other Org
other_org_info	Test other info
is_learning_path	0
status	active
is_published	1
background_image	[file content]
image	[file content]

{
    "data": {
        "id": "8b50eede-67f3-4903-9b76-d41031c8b225",
        "organization_id": "e5737c21-0645-4616-9b25-c010685c5b30",
        "title": "Shark Course A1",
        "application_scope": "Nature",
        "assignment_criteria": "Must know sharks",
        "image_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/sample.png",
        "image_high_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/sample_high.png",
        "image_thumbnail_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/sample_thumbnail.png",
        "background_image_path": null,
        "color_primary": "#FFFFFF",
        "code": "DALP",
        "type": "skills",
        "type_data": {
            "acquired_knowledge": "Test Knowledge",
            "acquired_skills": "Test Skills",
            "acquired_attitudes": "Test Attitudes",
            "application_scope": "Test Scope"
        },
        "description": "This is a test for learning path",
        "other_org": "Test other Org",
        "other_org_info": "Test other info",
        "language": "en",
        "is_learning_path": "0",
        "version_code": 0,
        "status": "active",
        "is_published": "1",
        "badge_template_version_id": null
    }
}

Upload an Image to a Badge Template

Uploads a selected image to a Badge template.

POST: /api/v1/issuers/organization/badge_templates/{template_id}/image

{ "data": { "id": "38220fcc-8d90-4b1e-9707-d8e969d3ef1a", "organization_id": "0f11feda-07f8-4202-9133-4a4e780e857d", "title": "English C1.1 \u2013 Advanced Proficiency", "assignment_criteria": "Assignments will include a formal essay, oral presentation, group discussion, and a report or proposal, all requiring advanced vocabulary, grammar, and fluency. Additionally, listening comprehension tests and a grammar\/vocabulary test will assess understanding of complex topics and accurate use of language. Each task will be evaluated on clarity, structure, advanced language usage, and minimal errors, ensuring learners can communicate effectively in professional and academic contexts.<\/p>", "image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/badge-templates-images\/KR62rB0P5XxpIlScftG1OEov3F6TXz07iuREAbwt.jpg", "image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/badge-templates-images\/KR62rB0P5XxpIlScftG1OEov3F6TXz07iuREAbwt_high.jpg", "image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/badge-templates-images\/KR62rB0P5XxpIlScftG1OEov3F6TXz07iuREAbwt_thumbnail.jpg", "background_image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/pYxx5o5A0dsbUlHrCBBkAIR9RJoZAY7nk9lyRO3b.png", "background_image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/pYxx5o5A0dsbUlHrCBBkAIR9RJoZAY7nk9lyRO3b_high.png", "background_image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/pYxx5o5A0dsbUlHrCBBkAIR9RJoZAY7nk9lyRO3b_thumbnail.png", "color_primary": null, "code": "ENC1", "type": "qualification", "type_data": { "acquired_knowledge": "Upon earning this qualification badge, learners will have demonstrated a deep understanding of advanced English grammar, including complex sentence structures, conditionals, and passive voice. They will have mastered a wide range of formal and informal vocabulary, idiomatic expressions, and phrasal verbs. Additionally, learners will be proficient in critical listening, reading comprehension of complex texts, and effective written and spoken communication. This knowledge will enable them to engage fluently and confidently in professional, academic, and social interactions.<\/p>", "acquired_skills": "<ul><li>Fluent and confident spoken communication in professional, academic, and social settings.<\/li><li>Ability to deliver structured presentations and engage in debates.<\/li><li>Proficient in writing clear, well-organized essays, reports, and proposals.<\/li><li>Strong listening comprehension for complex spoken language.<\/li><li>Advanced reading and analysis of sophisticated texts.<\/li><li>Precise use of advanced grammar and vocabulary.<\/li><li>Adaptation of language style to various contexts and audiences.<\/li><\/ul>", "acquired_attitudes": "<ul><li>Confidence<\/strong>: A proactive approach to engaging in high-level discussions and presentations.<\/li><li>Critical Thinking<\/strong>: An analytical mindset for evaluating complex texts and arguments.<\/li><li>Cultural Sensitivity<\/strong>: An awareness of diverse perspectives and contexts in communication.<\/li><li>Professionalism<\/strong>: A commitment to maintaining formal and appropriate language in various settings.<\/li><li>Adaptability<\/strong>: Flexibility in adjusting communication strategies to suit different audiences and purposes.<\/li><li>Continuous Improvement<\/strong>: A dedication to ongoing learning and refinement of language skills.<\/li><\/ul>", "application_scope": " <\/p>The skills developed in this course will be applicable to professional, academic, and social environments, enabling learners to engage in complex discussions, deliver presentations, write formal documents, and comprehend advanced materials with ease.<\/p>" }, "description": "This course is designed for learners aiming to reach an advanced level of English proficiency, equivalent to C1 on the Common European Framework of Reference for Languages (CEFR). The course will enhance your ability to communicate fluently and accurately in complex situations, both in spoken and written English.<\/p>", "other_org": "LangPower s.r.l.", "other_org_info": "Learners are expected to demonstrate not only linguistic proficiency but also cultural awareness and critical thinking skills throughout their assignments.", "learn_more_url": null, "language": "en", "is_learning_path": 0, "version_code": "1", "status": "active", "archived_at": null, "is_published": 1, "badge_template_version_id": "33998fc8-a8cb-4eca-8acf-4e4430952562", "created_at": "2024-09-12T12:11:44.000000Z", "updated_at": "2024-09-18T10:47:27.000000Z", "organization": { "id": "0f11feda-07f8-4202-9133-4a4e780e857d", .... }, "badges_count": 1, "is_assignable": true, } }

Upload a Background image to a Badge Template

Uploads a selected image as a background to a Badge template

POST: /api/v1/issuers/organization/badge_templates/{template_id}/image

{ "data": { "id": "38220fcc-8d90-4b1e-9707-d8e969d3ef1a", "organization_id": "0f11feda-07f8-4202-9133-4a4e780e857d", "title": "English C1.1 \u2013 Advanced Proficiency", "assignment_criteria": "Assignments will include a formal essay, oral presentation, group discussion, and a report or proposal, all requiring advanced vocabulary, grammar, and fluency. Additionally, listening comprehension tests and a grammar\/vocabulary test will assess understanding of complex topics and accurate use of language. Each task will be evaluated on clarity, structure, advanced language usage, and minimal errors, ensuring learners can communicate effectively in professional and academic contexts.<\/p>", "image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/badge-templates-images\/KR62rB0P5XxpIlScftG1OEov3F6TXz07iuREAbwt.jpg", "image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/badge-templates-images\/KR62rB0P5XxpIlScftG1OEov3F6TXz07iuREAbwt_high.jpg", "image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/organizations\/0f11feda-07f8-4202-9133-4a4e780e857d\/badge-templates-images\/KR62rB0P5XxpIlScftG1OEov3F6TXz07iuREAbwt_thumbnail.jpg", "background_image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/pYxx5o5A0dsbUlHrCBBkAIR9RJoZAY7nk9lyRO3b.png", "background_image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/pYxx5o5A0dsbUlHrCBBkAIR9RJoZAY7nk9lyRO3b_high.png", "background_image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/pYxx5o5A0dsbUlHrCBBkAIR9RJoZAY7nk9lyRO3b_thumbnail.png", "color_primary": null, "code": "ENC1", "type": "qualification", "type_data": { "acquired_knowledge": "Upon earning this qualification badge, learners will have demonstrated a deep understanding of advanced English grammar, including complex sentence structures, conditionals, and passive voice. They will have mastered a wide range of formal and informal vocabulary, idiomatic expressions, and phrasal verbs. Additionally, learners will be proficient in critical listening, reading comprehension of complex texts, and effective written and spoken communication. This knowledge will enable them to engage fluently and confidently in professional, academic, and social interactions.<\/p>", "acquired_skills": "<ul><li>Fluent and confident spoken communication in professional, academic, and social settings.<\/li><li>Ability to deliver structured presentations and engage in debates.<\/li><li>Proficient in writing clear, well-organized essays, reports, and proposals.<\/li><li>Strong listening comprehension for complex spoken language.<\/li><li>Advanced reading and analysis of sophisticated texts.<\/li><li>Precise use of advanced grammar and vocabulary.<\/li><li>Adaptation of language style to various contexts and audiences.<\/li><\/ul>", "acquired_attitudes": "<ul><li>Confidence<\/strong>: A proactive approach to engaging in high-level discussions and presentations.<\/li><li>Critical Thinking<\/strong>: An analytical mindset for evaluating complex texts and arguments.<\/li><li>Cultural Sensitivity<\/strong>: An awareness of diverse perspectives and contexts in communication.<\/li><li>Professionalism<\/strong>: A commitment to maintaining formal and appropriate language in various settings.<\/li><li>Adaptability<\/strong>: Flexibility in adjusting communication strategies to suit different audiences and purposes.<\/li><li>Continuous Improvement<\/strong>: A dedication to ongoing learning and refinement of language skills.<\/li><\/ul>", "application_scope": " <\/p>The skills developed in this course will be applicable to professional, academic, and social environments, enabling learners to engage in complex discussions, deliver presentations, write formal documents, and comprehend advanced materials with ease.<\/p>" }, "description": "This course is designed for learners aiming to reach an advanced level of English proficiency, equivalent to C1 on the Common European Framework of Reference for Languages (CEFR). The course will enhance your ability to communicate fluently and accurately in complex situations, both in spoken and written English.<\/p>", "other_org": "LangPower s.r.l.", "other_org_info": "Learners are expected to demonstrate not only linguistic proficiency but also cultural awareness and critical thinking skills throughout their assignments.", "learn_more_url": null, "language": "en", "is_learning_path": 0, "version_code": "1", "status": "active", "archived_at": null, "is_published": 1, "badge_template_version_id": "33998fc8-a8cb-4eca-8acf-4e4430952562", "created_at": "2024-09-12T12:11:44.000000Z", "updated_at": "2024-09-18T10:47:27.000000Z", "organization": { ... }, "badges_count": 1, "is_assignable": true, } }

Update a Badge template

Updates an existing badge template.

PUT: /api/v1/issuers/organization/badge_templates/{template_id}

{
  "title": "English C1.1 – Advanced Proficiency",
  "color_primary": "",
  "type_data": {
    "acquired_knowledge": "<p>Upon earning this qualification badge, learners will have demonstrated a deep understanding of advanced English grammar, including complex sentence structures, conditionals, and passive voice. They will have mastered a wide range of formal and informal vocabulary, idiomatic expressions, and phrasal verbs. Additionally, learners will be proficient in critical listening, reading comprehension of complex texts, and effective written and spoken communication. This knowledge will enable them to engage fluently and confidently in professional, academic, and social interactions.</p>",
    "acquired_skills": "<ul><li>Fluent and confident spoken communication in professional, academic, and social settings.</li><li>Ability to deliver structured presentations and engage in debates.</li><li>Proficient in writing clear, well-organized essays, reports, and proposals.</li><li>Strong listening comprehension for complex spoken language.</li><li>Advanced reading and analysis of sophisticated texts.</li><li>Precise use of advanced grammar and vocabulary.</li><li>Adaptation of language style to various contexts and audiences.</li></ul>",
    "acquired_attitudes": "<ul><li><strong>Confidence</strong>: A proactive approach to engaging in high-level discussions and presentations.</li><li><strong>Critical Thinking</strong>: An analytical mindset for evaluating complex texts and arguments.</li><li><strong>Cultural Sensitivity</strong>: An awareness of diverse perspectives and contexts in communication.</li><li><strong>Professionalism</strong>: A commitment to maintaining formal and appropriate language in various settings.</li><li><strong>Adaptability</strong>: Flexibility in adjusting communication strategies to suit different audiences and purposes.</li><li><strong>Continuous Improvement</strong>: A dedication to ongoing learning and refinement of language skills.</li></ul>",
    "application_scope": "<p><br></p><p>The skills developed in this course will be applicable to professional, academic, and social environments, enabling learners to engage in complex discussions, deliver presentations, write formal documents, and comprehend advanced materials with ease.</p>"
  },
  "is_learning_path": false
}

{ "data": { "id": "38220fcc-8d90-4b1e-9707-d8e969d3ef1a", "organization_id": "0f11feda-07f8-4202-9133-4a4e780e857d", "title": "English C1.1 \u2013 Advanced Proficiency", "assignment_criteria": "Assignments will include a formal essay, oral presentation, group discussion, and a report or proposal, all requiring advanced vocabulary, grammar, and fluency. Additionally, listening comprehension tests and a grammar\/vocabulary test will assess understanding of complex topics and accurate use of language. Each task will be evaluated on clarity, structure, advanced language usage, and minimal errors, ensuring learners can communicate effectively in professional and academic contexts.<\/p>", "image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-images\/GLD3aoHp6G6KTVress5BSySFaCALrnkdGHEXpjZQ.png", "image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-images\/GLD3aoHp6G6KTVress5BSySFaCALrnkdGHEXpjZQ_high.png", "image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-images\/GLD3aoHp6G6KTVress5BSySFaCALrnkdGHEXpjZQ_thumbnail.png", "background_image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/pYxx5o5A0dsbUlHrCBBkAIR9RJoZAY7nk9lyRO3b.png", "background_image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-images\/GLD3aoHp6G6KTVress5BSySFaCALrnkdGHEXpjZQ_high.png", "background_image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-images\/GLD3aoHp6G6KTVress5BSySFaCALrnkdGHEXpjZQ_thumbnail.png", "color_primary": null, "code": "ENC1", "type": "qualification", "type_data": { "acquired_knowledge": "Upon earning this qualification badge, learners will have demonstrated a deep understanding of advanced English grammar, including complex sentence structures, conditionals, and passive voice. They will have mastered a wide range of formal and informal vocabulary, idiomatic expressions, and phrasal verbs. Additionally, learners will be proficient in critical listening, reading comprehension of complex texts, and effective written and spoken communication. This knowledge will enable them to engage fluently and confidently in professional, academic, and social interactions.<\/p>", "acquired_skills": "<ul><li>Fluent and confident spoken communication in professional, academic, and social settings.<\/li><li>Ability to deliver structured presentations and engage in debates.<\/li><li>Proficient in writing clear, well-organized essays, reports, and proposals.<\/li><li>Strong listening comprehension for complex spoken language.<\/li><li>Advanced reading and analysis of sophisticated texts.<\/li><li>Precise use of advanced grammar and vocabulary.<\/li><li>Adaptation of language style to various contexts and audiences.<\/li><\/ul>", "acquired_attitudes": "<ul><li>Confidence<\/strong>: A proactive approach to engaging in high-level discussions and presentations.<\/li><li>Critical Thinking<\/strong>: An analytical mindset for evaluating complex texts and arguments.<\/li><li>Cultural Sensitivity<\/strong>: An awareness of diverse perspectives and contexts in communication.<\/li><li>Professionalism<\/strong>: A commitment to maintaining formal and appropriate language in various settings.<\/li><li>Adaptability<\/strong>: Flexibility in adjusting communication strategies to suit different audiences and purposes.<\/li><li>Continuous Improvement<\/strong>: A dedication to ongoing learning and refinement of language skills.<\/li><\/ul>", "application_scope": " <\/p>The skills developed in this course will be applicable to professional, academic, and social environments, enabling learners to engage in complex discussions, deliver presentations, write formal documents, and comprehend advanced materials with ease.<\/p>" }, "description": "This course is designed for learners aiming to reach an advanced level of English proficiency, equivalent to C1 on the Common European Framework of Reference for Languages (CEFR). The course will enhance your ability to communicate fluently and accurately in complex situations, both in spoken and written English.<\/p>", "other_org": "LangPower s.r.l.", "other_org_info": "Learners are expected to demonstrate not only linguistic proficiency but also cultural awareness and critical thinking skills throughout their assignments.", "learn_more_url": null, "language": "en", "is_learning_path": 0, "version_code": "1", "status": "active", "is_published": 1, "badge_template_version_id": "33998fc8-a8cb-4eca-8acf-4e4430952562", "created_at": "2024-09-12T12:11:44.000000Z", "updated_at": "2024-09-16T13:59:40.000000Z", "organization": { "id": "0f11feda-07f8-4202-9133-4a4e780e857d", .... }, "badges_count": 1, "is_assignable": true, } }

Retrieve Badge template details

Retrieves details of a badge template by its ID.

GET: /api/v1/issuers/organization/badge_templates/{template_id}

{ "data": { "id": "38220fcc-8d90-4b1e-9707-d8e969d3ef1a", "organization_id": "0f11feda-07f8-4202-9133-4a4e780e857d", "title": "English C1.1 \u2013 Advanced Proficiency", "assignment_criteria": "Assignments will include a formal essay, oral presentation, group discussion, and a report or proposal, all requiring advanced vocabulary, grammar, and fluency. Additionally, listening comprehension tests and a grammar\/vocabulary test will assess understanding of complex topics and accurate use of language. Each task will be evaluated on clarity, structure, advanced language usage, and minimal errors, ensuring learners can communicate effectively in professional and academic contexts.<\/p>", "image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-images\/GLD3aoHp6G6KTVress5BSySFaCALrnkdGHEXpjZQ.png", "image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-images\/GLD3aoHp6G6KTVress5BSySFaCALrnkdGHEXpjZQ_high.png", "image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-images\/GLD3aoHp6G6KTVress5BSySFaCALrnkdGHEXpjZQ_thumbnail.png", "background_image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/pYxx5o5A0dsbUlHrCBBkAIR9RJoZAY7nk9lyRO3b.png", "background_image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/pYxx5o5A0dsbUlHrCBBkAIR9RJoZAY7nk9lyRO3b_high.png", "background_image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/pYxx5o5A0dsbUlHrCBBkAIR9RJoZAY7nk9lyRO3b_thumbnail.png", "color_primary": null, "code": "ENC1", "type": "qualification", "type_data": { "acquired_knowledge": "Upon earning this qualification badge, learners will have demonstrated a deep understanding of advanced English grammar, including complex sentence structures, conditionals, and passive voice. They will have mastered a wide range of formal and informal vocabulary, idiomatic expressions, and phrasal verbs. Additionally, learners will be proficient in critical listening, reading comprehension of complex texts, and effective written and spoken communication. This knowledge will enable them to engage fluently and confidently in professional, academic, and social interactions.<\/p>", "acquired_skills": "<ul><li>Fluent and confident spoken communication in professional, academic, and social settings.<\/li><li>Ability to deliver structured presentations and engage in debates.<\/li><li>Proficient in writing clear, well-organized essays, reports, and proposals.<\/li><li>Strong listening comprehension for complex spoken language.<\/li><li>Advanced reading and analysis of sophisticated texts.<\/li><li>Precise use of advanced grammar and vocabulary.<\/li><li>Adaptation of language style to various contexts and audiences.<\/li><\/ul>", "acquired_attitudes": "<ul><li>Confidence<\/strong>: A proactive approach to engaging in high-level discussions and presentations.<\/li><li>Critical Thinking<\/strong>: An analytical mindset for evaluating complex texts and arguments.<\/li><li>Cultural Sensitivity<\/strong>: An awareness of diverse perspectives and contexts in communication.<\/li><li>Professionalism<\/strong>: A commitment to maintaining formal and appropriate language in various settings.<\/li><li>Adaptability<\/strong>: Flexibility in adjusting communication strategies to suit different audiences and purposes.<\/li><li>Continuous Improvement<\/strong>: A dedication to ongoing learning and refinement of language skills.<\/li><\/ul>", "application_scope": " <\/p>The skills developed in this course will be applicable to professional, academic, and social environments, enabling learners to engage in complex discussions, deliver presentations, write formal documents, and comprehend advanced materials with ease.<\/p>" }, "description": "This course is designed for learners aiming to reach an advanced level of English proficiency, equivalent to C1 on the Common European Framework of Reference for Languages (CEFR). The course will enhance your ability to communicate fluently and accurately in complex situations, both in spoken and written English.<\/p>", "other_org": "LangPower s.r.l.", "other_org_info": "Learners are expected to demonstrate not only linguistic proficiency but also cultural awareness and critical thinking skills throughout their assignments.", "learn_more_url": null, "language": "en", "is_learning_path": 0, "version_code": "1", "status": "active", "archived_at": null, "is_published": 1, "badge_template_version_id": "33998fc8-a8cb-4eca-8acf-4e4430952562", "created_at": "2024-09-12T12:11:44.000000Z", "updated_at": "2024-09-16T13:59:40.000000Z", "organization": { "id": "0f11feda-07f8-4202-9133-4a4e780e857d", ... }, "badges_count": 1, "is_assignable": true, } }

Badge templates listing

Lists badge templates based on various filters like creation date range, type, id, name and whether they are part of a learning path.

GET: {{baseUrl}}/api/v1/issuers/organization/badge_templates

Query Parameters

created_at_after: Retrieve templates created after this date, date format YYYY-MM-DD.
created_at_before: Retrieve templates created before this date, date format YYYY-MM-DD.
is_learning_path: Retrieve by learning path status (1 for true, 0 for false).
id: Retrieve by a specific template id
title: Filter by the title
application_scope: Filter by the scope
code: Retrieve by specific badge template code (e.g., MN224).
type: Retrieve by type (knowledge, skills, participation, qualification).
description: Filter by description (e.g., desc).
is_learning_path: Retrieves by learning path status (1 for true, 0 for false).
status: Filter by status (active, draft, archived).
badge_template_version_id: Retrieve by a specific badge template version ID (e.g., a3709939-32b9-4316-a6e3-0f051fdd571a).
language: Retrieve by specific language code (it, en).
other_org: Filter by organization (e.g., Sample org).
is_published: Retrieves by publish status (1 for true, 0 for false).
search: Search across fields like title, description, type, type_data.
color_primary: Filter by primary color (e.g., #FFFFF).

{ "data": [ { "id": "2072afd3-6eb1-11ef-bb48-96000077da57", "organization_id": "4baef4d7-6bb1-11ef-bb48-96000077da57", "title": "Master in Fashion Management", "assignment_criteria": "Il Badge Qualificazione - <\/strong>viene rilasciato a seguito di un percorso di formazione teorico e pratico, e attesta uno standard di conoscenze, abilit\u00e0 e competenze che consentono di svolgere la professione come da qualifica.<\/p>\r\n", "image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/imported-badge-templates\/532-4baef4d7-6bb1-11ef-bb48-96000077da57.png", "image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/imported-badge-templates\/532-4baef4d7-6bb1-11ef-bb48-96000077da57_high.png", "image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/imported-badge-templates\/532-4baef4d7-6bb1-11ef-bb48-96000077da57_thumbnail.png", "background_image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/Oy1FXS9STzHnVeVLMVAvbtgQ8lrt34k6iottpF8b.jpg", "background_image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/imported-badge-templates\/532-4baef4d7-6bb1-11ef-bb48-96000077da57_high.png", "background_image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/imported-badge-templates\/532-4baef4d7-6bb1-11ef-bb48-96000077da57_thumbnail.png", "color_primary": "#0D3D0D", "code": "002-02-2024", "type": "qualification", "type_data": { "acquired_skills": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas porttitor congue massa. Fusce posuere, magna sed pulvinar ultricies, purus lectus malesuada libero, sit amet commodo magna eros quis urna.<\/span><\/span><\/span><\/p>\r\n\r\nNunc viverra imperdiet enim. Fusce est. Vivamus a tellus.<\/span><\/span><\/span><\/p>\r\n\r\nPellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin pharetra nonummy pede. Mauris et orci.<\/span><\/span><\/span><\/p>\r\n\r\nAenean nec lorem. In porttitor. Donec laoreet nonummy augue.<\/span><\/span><\/span><\/p>\r\n\r\nSuspendisse dui purus, scelerisque at, vulputate vitae, pretium mattis, nunc. Mauris eget neque at sem venenatis eleifend. Ut nonummy.<\/span><\/span><\/span><\/p>\r\n", "acquired_knowledge": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. <\/span>Maecenas porttitor congue massa. Fusce posuere, magna sed pulvinar ultricies, purus lectus malesuada libero, sit amet commodo magna eros quis urna.<o:p><\/o:p><\/span><\/p>\r\n\r\nNunc viverra imperdiet enim. Fusce est. Vivamus a tellus.<o:p><\/o:p><\/span><\/p>\r\n\r\nPellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin pharetra nonummy pede. Mauris et orci.<o:p><\/o:p><\/span><\/p>\r\n\r\nAenean nec lorem. <\/span>In porttitor. Donec laoreet nonummy augue.<o:p><\/o:p><\/span><\/p>\r\n\r\nSuspendisse dui purus, scelerisque at, vulputate vitae, pretium mattis, nunc. Mauris eget neque at sem venenatis eleifend. Ut nonummy.<\/span><o:p><\/o:p><\/p>\r\n", "application_scope": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas porttitor congue massa. Fusce posuere, magna sed pulvinar ultricies, purus lectus malesuada libero, sit amet commodo magna eros quis urna.<\/span><\/span><\/span><\/p>\r\n\r\nNunc viverra imperdiet enim. Fusce est. Vivamus a tellus.<\/span><\/span><\/span><\/p>\r\n\r\nPellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin pharetra nonummy pede. Mauris et orci.<\/span><\/span><\/span><\/p>\r\n\r\nAenean nec lorem. In porttitor. Donec laoreet nonummy augue.<\/span><\/span><\/span><\/p>\r\n\r\nSuspendisse dui purus, scelerisque at, vulputate vitae, pretium mattis, nunc. Mauris eget neque at sem venenatis eleifend. Ut nonummy.<\/span><\/span><\/span><\/p>\r\n" }, "description": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas porttitor congue massa. Fusce posuere, magna sed pulvinar ultricies, purus lectus malesuada libero, sit amet commodo magna eros quis urna.\r\nNunc viverra imperdiet enim. Fusce est. Vivamus a tellus.\r\n", "other_org": null, "other_org_info": null, "learn_more_url": null, "language": "it", "is_learning_path": 0, "version_code": "1", "status": "active", "is_published": 0, "badge_template_version_id": null, "created_at": "2024-09-05T10:15:23.000000Z", "updated_at": "2024-09-09T15:40:50.000000Z", "organization": { "id": "4baef4d7-6bb1-11ef-bb48-96000077da57", .... }, "badges_count": 3, "is_assignable": true }, { "id": "2072ab72-6eb1-11ef-bb48-96000077da57", "organization_id": "4baef4d7-6bb1-11ef-bb48-96000077da57", "title": "Fashion Design & Accessories", "assignment_criteria": "Il Badge Qualificazione - <\/strong>viene rilasciato a seguito di un percorso di formazione teorico e pratico, e attesta uno standard di conoscenze, abilit\u00e0 e competenze che consentono di svolgere la professione come da qualifica.<\/p>\r\n", "image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/imported-badge-templates\/531-4baef4d7-6bb1-11ef-bb48-96000077da57.png", "image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/imported-badge-templates\/531-4baef4d7-6bb1-11ef-bb48-96000077da57_high.png", "image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/imported-badge-templates\/531-4baef4d7-6bb1-11ef-bb48-96000077da57_thumbnail.png", "background_image_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/badge-templates-background-images\/Oy1FXS9STzHnVeVLMVAvbtgQ8lrt34k6iottpF8b.jpg", "background_image_high_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/imported-badge-templates\/531-4baef4d7-6bb1-11ef-bb48-96000077da57_high.png", "background_image_thumbnail_path": "https:\/\/storage.googleapis.com\/openbadge-public\/open-badges-dev\/imported-badge-templates\/531-4baef4d7-6bb1-11ef-bb48-96000077da57_thumbnail.png", "color_primary": "#0D3D0D", "code": "001-01-2024", "type": "qualification", "type_data": { "acquired_skills": "Lorem ipsum<\/b> dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat<\/p>\r\n", "acquired_knowledge": "Lorem ipsum<\/b> dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat<\/p>\r\n", "application_scope": "Lorem ipsum<\/b> dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat<\/p>\r\n" }, "description": "These undergraduate programmes are designed for participants looking to enter the fashion world, and provide a complete education allowing participants to acquire the necessary knowledge and skills to pursue a career in the chosen field.", "other_org": null, "other_org_info": null, "learn_more_url": null, "language": "it", "is_learning_path": 0, "version_code": "1", "status": "active", "is_published": 0, "badge_template_version_id": null, "created_at": "2024-09-04T16:57:03.000000Z", "updated_at": "2024-09-09T15:40:50.000000Z", "organization": { "id": "4baef4d7-6bb1-11ef-bb48-96000077da57", .... }, "badges_count": 1, "is_assignable": true } ], "links": { "first": "https:\/\/openbadges.open-badge.eu\/api\/v1\/issuers\/organization\/badge_templates?page=1", "last": "https:\/\/openbadges.open-badge.eu\/api\/v1\/issuers\/organization\/badge_templates?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "https:\/\/openbadges.open-badge.eu\/api\/v1\/issuers\/organization\/badge_templates?page=1", "label": "1", "active": true }, { "url": null, "label": "Next »", "active": false } ], "path": "https:\/\/openbadges.open-badge.eu\/api\/v1\/issuers\/organization\/badge_templates", "per_page": 25, "to": 2, "total": 2 } }

Clone a Badge Template

Creates a new Badge template using the existing template details

POST: /api/v1/issuers/organization/badge_templates/{template_id}/clone

{ "data": { "id": "ceea52cd-888c-4e29-a87c-6e46bf8385aa", "organization_id": "e5737c21-0645-4616-9b25-c010685c5b30", "title": "Test Badge 2 (Clone)", "application_scope": "Test Scope", "assignment_criteria": "Test Criteria", "image_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/8pbXRjfaC77XawxLRuJ7H1AvEHf4Zm1rdiaMiSCm.png", "image_high_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/8pbXRjfaC77XawxLRuJ7H1AvEHf4Zm1rdiaMiSCm_high.png", "image_thumbnail_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/8pbXRjfaC77XawxLRuJ7H1AvEHf4Zm1rdiaMiSCm_thumbnail.png", "background_image_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-background-images/v7yLAuFMOvzKO56sOoCOshT9vMapXgL03btAQmlg.png", "background_image_high_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/8pbXRjfaC77XawxLRuJ7H1AvEHf4Zm1rdiaMiSCm_high.png", "background_image_thumbnail_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/8pbXRjfaC77XawxLRuJ7H1AvEHf4Zm1rdiaMiSCm_thumbnail.png", "color_primary": "#FFFFFF", "code": "TEST_CODE", "type": "skills", "type_data": { "acquired_skills": "Test Skills", "application_scope": "Test Scope", "acquired_attitudes": "Test Attitudes", "acquired_knowledge": "Test Knowledge" }, "description": "This is a test badge", "other_org": "Test other Org", "other_org_info": "Test other info", "language": "en", "is_learning_path": 0, "version_code": 0, "status": "draft", "is_published": 1, "badge_template_version_id": null } }

Archive a Badge template

Archives the existing badge template.

PUT: /api/v1/issuers/organization/badge_templates/{template_id}/archive

{ "data": { "id": "ee281309-77c5-4638-a90c-45d77613506c", "organization_id": "0f11feda-07f8-4202-9133-4a4e780e857d", "title": "Supply Chain Manager", "assignment_criteria": "To earn this badge, candidates must complete the Supply Chain Management Certification program, which includes modules on procurement, logistics, inventory management, and demand forecasting. They must pass a rigorous certification exam with a score of 85% or higher and successfully complete a capstone project that involves analyzing and improving a real-world supply chain process.", "image_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/dprikw21u02sa7EkwRHqzxOjctt7OHQJK3gIvuXp.png", "image_high_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/dprikw21u02sa7EkwRHqzxOjctt7OHQJK3gIvuXp_high.png", "image_thumbnail_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-images/dprikw21u02sa7EkwRHqzxOjctt7OHQJK3gIvuXp_thumbnail.png", "background_image_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-background-images/HDMxU18tUzcbKXz6UOVNl5Em14XEIoz4GxTlts7V.png", "background_image_high_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-background-images/HDMxU18tUzcbKXz6UOVNl5Em14XEIoz4GxTlts7V_high.png", "background_image_thumbnail_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/badge-templates-background-images/HDMxU18tUzcbKXz6UOVNl5Em14XEIoz4GxTlts7V_thumbnail.png", "color_primary": "#FFFFFF", "code": "DALP", "type": "qualification", "type_data": { "acquired_skills": "Expertise in designing and implementing supply chain strategies, optimizing procurement processes, managing logistics operations, and ensuring efficient inventory management. Skills in using supply chain management software, analyzing supply chain data to make informed decisions, and developing contingency plans to mitigate risks.", "application_scope": "Test Scope", "acquired_attitudes": "A strategic and analytical mindset focused on continuous improvement and innovation in supply chain processes, a commitment to sustainability and ethical sourcing practices, and a proactive approach to managing supply chain risks and disruptions. Strong leadership and communication skills, with an emphasis on collaboration and stakeholder engagement to drive supply chain excellence.", "acquired_knowledge": "In-depth understanding of supply chain management principles, procurement strategies, logistics and transportation, inventory control, and demand forecasting. Knowledge of supply chain technologies, including ERP systems and supply chain analytics. Familiarity with global supply chain trends and regulatory requirements." }, "description": "The Certified Supply Chain Manager badge is awarded to professionals who have demonstrated a comprehensive understanding and expertise in managing and optimizing supply chain operations. This certification highlights their ability to oversee the end-to-end supply chain processes, ensuring efficiency, cost-effectiveness, and the ability to respond to market demands.", "other_org": "Global Supply Chain Management Institute", "other_org_info": null, "learn_more_url": null, "language": "en", "is_learning_path": null, "version_code": "1", "status": "archived", "archived_at": "2024-09-18 08:01:08", "is_published": 1, "badge_template_version_id": "a6295a4e-b76f-4fef-90fa-84815473bd44", "created_at": "2024-07-05T13:12:36.000000Z", "updated_at": "2024-09-18T08:01:08.000000Z", "organization": { "id": "0f11feda-07f8-4202-9133-4a4e780e857d", "type": "public_local_national", "activity": "school", "name": "LearnQuest Academy", "description": "Welcome to LearnQuest Academy, where education meets innovation! At LearnQuest, we offer a diverse array of courses designed to expand your knowledge and skills across various topics. Upon successful completion of each course, students earn distinctive badges, showcasing their achievements and expertise. Whether you're delving into technology, arts, sciences, or personal development, our engaging curriculum and dedicated instructors ensure a comprehensive learning experience. Join us at LearnQuest Academy and start earning your badges today!!!", "address_info": { "city": "Example City", "state": "Example State", "region": "Example Region", "street": "123 Example Street", "country": "Example Country", "postcode": "12345" }, "billing_info": { "vat": "VAT123456", "email": "billing@open-badge.eu", "code_dest": "CODE123", "fiscal_code": "FISCAL123", "certified_email": "certified@open-badge.eu", "legal_name": "LearnQuest Academy s.r.l." }, "language": "en", "website": "https://www.example.com", "status": "enabled", "contact_info": { "name": "John", "email": "contact@open-badge.eu", "mobile": "+001234567890", "last_name": "Doe", "tech_email": "tech@open-badge.eu", "legal_email": "legal@open-badge.eu" }, "settings": { "public_profile": 1, "public_badge_types": 1, "public_learning_paths": 0, "public_badge_templates": 1 }, "logo_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/organizations-logos/6TalPeDfAOhG9wUzMvrzSR5lASWfSr6U05a1IhS1.png", "logo_high_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/organizations-logos/6TalPeDfAOhG9wUzMvrzSR5lASWfSr6U05a1IhS1_high.png", "logo_thumbnail_path": "https://storage.googleapis.com/openbadge-public/open-badges-dev/organizations-logos/6TalPeDfAOhG9wUzMvrzSR5lASWfSr6U05a1IhS1_thumbnail.png", "credits_left": 39024, "badge_templates_count": 24, "badges_count": 737, "created_at": "2024-07-03T15:02:45.000000Z", "updated_at": "2024-09-16T13:29:52.000000Z", "public_url": "http://localhost/public/issuers/0f11feda-07f8-4202-9133-4a4e780e857d", "stripe_customer_id": "cus_QpT1CW2JIJb9fL", "subscription_id": null, "subscription_status": "active", "current_period_start": "2024-09-16 13:29:49", "current_period_end": "2024-10-16 13:29:49" }, "badges_count": 8, "is_assignable": false, } }

Delete a Badge template

Deletes the existing badge template.

DELETE: /api/v1/issuers/organization/badge_templates/{template_id}

Status code 204

Last modified: 12 November 2024