Skip to main content
Accredible certificates logo
  • Category: education
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 36
  • Triggers: 0
  • Slug: ACCREDIBLE_CERTIFICATES
  • Version: 20261101_00

Tools

Slug: ACCREDIBLE_CERTIFICATES_BULK_CREATE_CREDENTIALS_V2Tool to bulk create credentials. Use when batching up to 30 credentials in one call; supports multi-status (207) responses.

Input Parameters

array
required
List of up to 30 credentials to create in one batch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_CLONE_GROUPTool to clone an existing group. Use after confirming the source group exists and you need a copy with optional overrides.

Input Parameters

string
Override name of the cloned group (prefixed with ‘Copy’ if omitted)
integer
required
ID of the group to clone
string ("en" | "es" | "vi" | "pt" | "ja" | "fr" | "da" | "nl" | "fi" | "no" | "nb" | "ro" | "sv" | "th" | "tw" | "zh" | "tr" | "ar" | "he" | "ms" | "de")
Override language code for the group
object
Override arbitrary metadata for the group
boolean
Override PDF attachment setting when notifying recipients
boolean
Override blockchain recording setting
string
Override signup URL for course enrollment
integer
Override credential auto-expiry in years; ignored if <=0
Override URL for the course information page
string
Override course or achievement name visible to the recipient
integer
Override badge design ID
boolean
Override showing signup URL
Override showing course link
array
Override list of learning outcomes
integer
Override primary design ID
integer
Override skill category association
string
Override description visible to the recipient
integer
Override certificate design ID
Override showing organization link
boolean
Override allowing duplicate credentials per email
boolean
Override private credential default: true, false, or null to inherit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_CREATE_ATTRIBUTE_KEYTool to create a new custom attribute key. Use when you need to define a new custom attribute for credentials. Requires department ID to associate the attribute with a specific department.

Input Parameters

string ("text" | "date" | "email" | "image")
required
Type of the custom attribute key. Determines how the attribute is displayed and validated.
string
required
Name of the custom attribute key. This is the internal identifier for the attribute.
integer
required
Department ID that the custom attribute key belongs to. Required to associate the attribute with a specific department.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_CREATE_COLLECTIONTool to create a new collection. Use when you need a curated set of groups.

Input Parameters

string
required
Name of the collection
boolean
Whether the collection is public
string
Description of the collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_CREATE_CREDENTIALTool to create a new credential with optional evidence items and references. Use when issuing credentials to recipients; ensure group exists before creation.

Input Parameters

string
Credential/course name displayed to recipients. Required if Group doesn’t have Course Name set
boolean
Whether to publish credential at creation time. True by default but sandbox_mode settings take precedence
boolean
Whether to make credential private. If true, only visible to signed-in recipient
boolean
Whether the achievement is complete or in progress. True by default
integer
required
Group ID to which the credential should belong. Create a group first if needed
string
Date of issue in YYYY-MM-DD format. Default is creation date
object
Key-value strings for additional structured information about the credential
string
Expiration date in YYYY-MM-DD format. Null by default
array
References providing feedback from peers, teachers, or managers
string
Credential/course description displayed to recipients. Required if Group doesn’t have Course Description set
string
External ID for the recipient to map credentials regardless of email changes
string
Unique ID of the credential. If provided, used as reference; otherwise auto-assigned
array
Evidence items providing more information about how the recipient met the achievement
string
required
Name of the recipient the credential is issued to
string
required
Email address of the recipient
object
Custom variables to display on the credential. Keys are attribute names, values are display values
object
Key-value strings for additional structured information about the recipient
string
Recipient’s phone number in E.164 format (e.g., +14155552671)
boolean
Whether to allow recipients to add their own supplemental evidence. True by default
boolean
Whether to allow recipients to add their own supplemental references. True by default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_CREATE_EVIDENCE_ITEMTool to create a new evidence item for a credential. Use after confirming credential ID.

Input Parameters

string
URL of the item when category is url or video
string
File URL when category is file
string
Override preview image URL for URL category
string ("file" | "url" | "video" | "grade" | "transcript")
required
Type of evidence item, dictates its display
integer
Position index of the evidence item on the credential (0 = first)
string
required
Title text for the evidence item displayed on the credential
string
required
Global ID of the credential to attach the evidence item to
string
String data for grade or transcript categories, e.g., ‘83’
string
Override auto-generated insight text below the evidence item

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_CREATE_GROUPTool to create a new group. Use after gathering all group details.

