# Accredible certificates

Accredible Certificates is a platform that enables organizations to create, manage, and distribute digital certificates, open badges, and blockchain credentials.

- **Category:** education
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 36
- **Triggers:** 0
- **Slug:** `ACCREDIBLE_CERTIFICATES`
- **Version:** 20260312_00

## Tools

### Bulk Create Credentials (V2)

**Slug:** `ACCREDIBLE_CERTIFICATES_BULK_CREATE_CREDENTIALS_V2`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `credentials` | array | Yes | List of up to 30 credentials to create in one batch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone Group

**Slug:** `ACCREDIBLE_CERTIFICATES_CLONE_GROUP`

Tool to clone an existing group. Use after confirming the source group exists and you need a copy with optional overrides.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Override name of the cloned group (prefixed with 'Copy' if omitted) |
| `group_id` | integer | Yes | ID of the group to clone |
| `language` | string ("en" | "es" | "vi" | "pt" | "ja" | "fr" | "da" | "nl" | "fi" | "no" | "nb" | "ro" | "sv" | "th" | "tw" | "zh" | "tr" | "ar" | "he" | "ms" | "de") | No | Override language code for the group |
| `meta_data` | object | No | Override arbitrary metadata for the group |
| `attach_pdf` | boolean | No | Override PDF attachment setting when notifying recipients |
| `blockchain` | boolean | No | Override blockchain recording setting |
| `signup_url` | string | No | Override signup URL for course enrollment |
| `auto_expiry` | integer | No | Override credential auto-expiry in years; ignored if <=0 |
| `course_link` | string | No | Override URL for the course information page |
| `course_name` | string | No | Override course or achievement name visible to the recipient |
| `badge_design_id` | integer | No | Override badge design ID |
| `signup_url_show` | boolean | No | Override showing signup URL |
| `course_link_show` | boolean | No | Override showing course link |
| `learning_outcomes` | array | No | Override list of learning outcomes |
| `primary_design_id` | integer | No | Override primary design ID |
| `skill_category_id` | integer | No | Override skill category association |
| `course_description` | string | No | Override description visible to the recipient |
| `certificate_design_id` | integer | No | Override certificate design ID |
| `organization_link_show` | boolean | No | Override showing organization link |
| `allow_duplicate_credentials` | boolean | No | Override allowing duplicate credentials per email |
| `generate_private_credential` | boolean | No | Override private credential default: true, false, or null to inherit |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Attribute Key

**Slug:** `ACCREDIBLE_CERTIFICATES_CREATE_ATTRIBUTE_KEY`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Collection

**Slug:** `ACCREDIBLE_CERTIFICATES_CREATE_COLLECTION`

Tool to create a new collection. Use when you need a curated set of groups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the collection |
| `public` | boolean | No | Whether the collection is public |
| `description` | string | No | Description of the collection |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Credential

**Slug:** `ACCREDIBLE_CERTIFICATES_CREATE_CREDENTIAL`

Tool to create a new credential with optional evidence items and references. Use when issuing credentials to recipients; ensure group exists before creation.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Evidence Item

**Slug:** `ACCREDIBLE_CERTIFICATES_CREATE_EVIDENCE_ITEM`

Tool to create a new evidence item for a credential. Use after confirming credential ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | URL of the item when category is url or video |
| `file` | string | No | File URL when category is file |
| `preview` | string | No | Override preview image URL for URL category |
| `category` | string ("file" | "url" | "video" | "grade" | "transcript") | Yes | Type of evidence item, dictates its display |
| `position` | integer | No | Position index of the evidence item on the credential (0 = first) |
| `description` | string | Yes | Title text for the evidence item displayed on the credential |
| `credential_id` | string | Yes | Global ID of the credential to attach the evidence item to |
| `string_object` | string | No | String data for grade or transcript categories, e.g., '83' |
| `custom_insight` | string | No | Override auto-generated insight text below the evidence item |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Group

**Slug:** `ACCREDIBLE_CERTIFICATES_CREATE_GROUP`

