Accredible Data Exports API
The following endpoints require the `data_exports` feature to be switched on, which is based on your pricing plan.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/accredible:accredible-data-exports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Accredible Credential Data Exports API
version: 25.08.0
description: 'The Accredible Credential API allows you to create and interact with badges and certificates called Accredible Credentials. There are 3 main objects in Accredible: Credentials, Groups and Designs. ### Getting Started with the API - Video Walkthrough
# Objects Overview
## Credentials
Credentials are the core object in the API. They collect all of the data related to a course, training activity or achievement and the recipient/participant information. You should create a credential for each achievement completion that a recipient has. For example if John Doe finishes the Programming 101 course we should create one credential to represent that. If John Doe achieves something else then he would need a new credential. ## Groups
Groups represent an achievement such as a course or qualification. They contain information about the achievement and have multiple Credentials attached to them. For example you should create a group for the Introduction to Programming course. You''d provide the Course Name, Course Description and Course URL. In the future you can pass the name or ID of this group when creating a credential so that the credential is passed all the information relating to the achievement. ## Designs
Designs provide a visual specification for how a Credential should be rendered. Designs can be used across multiple Groups. For example if we have three courses: Intro to Basic Programming, Intro to Advanced Programming and Intro to DevOps each of these may have the same design for their Credentials. When creating or updating their corresponding Groups you would attach the desired design accordingly. ## Departments
Departments, if enabled for your account allow you to manage multiple, independent organization groups. Each Department is entirely separate with its own Designs, Groups, Branding, etc. You cannot share data between Departments except Billing and Administrators. ## Attributes
Attributes, are used to merge information with your badge or certificate designs and email templates. Attributes act as placeholders for information and can be added to certificate designs and email templates. ## Skills Frameworks
Skills Frameworks are structured taxonomies of skills — Accredible-maintained ones such as O*NET, ESCO and NACE, plus any your organization uploads itself. Tagging a Group against a framework version replaces the Group''s free-text `learning_outcomes` with skills that carry a stable identifier and a known position in a recognized taxonomy. For example, instead of listing `"Reading Books"` on your Introduction to Programming group, you can attach the O*NET skill `Reading Comprehension` together with the trail it sits on — Worker Requirements → Basic Skills → Content. Frameworks are read-only over the API: you discover the frameworks enabled for a department, search their skills, then select those skills when creating or updating a Group. Uploading and managing frameworks is done in the Accredible Dashboard. # API Keys
API keys are used as Authorization tokens in the header in all authenticated API endpoints. These Keys are managed in the Accredible Dashboard. There are two types of API Keys, those that are account wide and work on all assets and those that are related to a specific department. API keys scoped to a specific department can only access the resources (Credentials, Groups, Designs etc.) belonging to that department. # Single sign-on options
Single sign-on in addition to the student authentication provided by Accredible, you can also use single sign-on to authenticate your student into Accredible and they can directly sign-in. SSO is also available via our Integrations and via SAML 2.0. # Rate Limiting
We allow up to 2000 requests every 5 minutes from a single IP address, but some higher security endpoints have stricter rate limiting. Requests are counted in 30 second periods.'
servers:
- url: https://api.accredible.com/
description: Production environment - US
- url: https://eu.api.accredible.com/
description: Production environment - EU
- url: https://sandbox.api.accredible.com/
description: Sandbox environment - Testing environment
tags:
- name: Data Exports
description: The following endpoints require the `data_exports` feature to be switched on, which is based on your pricing plan.
paths:
/v1/data_exports:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
data_exports:
type: array
items:
type: object
properties:
department_id:
type: number
description: The department ID where resources are exported from, it should be accessible via the given API_KEY.
status:
type: string
description: 'It can be:
- scheduled: Data export is not yet started
- processing: Data is being exported
- completed: Data has been exported
- errored: Something went wrong while exporting the data.'
urls:
type: array
items:
type: object
properties:
status:
type: string
description: It is always completed
year:
type: number
description: the year at which the data in the file is created
url:
type: string
description: the url to the file
description: List of urls to the exported files. It'll be available only if the data_export is "completed", otherwise, it will be empty.
required:
- data_exports
summary: View All Data Exports
operationId: ViewAllDataExports
description: Returns list of data exports of departments accessible via the used API_KEY.
tags:
- Data Exports
security:
- ApiKeyAuth: []
x-code-samples:
- lang: cURL
label: cURL
source: "curl -X GET \\\n \"https://api.accredible.com/v1/data_exports\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\""
x-operation-id-source: normalized
x-operation-id-original: View All Data Exports
post:
responses:
'201':
description: Created
headers: {}
content:
application/json:
schema:
type: object
properties:
department_id:
type: number
description: The department ID where resources are exported from, it should be accessible via the given API_KEY.
status:
type: string
description: 'It can be:
- scheduled: Data export is not yet started
- processing: Data is being exported
- completed: Data has been exported
- errored: Something went wrong while exporting the data.'
urls:
type: array
items:
type: object
properties:
status:
type: string
description: It is always completed
year:
type: number
description: the year at which the data in the file is created
url:
type: string
description: the url to the file
description: List of urls to the exported files. It'll be available only if the data_export is "completed", otherwise, it will be empty.
example:
data_export:
id: 2
department_id: 2
status: scheduled
created_at: '2022-09-16T07:00:00.000Z'
urls: []
summary: Create New Data Export
operationId: CreateNewDataExport
description: Creates a new data export for the provided department, if it's accessible via the used API_KEY.
tags:
- Data Exports
requestBody:
content:
application/json:
example:
data_export:
entity: credentials
department_id: 34
schema:
type: object
properties:
entity:
type: string
description: The resource to be exported, it can only one of these values (organizations, credentials, credential_analytics, groups, designs).
department_id:
type: number
description: The department ID where resources are exported from, it should be accessible via the given API_KEY.
required:
- entity
- department_id
security:
- ApiKeyAuth: []
x-code-samples:
- lang: cURL
label: cURL
source: "curl -X POST \\\n \"https://api.accredible.com/v1/data_exports\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"data_export\": {\n \"entity\": \"credentials\",\n \"department_id\": 34\n }\n}'"
x-operation-id-source: normalized
x-operation-id-original: Create New Data Export
/v1/data_exports/{id}:
get:
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
department_id:
type: number
description: The department ID where resources are exported from, it should be accessible via the given API_KEY.
status:
type: string
description: 'It can be:
- scheduled: Data export is not yet started
- processing: Data is being exported
- completed: Data has been exported
- errored: Something went wrong while exporting the data.'
urls:
type: array
items:
type: object
properties:
status:
type: string
description: It is always completed
year:
type: number
description: the year at which the data in the file is created
url:
type: string
description: the url to the file
description: List of urls to the exported files. It'll be available only if the data_export is "completed", otherwise, it will be empty.
summary: View a Data Export
operationId: ViewADataExport
description: ''
tags:
- Data Exports
parameters:
- name: id
in: path
description: '
Data Export ID
'
required: true
schema:
type: number
security:
- ApiKeyAuth: []
x-code-samples:
- lang: cURL
label: cURL
source: "curl -X GET \\\n \"https://api.accredible.com/v1/data_exports/12345\" \\\n -H \"Authorization: Token token=YOUR_API_KEY\""
x-operation-id-source: normalized
x-operation-id-original: View a Data Export
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: Authorization
description: 'Use the format: Token token=YOUR_API_KEY'
x-provenance:
method: harvested
publisher: Accredible
source: https://docs.api.accredible.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)