Input Parameters

string
required
Name of the group (internal reference, not shown to the recipient)
string ("en" | "es" | "vi" | "pt" | "ja" | "fr" | "da" | "nl" | "fi" | "no" | "nb" | "ro" | "sv" | "th" | "tw" | "zh" | "tr" | "ar" | "he" | "ms" | "de")
Language code for the group
object
Arbitrary string key-value metadata for this group
boolean
Attach credential PDF to notification email
boolean
Record credentials on blockchain
string
Signup URL for course enrollment
integer
Years until auto-expiry of credential; ignored if <=0
array
List of collection objects with ‘id’ field
URL for course information page
string
required
Course or achievement name visible to the recipient
integer
Department ID for the group; defaults to org default
integer
Badge design ID to render credentials
boolean
Display signup URL: true/false or null to inherit
Display course link: true/false or null to inherit
array
Learning outcomes list for this group
integer
Primary design ID to render credentials
integer
Skill category ID to associate
string
required
Description of the course or achievement visible to the recipient
integer
Certificate design ID to render credentials
Display organization link: true/false or null to inherit
boolean
Allow duplicate credentials per email: true/false
boolean
Override default private credential setting: true/false or null to inherit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_CREATE_REFERENCETool to create a new reference for a credential. Use when you need to add a reference from someone who can vouch for the credential recipient’s skills or achievements.

Input Parameters

object
required
Reference object containing all the reference details.
string
required
ID of the credential to attach the reference to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_DELETE_COLLECTIONTool to delete a collection. Use after confirming you want to permanently remove an existing collection. Executes DELETE on /v1/collections/{collection_id} endpoint and returns status code.

Input Parameters

string
required
UUID of the collection to delete. Must be a valid collection identifier in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_DELETE_CREDENTIALTool to delete a credential. Use after confirming you want to permanently remove an existing credential. Executes DELETE on /credentials/{credential_id} endpoint and returns status code.

Input Parameters

string
required
The unique ID of the credential to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_DELETE_EVIDENCE_ITEMTool to delete an evidence item from a credential. Use after confirming you want to permanently remove a specific evidence item.

Input Parameters

string
required
ID of the Credential in the form of a string or integer for the particular Credential requested
integer
required
ID of the EvidenceItem in the form of an integer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_DELETE_GROUPTool to delete a group. Use after confirming no credentials remain and when you need to permanently remove the group.

Input Parameters

integer
required
Numeric ID of the group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_DELETE_REFERENCETool to delete a specific reference by ID. Use after confirming both credential_id and reference_id. Example: “Delete reference 1234 from credential ‘abc123’.”

Input Parameters

integer
required
ID of the Reference to delete (must be positive).
string
required
ID of the Credential to remove the reference from. May be numeric or string-formatted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_GENERATE_PD_FS_FOR_CREDENTIALSGenerate PDFs for multiple published credentials and return a link to a ZIP archive of certificate PDFs.

Input Parameters

array
required
List of published credential IDs to generate PDFs for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_GET_ANALYTICSTool to retrieve analytics data for credentials. Use when you need to track credential views, shares, and other events with optional date and group filters.

Input Parameters

integer
The pagination page number
string
Only return Credential analytic events recorded before the given end date. Format: YYYY-MM-DD (YYYY/MM/DD also works but is deprecated)
integer
Only return Credential analytic events relating to Credentials within the given Group
integer
The pagination response size, default of 100
string
Only return Credential analytic events recorded after the given start date. Format: YYYY-MM-DD (YYYY/MM/DD also works but is deprecated)
integer
Only return Credential analytic events relating to Credentials within the given Department

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_GET_CREDENTIALTool to view a credential by ID. Use when you need to retrieve detailed information about a specific credential.

Input Parameters

string
required
ID of the Credential in the form of an integer or string for the particular Credential requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_GET_CREDENTIAL_ANALYTICSTool to view analytics for a specific credential. Use when you need to retrieve analytics data such as views, shares, or other events for a credential.

Input Parameters

string
required
Id of the credential to retrieve analytics for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_GET_DEPARTMENTTool to view a specific department by ID. Use when you need to retrieve detailed information about a department.