Tool to create a new group. Use after gathering all group details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the group (internal reference, not shown to the recipient) |
| `language` | string ("en" | "es" | "vi" | "pt" | "ja" | "fr" | "da" | "nl" | "fi" | "no" | "nb" | "ro" | "sv" | "th" | "tw" | "zh" | "tr" | "ar" | "he" | "ms" | "de") | No | Language code for the group |
| `meta_data` | object | No | Arbitrary string key-value metadata for this group |
| `attach_pdf` | boolean | No | Attach credential PDF to notification email |
| `blockchain` | boolean | No | Record credentials on blockchain |
| `signup_url` | string | No | Signup URL for course enrollment |
| `auto_expiry` | integer | No | Years until auto-expiry of credential; ignored if <=0 |
| `collections` | array | No | List of collection objects with 'id' field |
| `course_link` | string | No | URL for course information page |
| `course_name` | string | Yes | Course or achievement name visible to the recipient |
| `department_id` | integer | No | Department ID for the group; defaults to org default |
| `badge_design_id` | integer | No | Badge design ID to render credentials |
| `signup_url_show` | boolean | No | Display signup URL: true/false or null to inherit |
| `course_link_show` | boolean | No | Display course link: true/false or null to inherit |
| `learning_outcomes` | array | No | Learning outcomes list for this group |
| `primary_design_id` | integer | No | Primary design ID to render credentials |
| `skill_category_id` | integer | No | Skill category ID to associate |
| `course_description` | string | Yes | Description of the course or achievement visible to the recipient |
| `certificate_design_id` | integer | No | Certificate design ID to render credentials |
| `organization_link_show` | boolean | No | Display organization link: true/false or null to inherit |
| `allow_duplicate_credentials` | boolean | No | Allow duplicate credentials per email: true/false |
| `generate_private_credential` | boolean | No | Override default private credential setting: true/false or null to inherit |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Reference

**Slug:** `ACCREDIBLE_CERTIFICATES_CREATE_REFERENCE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reference` | object | Yes | Reference object containing all the reference details. |
| `credential_id` | string | Yes | ID of the credential to attach the reference to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Collection

**Slug:** `ACCREDIBLE_CERTIFICATES_DELETE_COLLECTION`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | UUID of the collection to delete. Must be a valid collection identifier in UUID format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Credential

**Slug:** `ACCREDIBLE_CERTIFICATES_DELETE_CREDENTIAL`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `credential_id` | string | Yes | The unique ID of the credential to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Evidence Item

**Slug:** `ACCREDIBLE_CERTIFICATES_DELETE_EVIDENCE_ITEM`

Tool to delete an evidence item from a credential. Use after confirming you want to permanently remove a specific evidence item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `credential_id` | string | Yes | ID of the Credential in the form of a string or integer for the particular Credential requested |
| `evidence_item_id` | integer | Yes | ID of the EvidenceItem in the form of an integer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Group

**Slug:** `ACCREDIBLE_CERTIFICATES_DELETE_GROUP`

Tool to delete a group. Use after confirming no credentials remain and when you need to permanently remove the group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | Numeric ID of the group to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Reference

**Slug:** `ACCREDIBLE_CERTIFICATES_DELETE_REFERENCE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reference_id` | integer | Yes | ID of the Reference to delete (must be positive). |
| `credential_id` | string | Yes | ID of the Credential to remove the reference from. May be numeric or string-formatted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate PDFs for Credentials

**Slug:** `ACCREDIBLE_CERTIFICATES_GENERATE_PD_FS_FOR_CREDENTIALS`

Tool to generate PDFs for multiple credentials. Use when you need to batch-download a zip archive of certificate PDFs for a list of published credential IDs. Example: "Generate PDFs for credentials [10000005, 10272642]".

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `credential_ids` | array | Yes | List of published credential IDs to generate PDFs for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Analytics

**Slug:** `ACCREDIBLE_CERTIFICATES_GET_ANALYTICS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The pagination page number |
| `end_date` | string | No | Only return Credential analytic events recorded before the given end date. Format: YYYY-MM-DD (YYYY/MM/DD also works but is deprecated) |
| `group_id` | integer | No | Only return Credential analytic events relating to Credentials within the given Group |
| `page_size` | integer | No | The pagination response size, default of 100 |
| `start_date` | string | No | Only return Credential analytic events recorded after the given start date. Format: YYYY-MM-DD (YYYY/MM/DD also works but is deprecated) |
| `department_id` | integer | No | Only return Credential analytic events relating to Credentials within the given Department |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credential

**Slug:** `ACCREDIBLE_CERTIFICATES_GET_CREDENTIAL`

Tool to view a credential by ID. Use when you need to retrieve detailed information about a specific credential.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the Credential in the form of an integer or string for the particular Credential requested. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credential Analytics

**Slug:** `ACCREDIBLE_CERTIFICATES_GET_CREDENTIAL_ANALYTICS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id of the credential to retrieve analytics for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Department

