accredible_get_issuer
Get the issuer (account)
The Accredible issuer (organization) behind the API key: id, name, e-mail, remaining credential credits (certificate_left), language and URL. Good first call. GET /v1/issuer/details.
Takes no parameters.
accredible_search_credentials
Search credentials
Search issued credentials (badges and certificates) with filters that combine with AND, newest first by default. Returns id, uuid, encoded_id, recipient name/e-mail, group, issued_on, expired_on, published state (approve), whether the recipient opened or engaged, and meta. Paging: size + offset (first 10 000 results) OR cursor: when the reply has next_cursor pass it as cursor for the next page (cursor and offset cannot be combined). POST /v2/credentials/search (a read-only search).
Parameterssizeuuidcursoroffsetsort_bygroup_idpublishedlicense_idsort_orderissued_afterrecipient_idcreated_after+6 more
accredible_get_credential
Get a credential
One credential in full: recipient, group, issue and expiry dates, published state, public URL, evidence items, references, custom attributes and skills. The id is the numeric credential id or the custom id your organization set. GET /v1/credentials/{id}.
Parametersidrequired
accredible_get_credential_analytics
Get a credential's analytics events
The analytics events of one credential (recipient views, shares, privacy changes, verification and so on) with timestamps. Read-only despite being a POST. POST /v1/credentials/analytics/{id}.
Parametersidrequired
accredible_list_analytics
List credential analytics events
Account-wide credential analytics events (views, shares, downloads and similar), optionally for a date range, group or department. Paged (default 100 per page). GET /v1/analytics.
Parameterspageend_dategroup_idpage_sizestart_datedepartment_id
accredible_search_groups
Search groups
Search groups (an achievement such as a course or qualification that credentials belong to). Filters combine with AND; name and course_name match partially. Returns id, name, course name and description, design ids, language and dates. Paged: pass meta.next_page as page. POST /v1/issuer/groups/search (a read-only search).
Parametersidsnamepagemeta_datapage_sizecourse_namedepartment_idupdated_aftercollection_idsupdated_before
accredible_get_group
Get a group
One group in full: name, course name and description, learning outcomes, design ids, language, skills and dates. GET /v1/issuer/groups/{group_id}.
Parametersgroup_idrequired
accredible_search_designs
Search designs
List badge and certificate designs, optionally by kind or meta_data. POST /v1/designs/search (a read-only search).
Parameterskindmeta_data
accredible_get_design
Get a design
One badge or certificate design with its settings. GET /v1/designs/{design_id}.
Parametersdesign_idrequired
accredible_search_departments
Search departments
List departments (independent organization units with their own designs, groups and branding). An account-wide key sees all, a department key only its own. Paged: pass meta.next_page as page. POST /v1/departments/search (a read-only search).
Parameterspagemeta_datapage_size
accredible_get_department
Get a department
One department: name, description, URL, branding and meta_data. GET /v1/departments/{department_id}.
Parametersdepartment_idrequired
accredible_search_collections
Search collections
List collections (sets of groups shown together). Filters: ids, name (substring), public. Paged: pass meta.next_page as page. POST /v1/collections/search (a read-only search).
Parametersidsnamepagepublicsort_bypage_sizesort_order
accredible_search_attribute_keys
Search custom attribute keys
List the custom attribute keys (placeholders such as a grade or date that credential designs and e-mails merge in); useful to know which custom_attributes a credential can carry. Paged: pass meta.next_page as page. POST /v1/attribute_keys/search (a read-only search).
Parameterskindnamepagepage_sizedepartment_id
accredible_list_skill_frameworks
List skill frameworks
The skills frameworks (O*NET, ESCO, NACE or your own) enabled for a department, each with its published versions. Needs a plan that includes skills frameworks (otherwise HTTP 403 plan_not_entitled). Paged, max 10 per page. GET /v1/skill_frameworks.
Parameterspagepage_sizedepartment_idrequired
accredible_search_skills
Search skills in a framework version
Search the skills of one published skills-framework version by name or the publisher's identifier (partial, case-insensitive, at least 2 characters). Paged, max 50 per page. GET /v1/skill_frameworks/{id}/versions/{version_id}/skills.
Parameterspagequeryrequiredpage_sizeversion_idrequiredframework_idrequired
accredible_list_data_exports
List data exports
Data exports of the departments the key can access: department, status (scheduled, processing, completed, errored) and download links of completed files. Exports are created in the Accredible Dashboard. GET /v1/data_exports.
Takes no parameters.
accredible_get_data_export
Get a data export
One data export: department, status and, once completed, the download links of its files. GET /v1/data_exports/{id}.
Parametersidrequired
accredible_get_team_member
Get a team member
One team member of the account: name, e-mail and permissions per department. Which members are visible depends on the key (an account-wide key sees all, a department key its own department). GET /v1/team_members/{id}.
Parametersidrequired
accredible_issue_credential
Issue a credential to ONE recipient
WRITE: creates ONE credential (badge or certificate) for ONE recipient in an existing group. By default it is created UNPUBLISHED (a draft: no e-mail is sent and no credit is used); publish it later in the Accredible Dashboard. With publish=true the credential is published immediately: Accredible then SENDS AN E-MAIL to the recipient (as configured in the group's e-mail settings) and uses one credential credit of the account; an account without credits keeps it unpublished. A sandbox-mode setting in the Dashboard overrides publish. Not idempotent: calling twice creates two credentials (set credential_id to your own unique id to be able to find it again). No evidence, references, bulk issuing, edits or deletes. POST /v1/credentials.
Parametersnameprivatepublishcompletegroup_idrequiredissued_onmeta_dataexpired_ondescriptionrecipient_idcredential_idrecipient_namerequired+2 more