Input Parameters

integer
required
ID of the department to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_GET_EVIDENCE_ITEMTool to retrieve a specific evidence item from a credential. Use when you need to view details of an existing evidence item.

Input Parameters

string
required
ID of the Credential in the form of an integer or string for the particular Credential requested
integer
required
ID of the EvidenceItem in the form of an integer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_GET_GROUPTool to retrieve a specific group by ID. Use when you need to view details of an existing group.

Input Parameters

integer
required
ID of the group in the form of an integer for the particular group requested. You can obtain the group ID from the all groups request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_GET_ISSUERTool to retrieve details about the authenticated issuer. Use when you need to view information about the issuer organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_GET_REFERENCETool to view a specific reference by ID. Use when you need to retrieve details of a reference associated with a credential.

Input Parameters

integer
required
ID of the Reference in the form of an integer.
string
required
ID of the Credential in the form of a string or integer for the particular Credential requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_INITIALIZE_BADGE_DESIGNERTool to initialize the embedded badge designer. Use to create a new badge design or edit an existing one.

Input Parameters

integer
ID of an existing design to edit. Omitting this will create a new design.
integer
ID of the Department which the Design should belong to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_INITIALIZE_CERTIFICATE_DESIGNERTool to initialize the embedded certificate designer. Returns a JWT token for embedding the designer in your application. Use when you need to create or edit certificate designs programmatically.

Input Parameters

integer
ID of an existing design to edit. Omit to create a new design.
string
URL to call when the design is saved in the embedded designer.
integer
ID of the department which the design should belong to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_LIST_TEMPLATESTool to retrieve a list of all templates. Use after authentication to fetch paginated certificate templates.

Input Parameters

integer
Page number of results to fetch
integer
Number of templates per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_SEARCH_ATTRIBUTE_KEYSTool to search for attribute keys by various criteria. Use when you need to find custom attribute keys by name, department, or type (e.g., “Search for email type attribute keys in department 123”).

Input Parameters

string ("text" | "date" | "email" | "image")
Enum for attribute key kinds.
string
Filter attribute keys by name
integer
Page number for pagination
integer
Results per page, default is 50
integer
Only return custom attribute keys of the given Department

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_SEARCH_COLLECTIONSTool to search for collections. Use when you need to filter collections by IDs, name, or public flag and paginate through results. e.g., “Search for public collections named ‘abc’ on page 2.”

Input Parameters

object
Build pagination into your search.
object
Controls the order in which results are returned.
object
required
Filtering criteria for collections

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_SEARCH_CREDENTIALS_V2Tool to search for credentials using the v2 API. This is a faster alternative to the v1 Search API and supports operations on query fields for complex queries. Use when you need to filter credentials by group, recipient, dates, or other attributes with advanced operators (eq, in, lt, gt, lte, gte).

Input Parameters

object
Pagination options for credential search.
object
Sort options as key/value pairs. Key is the field name, value is ‘asc’ or ‘desc’. Example: {‘issued_on’: ‘desc’}
object
Query filters for searching credentials. Use operation syntax like ‘field[operation]’: value for advanced queries (e.g., ‘group.id[in]’: [1,2]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_SEARCH_DEPARTMENTSTool to search for departments by various criteria. Use when you need to find departments by name or retrieve a paginated list of departments.

Input Parameters

string
Filter departments by name (partial match supported)
integer
Page number to retrieve
integer
Number of departments per page (default: 50)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_SEARCH_DESIGNSTool to search for designs (certificate/badge templates). Use when you need to filter designs by type, metadata, or paginate through design results.

Input Parameters

string
Filter designs by type (e.g., ‘certificate’, ‘badge’)
integer
Page number to retrieve, starting from 1
object
Filter designs by metadata fields. Provide key-value pairs to match against design metadata
integer
Number of results per page (maximum 100)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_SEARCH_GROUPSTool to search for groups in Accredible. Use when you need to filter groups by IDs, name, update dates, or metadata and paginate through results.

Input Parameters

array
Limit the list of groups to those with IDs matching the given array
string
Limit the list of groups to those named with the given string
integer
Page number for pagination
object
Key/value pairs for client’s own data on group
integer
Number of results per page, default is 50
string
Date before which groups which have been updated should be returned. Format: YYYY-MM-DD
string
Date after which groups which have been updated should be returned. Format: YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_UPDATE_CREDENTIALTool to update an existing credential. Use when you need to modify credential details such as description, dates, recipient information, or custom attributes.

Input Parameters

string
The credential/course name displayed to recipients. Required if the Group doesn’t have a Course Name set
boolean
Whether the achievement is complete or still in progress. True by default
integer
Group ID to which the credential should belong
string
Date of issue. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)
object
Key-value metadata to attach to the credential object. Useful for storing additional structured information
object
Recipient information for credential update.
string
Date when the credential should expire. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated). Set to null by default
string
The credential/course description displayed to recipients. Required if the Group doesn’t have a Course Description set
string
required
The unique ID of the credential to update
object
Custom variables to display on the credential. Should be added to the design using the visual editor. JSON hash where keys are custom attribute names and values are displayed on the credential
boolean
Whether to allow recipients to add their own supplemental evidence to the credential. True by default
boolean
Whether to allow recipients to add their own supplemental references to the credential. True by default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_UPDATE_EVIDENCE_ITEMTool to update an existing evidence item for a credential. Use when you need to modify the details of an evidence item after it has been created.