**Slug:** `ACCREDIBLE_CERTIFICATES_GET_DEPARTMENT`

Tool to view a specific department by ID. Use when you need to retrieve detailed information about a department.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `department_id` | integer | Yes | ID of the department to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Evidence Item

**Slug:** `ACCREDIBLE_CERTIFICATES_GET_EVIDENCE_ITEM`

Tool to retrieve a specific evidence item from a credential. Use when you need to view details of an existing evidence item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `credential_id` | string | Yes | ID of the Credential in the form of an integer or string for the particular Credential requested |
| `evidence_item_id` | integer | Yes | ID of the EvidenceItem in the form of an integer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group

**Slug:** `ACCREDIBLE_CERTIFICATES_GET_GROUP`

Tool to retrieve a specific group by ID. Use when you need to view details of an existing group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Issuer Details

**Slug:** `ACCREDIBLE_CERTIFICATES_GET_ISSUER`

Tool to retrieve details about the authenticated issuer. Use when you need to view information about the issuer organization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reference

**Slug:** `ACCREDIBLE_CERTIFICATES_GET_REFERENCE`

Tool to view a specific reference by ID. Use when you need to retrieve details of a reference associated with a credential.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reference_id` | integer | Yes | ID of the Reference in the form of an integer. |
| `credential_id` | string | Yes | ID of the Credential in the form of a string or integer for the particular Credential requested. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Initialize Badge Designer

**Slug:** `ACCREDIBLE_CERTIFICATES_INITIALIZE_BADGE_DESIGNER`

Tool to initialize the embedded badge designer. Use to create a new badge design or edit an existing one.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `design_id` | integer | No | ID of an existing design to edit. Omitting this will create a new design. |
| `department_id` | integer | No | ID of the Department which the Design should belong to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Initialize Certificate Designer

**Slug:** `ACCREDIBLE_CERTIFICATES_INITIALIZE_CERTIFICATE_DESIGNER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `design_id` | integer | No | ID of an existing design to edit. Omit to create a new design. |
| `callback_url` | string | No | URL to call when the design is saved in the embedded designer. |
| `department_id` | integer | No | ID of the department which the design should belong to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `ACCREDIBLE_CERTIFICATES_LIST_TEMPLATES`

Tool to retrieve a list of all templates. Use after authentication to fetch paginated certificate templates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number of results to fetch |
| `per_page` | integer | No | Number of templates per page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Attribute Keys

**Slug:** `ACCREDIBLE_CERTIFICATES_SEARCH_ATTRIBUTE_KEYS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string ("text" | "date" | "email" | "image") | No | Enum for attribute key kinds. |
| `name` | string | No | Filter attribute keys by name |
| `page` | integer | No | Page number for pagination |
| `page_size` | integer | No | Results per page, default is 50 |
| `department_id` | integer | No | Only return custom attribute keys of the given Department |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Collections

**Slug:** `ACCREDIBLE_CERTIFICATES_SEARCH_COLLECTIONS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Build pagination into your search. |
| `sort` | object | No | Controls the order in which results are returned. |
| `query` | object | Yes | Filtering criteria for collections |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Credentials V2

**Slug:** `ACCREDIBLE_CERTIFICATES_SEARCH_CREDENTIALS_V2`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | object | No | Pagination options for credential search. |
| `sort` | object | No | Sort options as key/value pairs. Key is the field name, value is 'asc' or 'desc'. Example: {'issued_on': 'desc'} |
| `query` | object | No | Query filters for searching credentials. Use operation syntax like 'field[operation]': value for advanced queries (e.g., 'group.id[in]': [1,2]). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Departments

