Accredible

App · 25 actions

Connect Accredible to manage your account records and automate everyday work.

Actions

ActionWhat it does
Clone groupClone a Group.
Copy designCopy a Design.
Create credentialCreate a New Credential.
Create evidenceCreate a New Evidence Item.
Create groupCreate a Group.
Create referenceCreate a New Reference.
Delete credentialDelete a Credential.
Delete evidenceDelete an Evidence Item.
Delete groupDelete a Group.
Delete referenceDelete a Reference.
Get analyticsIndex Analytics.
Get credentialView a Credential.
Get credential analyticsView Credential Analytics.
Get designView a Design.
Get evidenceView an Evidence Item.
Get groupView a Group.
Get issuerView an Issuer.
Get referenceView a Reference.
List skill categoriesView all Skill Categories.
List skill frameworksView all Skill Frameworks.
Search attribute keysSearch for Attribute Keys.
Search credentialsSearch for Credentials (v2).
Search departmentsSearch for Departments.
Search designsSearch for Designs.
Search groupsSearch for Groups.

Clone group

Clone a Group.

Inputs

Group IDgroup_idtextRequired
The group_id identifying the record to use.
Namenametext
Name of the group (for your reference and never shown to the recipient). Copy will be added to the beginning of name of the new cloned group when a new name is not provided.
Course namecourse_nametext
Name of the course or achievement. This is visible to the recipient.
Course descriptioncourse_descriptiontext
Description of the course or achievement. This is visible to the recipient.
Course linkcourse_linktext
Link to the web page with information related to this Credential. Typically this is a course information or event information page.
Languagelanguagetext
Language for the group. Currently we support "en", "es", "vi", "pt", "ja", "fr", "da", "nl", "fi", "no", "nb", "ro", "sv", "th", "tw", "zh", "tr", "ar", "he", "ms" and "de". Default language is en.
Attach pdfattach_pdftrue/false
PDF of the Credential should be attached to email when recipient is informed. Default is false.
Blockchainblockchaintrue/false
Enable or disable recording of these Credentials on a Blockchain.
Certificate designcertificate_design_idnumber
Certificate Design which the Group will use to display Credentials. Certificate design needs to exist in the newly cloned space.
Badge designbadge_design_idnumber
Badge Design which the Group will use to display Credentials. Badge design needs to exist in the newly cloned space.
Primary design IDprimary_design_idnumber
Primary Design which the Group will use to display Credentials.
Meta datameta_dataobject
You can use this parameter to attach key-value strings to the object. Meta data is useful for storing additional, structured information on an object.
Learning outcomeslearning_outcomesobject
Searchable keywords identifying skills credential-holders need to demonstrate (or have learned) in the process of earning this credential. A clone always takes its skills source from the original Group, so framework skills cannot be set here , see the cloning behaviour described above and the [Skills Frameworks](#tag/Skills-Frameworks) endpoints.
Generate private credentialgenerate_private_credentialtrue/false
The default value of Credential.private for the Group. The supported values are true, false, and null. When this is set to true or false, it will override Department.generate_private_credential and be used as the default of Credential.private when creating a new Credential. When this is set to null, it won't override Department.generate_private_credential which will be used for the default of Credential.private instead.
Auto expiryauto_expirynumber
Specifies the number of years or months (see auto_expiry_unit) from the issue date after which the credential will automatically expire. If the specified value is less than or equal to 0, it will be ignored.
Auto expiry unitauto_expiry_unittext
The unit of time for auto_expiry. Defaults to years if not supplied and auto_expiry exists.One of: years, months.
Signup urlsignup_urltext
This provides a direct path for credential viewers to enroll in your course.
Signup url showsignup_url_showtrue/false
Show or hide the sign up url. The supported values are true, false and null.
Course link showcourse_link_showtrue/false
This links the credential data record to your information about the credential on your website. The supported values are true, false and null.
Organization link showorganization_link_showtrue/false
Show or hide the link to your website homepage. The supported values are true, false and null.
Allow duplicate credentialsallow_duplicate_credentialstrue/false
An email address can receive more than one credential. The supported values are true & false. Defaults to false.
Skill category IDskill_category_idnumber
ID of the skill category to associate with the cloned group.
Achievement typeachievement_typetext
The type of achievement, for example 'Award' or 'Certification'. The supported values are listed here https://www.imsglobal.org/spec/ob/v3p0#achievementtype-enumeration
Earning criteriaearning_criterialist
Earning criteria for the cloned group. **Omit the key** to copy the original group's criteria as-is. **Provide an array** to replace them: each item creates a new criterion on the clone (id is ignored, since clone never updates an existing criterion).

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "group": {
      "achievement_type": "example",
      "attach_pdf": false,
      "auto_expiry": 1,
      "auto_expiry_unit": "years",
      "badge_design_id": {},
      "blockchain": false,
      "certificate_design_id": {},
      "collections": [],
      "course_description": "example",
      "course_link": "example",
      "course_link_show": false,
      "course_name": "example",
      "created_at": "example",
      "department_id": 1,
      "design_id": 1,
      "design_name": "example",
      "earning_criteria": [],
      "generate_private_credential": false,
      "id": 1,
      "language": "example",
      "learning_outcomes": [],
      "meta_data": {
        "foo": "example"
      },
      "name": "example",
      "organization_link_show": false,
      "primary_design_id": {},
      "signup_url": "example",
      "signup_url_show": false,
      "skill_category": {
        "id": 1,
        "name": "example"
      },
      "skill_framework": {
        "attribution": {},
        "description": "example",
        "id": 1,
        "name": "example",
        "provider": "example",
        "source_type": "external",
        "taxonomy": "example",
        "version": {}
      },
      "skills": [],
      "updated_at": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Copy design

Copy a Design.

Inputs

Designdesign_idnumberRequired
ID of the Design in the form of an integer for the particular Design requested.
Department IDdepartment_idnumber
Department that the Design belongs to. If not defined the Design will be assigned to the organizations default department.

Outputs

Value.

datanull
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Create credential

Create a New Credential.

Inputs

Ididtext
The unique ID of the credential. If you supply your own internal ID we'll use this as a reference for the Credential. If not we'll assign an ID.
Recipient namerecipient_nametextRequired
The name of the recipient the credential is issued to.
Recipient emailrecipient_emailtextRequired
The recipient's email address.
Recipient phone numberrecipient_phone_numbertext
The recipient's phone number in E.164 format (e.g., +14155552671). This field is optional and available as part of the Growth plan. Phone numbers are used for SMS campaigns and are associated with the credential.
Recipient IDrecipient_idtext
The recipient's user ID as defined by your organization. This alllows you to easily map your recipients to their Credentials regardless of changes to their email address.
Recipient meta datarecipient_meta_dataobject
You can use this parameter to attach key-value strings to the object. Meta data is useful for storing additional, structured information on an object.
Groupgroup_idnumberRequired
Group Id to which the credential should belong.
Namenametext
The Credential/course name displayed to recipients. This is required if the Group the Credential belongs to doesn't have a Course Name set.
Descriptiondescriptiontext
The credential/course description displayed to recipients. This is required if the Group the Credential belongs to doesn't have a Course Description set.
Custom attributescustom_attributesobject
Custom variables to display on the Credential. These should be added to the design using the visual editor. Data should be formatted as a JSON hash where keys are the custom attribute names and the values are the values to be displayed on the Credential.
Issued onissued_ontext
Date of issue, the default is when the credential is created. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)
Expired onexpired_ontext
Date you would like the credential to expire on, null by default. Format: YYYY-MM-DD (DD/MM/YYYY also works but is deprecated)
Completecompletetrue/false
Whether the achievement is complete or still in progress, true by default.
Privateprivatetrue/false
Whether to make credential private. When it is set to true, the Credential will be private and visible only to its recipient who has signed into credential.net. If no value is set, the default value will be automatically assigned based on Group.generate_private_credential and Department.generate_private_credential. Department.generate_private_credential will be used as the default when Group.generate_private_credential is set to null. Group.generate_private_credential will override Department.generate_private_credential and be used as the default when it is set to true or false.
Approveapprovetrue/false
Whether to publish credential at the time of creation. By default this is true but settings at dashboard for sandbox_mode take precendence.
Allow supplemental evidenceallow_supplemental_evidencetrue/false
Whether to allow recipients to add their own supplemental evidence to the Credential, true by default.
Allow supplemental referencesallow_supplemental_referencestrue/false
Whether to allow recipients to add their own supplemental references to the credential, true by default.
Evidence itemsevidence_itemsobject
Evidence to add to this credential, that provide more information about how the recipient met the achievement. See Evidence Items for fields. Typically this would include work samples for a course.
Referencesreferencesobject
References to add to this Credential, that provide more information about how the recipient met the achievement. See References for fields. Typically this would be a peer, teacher or manager giving their feedback.
Meta datameta_dataobject
You can use this parameter to attach key-value strings to the object. Meta data is useful for storing additional, structured information on an object.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "credential": {
      "approve": false,
      "badge": {
        "image": {}
      },
      "certificate": {
        "image": {}
      },
      "complete": false,
      "course_link": "example",
      "custom_attributes": {
        "Location": "example"
      },
      "description": "example",
      "encoded_id": "example",
      "evidence_items": [],
      "expired_on": {},
      "grade": {},
      "group_id": 1,
      "group_name": "example",
      "id": "example",
      "issued_on": "example",
      "issuer": {
        "description": {},
        "id": 1,
        "name": "example",
        "url": "example"
      },
      "meta_data": {
        "foo": "example"
      },
      "name": "example",
      "private": false,
      "recipient": {
        "email": "example",
        "id": "example",
        "meta_data": {},
        "name": "example",
        "phone_number": "example"
      },
      "references": [],
      "seo_image": "example",
      "skills": [],
      "url": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create evidence

Create a New Evidence Item.

Inputs

Credential IDcredential_idtextRequired
Global ID of the credential in the form of an integer or string for the particular Credential requested.
Descriptiondescriptiontext
Title text for the evidence item. This is displayed on a Credential.
Categorycategorytext
Type of Evidence Item added, must be one of [file, url, video, grade, transcript]. The type dictates how the item is displayed on the certificate.One of: file, url, video, grade, transcript.
Urlurltext
If the category is url or video, this should be the URL of Evidence Item.
Filefiletext
If the category is file, this should be the file's URL.
String objectstring_objecttext
If the category is grade or transcript then use it. For grade it will be just string 83.
Previewpreviewtext
By default if you add a URL category EvidenceItem, we take a screenshot to set the preview of this URL on Credential. You can overwrite this default behaviour by setting this preview field to be the URL of the desired image.
Positionpositionnumber
The numeric position of the evidence item on the credential. 0 is displayed first in the list.
Custom insightcustom_insighttext
The insights which will appear below Evidence Item, if not given it will be generated automatically based on data.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "evidence_item": {
      "description": "example",
      "id": 1,
      "link_url": "example",
      "position": 1,
      "preview_image_url": "example",
      "string_object": {},
      "supplemental": false,
      "type": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create group

Create a Group.

Inputs

NamenametextRequired
Name of the group (for your reference and never shown to the recipient).
Course namecourse_nametextRequired
Name of the course or achievement. This is visible to the recipient.
Course descriptioncourse_descriptiontextRequired
Description of the course or achievement. This is visible to the recipient.
Course linkcourse_linktext
Link to the web page with information related to this Credential. Typically this is a course information or event information page.
Languagelanguagetext
Language for the group. Currently we support "en", "es", "vi", "pt", "ja", "fr", "da", "nl", "fi", "no", "nb", "ro", "sv", "th", "tw", "zh", "tr", "ar", "he", "ms" and "de". Default language is en.
Attach pdfattach_pdftrue/false
PDF of the Credential should be attached to email when recipient is informed. Default is false.
Blockchainblockchaintrue/false
Enable or disable recording of these Credentials on a Blockchain.
Designdesign_idnumber
DEPRECATED. Certificate Design which the Group will use to display Credentials.
Certificate designcertificate_design_idnumber
Certificate Design which the Group will use to display Credentials.
Badge designbadge_design_idnumber
Badge Design which the Group will use to display Credentials.
Primary design IDprimary_design_idnumber
Primary Design which the Group will use to display Credentials.
Department IDdepartment_idnumber
Department that the group belongs to. If not defined the group will be assigned to the organizations default department.
Meta datameta_dataobject
You can use this parameter to attach key-value strings to the object. Meta data is useful for storing additional, structured information on an object.
Learning outcomeslearning_outcomesobject
Searchable keywords identifying skills credential-holders need to demonstrate (or have learned) in the process of earning this credential. To use skills from a recognized taxonomy instead of free text, see framework_skills and the [Skills Frameworks](#tag/Skills-Frameworks) endpoints. Both can be set on the same Group; where a credential displays a single skills list, framework skills take precedence.
Generate private credentialgenerate_private_credentialtrue/false
The default value of Credential.private for the Group. The supported values are true, false, and null. When this is set to true or false, it will override Department.generate_private_credential and be used as the default of Credential.private when creating a new Credential. When this is set to null, it won't override Department.generate_private_credential which will be used for the default of Credential.private instead.
Auto expiryauto_expirynumber
Specifies the number of years or months (see auto_expiry_unit) from the issue date after which the credential will automatically expire. If the specified value is less than or equal to 0, it will be ignored.
Auto expiry unitauto_expiry_unittext
The unit of time for auto_expiry. Defaults to years if not supplied and auto_expiry exists.One of: years, months.
Signup urlsignup_urltext
This provides a direct path for credential viewers to enroll in your course.
Signup url showsignup_url_showtrue/false
Show or hide the sign up url. The supported values are true, false and null.
Course link showcourse_link_showtrue/false
This links the credential data record to your information about the credential on your website. The supported values are true, false and null.
Organization link showorganization_link_showtrue/false
Show or hide the link to your website homepage. The supported values are true, false and null.
Allow duplicate credentialsallow_duplicate_credentialstrue/false
An email address can receive more than one credential. The supported values are true & false. Defaults to false.
Skill category IDskill_category_idnumber
ID of the skill category to associate with this group.
Collectionscollectionsobject
Full list of collections to associate to this group
Achievement typeachievement_typetext
The type of achievement, for example 'Award' or 'Certification'. The supported values are listed here https://www.imsglobal.org/spec/ob/v3p0#achievementtype-enumeration
Earning criteriaearning_criterialist
Optional list of criteria the recipient must satisfy to earn this credential. Each item creates a new criterion on the group.
Skill framework version IDskill_framework_version_idnumber
Id of the Skill Framework version to take skills from, as returned in a framework's versions array by [View all Skill Frameworks](#operation/View%20all%20Skill%20Frameworks). Must be sent together with framework_skills. Omit both this and framework_skills to create a Group that uses free-text learning_outcomes instead. This key is write-only. The response reports the Group's pinned version as skill_framework.version.id instead, and its skills as skills.
Framework skillsframework_skillslist
Skills from skill_framework_version_id to attach to the Group, each entry a { id, breadcrumb_ids } pair. Must be sent together with skill_framework_version_id and contain at least one skill , sending only one of the two keys, or an empty array, attaches nothing and returns a 207 with a framework_params_incomplete error. Every valid skill is attached; every invalid one is skipped and itemized in the errors array of a 207 response. The Group itself is always created, so read skills back from the response to see what was attached.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "group": {
      "achievement_type": "example",
      "attach_pdf": false,
      "auto_expiry": 1,
      "auto_expiry_unit": "years",
      "badge_design_id": {},
      "blockchain": false,
      "certificate_design_id": {},
      "collections": [],
      "course_description": "example",
      "course_link": "example",
      "course_link_show": false,
      "course_name": "example",
      "created_at": "example",
      "department_id": 1,
      "design_id": 1,
      "design_name": "example",
      "earning_criteria": [],
      "generate_private_credential": false,
      "id": 1,
      "language": "example",
      "learning_outcomes": [],
      "meta_data": {
        "foo": "example"
      },
      "name": "example",
      "organization_link_show": false,
      "primary_design_id": {},
      "signup_url": "example",
      "signup_url_show": false,
      "skill_category": {
        "id": 1,
        "name": "example"
      },
      "skill_framework": {
        "attribution": {},
        "description": "example",
        "id": 1,
        "name": "example",
        "provider": "example",
        "source_type": "external",
        "taxonomy": "example",
        "version": {}
      },
      "skills": [],
      "updated_at": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create reference

Create a New Reference.

Inputs

Credential IDcredential_idtextRequired
ID of the Credential in the form of a string integer for the particular Credential requested.
Descriptiondescriptiontext
The reference comments / text.
Relationshiprelationshiptext
Must be one of: "taught", "managed", "mentored", "worked", "studied", "friends", "stranger", "professor".One of: taught, managed, mentored, worked, studied, friends, stranger, professor.
Refereerefereeobject
Referee for this request.
Positionpositionnumber
The numeric position of the evidence item on the credential. 0 is displayed first in the list.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "reference": {
      "description": "example",
      "id": 1,
      "referee": {
        "avatar": "example",
        "email": "example",
        "name": "example"
      },
      "relationship": "example",
      "supplemental": false
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete credential

Delete a Credential.

Inputs

IdidtextRequired
ID of the credential for the particular Credential requested.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "credential": {
      "approve": false,
      "badge": {
        "image": {}
      },
      "certificate": {
        "image": {}
      },
      "complete": false,
      "course_link": "example",
      "custom_attributes": {
        "Location": "example"
      },
      "description": "example",
      "encoded_id": "example",
      "evidence_items": [],
      "expired_on": {},
      "grade": {},
      "group_id": 1,
      "group_name": "example",
      "id": "example",
      "issued_on": "example",
      "issuer": {
        "description": {},
        "id": 1,
        "name": "example",
        "url": "example"
      },
      "meta_data": {},
      "name": "example",
      "private": false,
      "recipient": {
        "email": "example",
        "id": "example",
        "meta_data": {},
        "name": "example",
        "phone_number": "example"
      },
      "references": [],
      "seo_image": "example",
      "url": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete evidence

Delete an Evidence Item.

Inputs

Credential IDcredential_idtextRequired
ID of the Credential in the form of a string or integer for the particular Credential requested.
Evidence item IDevidence_item_idnumberRequired
ID of the EvidenceItem in the form of an integer.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "evidence_item": {
      "description": "example",
      "id": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete group

Delete a Group.

Inputs

Groupgroup_idnumberRequired
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.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "group": {
      "achievement_type": "example",
      "attach_pdf": false,
      "auto_expiry": 1,
      "auto_expiry_unit": "years",
      "badge_design_id": {},
      "blockchain": false,
      "certificate_design_id": {},
      "course_description": "example",
      "course_link": "example",
      "course_link_show": false,
      "course_name": "example",
      "created_at": "example",
      "department_id": 1,
      "design_id": 1,
      "design_name": "example",
      "generate_private_credential": false,
      "id": 1,
      "language": "example",
      "learning_outcomes": {},
      "meta_data": {},
      "name": "example",
      "organization_link_show": false,
      "primary_design_id": {},
      "signup_url": "example",
      "signup_url_show": false,
      "skill_category": {
        "id": 1,
        "name": "example"
      },
      "updated_at": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete reference

Delete a Reference.

Inputs

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

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "reference": {
      "description": "example",
      "id": 1,
      "referee": {
        "avatar": "example",
        "email": "example",
        "name": "example"
      },
      "relationship": "example",
      "supplemental": false
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get analytics

Index Analytics.

Inputs

Start datestart_datetext
Only return Credential analytic events recoreded after the given start date. Format: YYYY-MM-DD (YYYY/MM/DD also works but is deprecated)
End dateend_datetext
Only return Credential analytic events recoreded before the given end date. Format: YYYY-MM-DD (YYYY/MM/DD also works but is deprecated)
Groupgroup_idnumber
Only return Credential analytic events relating to Credentials within the given Group.
Department IDdepartment_idnumber
Only return Credential analytic events relating to Credentials within the given Department.
Page sizepage_sizenumber
The pagination response size, default of 100.From 1 to 100.
Pagepagenumber
The pagination page.At least 1.

Outputs

Value.

datanull
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Get credential

View a Credential.

Inputs

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

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "credential": {
      "approve": false,
      "badge": {
        "image": {}
      },
      "certificate": {
        "image": {}
      },
      "complete": false,
      "course_link": "example",
      "custom_attributes": {
        "Location": "example"
      },
      "description": "example",
      "encoded_id": "example",
      "evidence_items": [],
      "expired_on": {},
      "grade": {},
      "group_id": 1,
      "group_name": "example",
      "id": "example",
      "issued_on": "example",
      "issuer": {
        "description": {},
        "id": 1,
        "name": "example",
        "url": "example"
      },
      "meta_data": {},
      "name": "example",
      "private": false,
      "recipient": {
        "email": "example",
        "id": "example",
        "meta_data": {},
        "name": "example",
        "phone_number": "example"
      },
      "references": [],
      "seo_image": "example",
      "skills": [],
      "url": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get credential analytics

View Credential Analytics.

Inputs

IdidtextRequired
Id of the credential.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "analytics": []
  },
  "has_more": false,
  "next_cursor": null
}

Get design

View a Design.

Inputs

Designdesign_idnumberRequired
ID of the Design in the form of an integer for the particular Design requested.

Outputs

Value.

datanull
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Get evidence

View an Evidence Item.

Inputs

Credential IDcredential_idtextRequired
ID of the Credential in the form of an integer or string for the particular Credential requested.
Evidence item IDevidence_item_idnumberRequired
ID of the EvidenceItem in the form of an integer.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "evidence_item": {
      "description": "example",
      "id": 1,
      "link_url": "example",
      "position": 1,
      "preview_image_url": "example",
      "string_object": {},
      "supplemental": false,
      "type": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get group

View a Group.

Inputs

Groupgroup_idnumberRequired
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.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "group": {
      "attach_pdf": false,
      "auto_expiry": 1,
      "auto_expiry_unit": "years",
      "badge_design_id": {},
      "blockchain": false,
      "certificate_design_id": {},
      "collections": [],
      "course_description": "example",
      "course_link": "example",
      "course_link_show": false,
      "course_name": "example",
      "created_at": "example",
      "department_id": 1,
      "design_id": 1,
      "design_name": "example",
      "earning_criteria": [],
      "generate_private_credential": false,
      "id": 1,
      "language": "example",
      "learning_outcomes": {},
      "meta_data": {},
      "name": "example",
      "organization_link_show": false,
      "primary_design_id": {},
      "signup_url": "example",
      "signup_url_show": false,
      "skill_category": {
        "id": 1,
        "name": "example"
      },
      "skill_framework": {
        "attribution": {},
        "description": "example",
        "id": 1,
        "name": "example",
        "provider": "example",
        "source_type": "external",
        "taxonomy": "example",
        "version": {}
      },
      "skills": [],
      "updated_at": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get issuer

View an Issuer.

Inputs

None.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "issuer": {
      "certificate_left": 1,
      "email": "example",
      "id": 1,
      "language": "example",
      "linkedin_company_id": {},
      "linkedin_school_id": {},
      "name": "example",
      "spiderable": false,
      "url": "example",
      "whitelisted_domain": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get reference

View a Reference.

Inputs

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

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "reference": {
      "description": "example",
      "id": 1,
      "referee": {
        "avatar": "example",
        "email": "example",
        "name": "example"
      },
      "relationship": "example",
      "supplemental": false
    }
  },
  "has_more": false,
  "next_cursor": null
}

List skill categories

View all Skill Categories.

Inputs

None.

Outputs

Value.

datanull
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

List skill frameworks

View all Skill Frameworks.

Inputs

Department IDdepartment_idnumberRequired
The Department to list frameworks for. Required, including for API keys scoped to a single Department. Must be a Department your API key can access, otherwise a 403 Forbidden is returned.
Pagepagenumber
The pagination page. Defaults to 1.At least 1.
Page sizepage_sizenumber
The pagination response size. Defaults to 5, maximum 10. Values above the maximum are capped, and values that are not a positive number fall back to the default. The size actually applied is returned as meta.page_size.From 1 to 100.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "meta": {
      "current_page": 1,
      "next_page": 1,
      "page_size": 1,
      "prev_page": 1,
      "total_count": 1,
      "total_pages": 1
    },
    "skill_frameworks": []
  },
  "has_more": false,
  "next_cursor": null
}

Search attribute keys

Search for Attribute Keys.

Inputs

Namenametext
A name for the custom attribute key.
Kindrecord_kindtext
The kind of custom attribute key. Must be one of the following - [text, date, email, image].
Department IDdepartment_idnumber
Only return custom attribute keys of the given Department.
Page sizepage_sizenumber
The pagination response size, default of 50.From 1 to 100.
Pagepagenumber
The pagination page.At least 1.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "attribute_keys": [],
    "meta": {
      "current_page": 1,
      "next_page": {},
      "prev_page": {},
      "total_count": 1,
      "total_pages": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}

Search credentials

Search for Credentials (v2).

Inputs

Queryqueryobject
Credential search conditions, for example {"recipient_email":{"eq":"qa@example.com"}}. Leave empty to search every credential.
Sortsortobject
Sort for this request.
Page sizepage_sizenumber
Records per page, 1 to 100. Defaults to 50.From 1 to 100.
Cursorcursortext
Next cursor from an earlier search.
Offsetoffsetnumber
Records to skip. Use a cursor for large result sets; do not combine with cursor.From 0 to 9999.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "credentials": [],
    "meta": {
      "count": 1,
      "cursor": "example",
      "from": 1,
      "size": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}

Search departments

Search for Departments.

Inputs

Meta datameta_dataobject
Meta data for this request.
Page sizepage_sizenumber
The pagination response size, default of 50.From 1 to 100.
Pagepagenumber
The pagination page.At least 1.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "departments": {
      "description": "example",
      "generate_private_credential": false,
      "id": 1,
      "linkedin_company_id": "example",
      "logo": "example",
      "meta_data": {
        "faculty": "example",
        "internal_id": "example"
      },
      "name": "example",
      "page_banner": "example",
      "url": "example",
      "whitelabel_logo": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Search designs

Search for Designs.

Inputs

Kindrecord_kindtext
Kind for this request.
Meta datameta_dataobject
Meta data for this request.

Outputs

Value.

datanull
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Search groups

Search for Groups.

Inputs

Idsidslist
Limit the list of Groups to those id match the given array.
Namenametext
Limit the list of Groups to those named with the given string. Supports partial matching.
Course namecourse_nametext
Limit the list of Groups to those whose course name matches the given string. Supports partial matching.
Department IDdepartment_idnumber
Limit results to a particular Department. Must be a Department accessible to the API key being used; otherwise a 400 Bad Request is returned. When omitted, results include all Departments the API key can access.
Collection IDscollection_idslist
Limit results to Groups linked to any of the given Collections (OR). Combined with other filters using AND. Must be Collection UUIDs accessible to the API key being used; otherwise a 400 Bad Request is returned with One or more Invalid collection IDs. When omitted, no collection filter is applied. An empty array returns no Groups.
Meta datameta_dataobject
Key/values for client's own data on group
Start updated datestart_updated_datedate
Date after which Groups which have been updated should be returned. Format: YYYY-MM-DD
End updated dateend_updated_datedate
Date before which Groups which have been updated should be returned. Format: YYYY-MM-DD
Page sizepage_sizenumber
The pagination response size, default of 50.From 1 to 100.
Pagepagenumber
The pagination page.At least 1.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "groups": [],
    "meta": {
      "current_page": 1,
      "next_page": 1,
      "prev_page": {},
      "total_count": 1,
      "total_pages": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}

On this page