Input Parameters

string
If the category is url or video, this should be the URL of Evidence Item
string
If the category is file, this should be the file’s URL
string
By default if you add a URL category EvidenceItem, we take a screenshot to set the preview of this URL on Credentials. You can overwrite this default behaviour by setting this preview field to be the URL of the desired image
string ("file" | "url" | "video" | "grade" | "transcript")
Type of evidence item, must be one of [file, url, video, grade, transcript]. The type dictates how the item is displayed on the Credential
integer
The numeric position of the evidence item on the credential. 0 is displayed first in the list
string
Title text for the evidence item displayed on the credential
string
required
ID of the Credential in the form of a string or integer for the particular Credential requested
string
If the category is grade or transcript then use it. For grade it will be just string like ‘83’
string
The insights which will appear below Evidence Item, if not given it will be generated automatically based on data
integer
required
ID of the Evidence Item in the form of an integer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_UPDATE_GROUPTool to update an existing group. Use when you need to modify group details after fetching its current data.

Input Parameters

string
Name of the group (for internal reference, not shown to the recipient)
integer
required
ID of the group to update
string ("en" | "es" | "vi" | "pt" | "ja" | "fr" | "da" | "nl" | "fi" | "no" | "nb" | "ro" | "sv" | "th" | "tw" | "zh" | "tr" | "ar" | "he" | "ms" | "de")
Language for the group
object
Arbitrary metadata to associate with this group
boolean
Whether to attach the Credential PDF to the email when recipient is informed
boolean
Enable or disable recording of these Credentials on a Blockchain
string
URL for recipients to sign up for the course
integer
Number of years from issue date after which the credential will automatically expire; ignored if <=0
array
List of collections to assign; each object needs an ‘id’ field
URL to the web page with information related to this group
string
Name of the course or achievement visible to the recipient
integer
Department that the group belongs to; if not defined, it defaults to the organization’s default department
integer
Badge Design ID which the group will use to display credentials
boolean
Show or hide the signup URL; true to show, false to hide, null to inherit default
Show or hide the course link; true to show, false to hide, null to inherit default
array
List of learning outcomes for this group
integer
Primary Design ID which the group will use to display credentials
integer
ID of the skill category to associate with this group
string
Description of the course or achievement visible to the recipient
integer
Certificate Design ID which the group will use to display credentials
Show or hide link to the organization’s homepage; true to show, false to hide, null to inherit default
boolean
Whether an email address can receive more than one credential in this group; defaults to false
boolean
Override department default for private credentials; true or false to override, null to inherit department setting

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_UPDATE_REFERENCETool to update a reference by ID. Use when you need to modify a reference’s details for a credential. Use after retrieving the reference ID to change comments or relationship.

Input Parameters

object
required
Object containing only the reference fields to modify.
integer
required
ID of the reference to update.
string
required
ID of the credential containing the reference.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACCREDIBLE_CERTIFICATES_VIEW_ALL_SKILL_CATEGORIESTool to retrieve all skill categories. Use when you need to list all available skill categories (e.g., to link them to groups).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not