**Slug:** `ACCREDIBLE_CERTIFICATES_SEARCH_DEPARTMENTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter departments by name (partial match supported) |
| `page` | integer | No | Page number to retrieve |
| `page_size` | integer | No | Number of departments per page (default: 50) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Designs

**Slug:** `ACCREDIBLE_CERTIFICATES_SEARCH_DESIGNS`

Tool to search for designs (certificate/badge templates). Use when you need to filter designs by type, metadata, or paginate through design results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string | No | Filter designs by type (e.g., 'certificate', 'badge') |
| `page` | integer | No | Page number to retrieve, starting from 1 |
| `meta_data` | object | No | Filter designs by metadata fields. Provide key-value pairs to match against design metadata |
| `page_size` | integer | No | Number of results per page (maximum 100) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Groups

**Slug:** `ACCREDIBLE_CERTIFICATES_SEARCH_GROUPS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Limit the list of groups to those with IDs matching the given array |
| `name` | string | No | Limit the list of groups to those named with the given string |
| `page` | integer | No | Page number for pagination |
| `meta_data` | object | No | Key/value pairs for client's own data on group |
| `page_size` | integer | No | Number of results per page, default is 50 |
| `end_updated_date` | string | No | Date before which groups which have been updated should be returned. Format: YYYY-MM-DD |
| `start_updated_date` | string | No | Date after which groups which have been updated should be returned. Format: YYYY-MM-DD |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Credential

**Slug:** `ACCREDIBLE_CERTIFICATES_UPDATE_CREDENTIAL`

Tool to update an existing credential. Use when you need to modify credential details such as description, dates, recipient information, or custom attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The credential/course name displayed to recipients. Required if the Group doesn't have a Course Name set |
| `complete` | boolean | No | Whether the achievement is complete or still in progress. True by default |
| `group_id` | integer | No | Group ID to which the credential should belong |
| `issued_on` | string | No | Date of issue. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated) |
| `meta_data` | object | No | Key-value metadata to attach to the credential object. Useful for storing additional structured information |
| `recipient` | object | No | Recipient information for credential update. |
| `expired_on` | string | No | Date when the credential should expire. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated). Set to null by default |
| `description` | string | No | The credential/course description displayed to recipients. Required if the Group doesn't have a Course Description set |
| `credential_id` | string | Yes | The unique ID of the credential to update |
| `custom_attributes` | object | No | 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 |
| `allow_supplemental_evidence` | boolean | No | Whether to allow recipients to add their own supplemental evidence to the credential. True by default |
| `allow_supplemental_references` | boolean | No | Whether to allow recipients to add their own supplemental references to the credential. True by default |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Evidence Item

**Slug:** `ACCREDIBLE_CERTIFICATES_UPDATE_EVIDENCE_ITEM`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | If the category is url or video, this should be the URL of Evidence Item |
| `file` | string | No | If the category is file, this should be the file's URL |
| `preview` | string | No | 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 |
| `category` | string ("file" | "url" | "video" | "grade" | "transcript") | No | Type of evidence item, must be one of [file, url, video, grade, transcript]. The type dictates how the item is displayed on the Credential |
| `position` | integer | No | The numeric position of the evidence item on the credential. 0 is displayed first in the list |
| `description` | string | No | Title text for the evidence item displayed on the credential |
| `credential_id` | string | Yes | ID of the Credential in the form of a string or integer for the particular Credential requested |
| `string_object` | string | No | If the category is grade or transcript then use it. For grade it will be just string like '83' |
| `custom_insight` | string | No | The insights which will appear below Evidence Item, if not given it will be generated automatically based on data |
| `evidence_item_id` | integer | Yes | ID of the Evidence Item in the form of an integer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group

**Slug:** `ACCREDIBLE_CERTIFICATES_UPDATE_GROUP`

Tool to update an existing group. Use when you need to modify group details after fetching its current data.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Reference

**Slug:** `ACCREDIBLE_CERTIFICATES_UPDATE_REFERENCE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reference` | object | Yes | Object containing only the reference fields to modify. |
| `reference_id` | integer | Yes | ID of the reference to update. |
| `credential_id` | string | Yes | ID of the credential containing the reference. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### View All Skill Categories

**Slug:** `ACCREDIBLE_CERTIFICATES_VIEW_ALL_SKILL_CATEGORIES`

Tool to retrieve all skill categories. Use when you need to list all available skill categories (e.g., to link them to groups).

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |