Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Accredible Groups API

Course or achievement containers that credentials are issued against.

Accredible Groups API is one of 10 APIs that Accredible publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.accredible.com/v1, https://sandbox.api.accredible.com/v1.

6 operations 4 paths 4 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.accredible.com/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Accredible Groups API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — API key sent in the Authorization header using the scheme Token token=YOURAPIKEY.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Groups 6

Course or achievement containers that credentials are issued against.

POST
/issuer/groups
Create a group
createGroup body → 200401
GET
/issuer/groups/{group_id}
View a group
getGroup 1 param → 200404
PUT
/issuer/groups/{group_id}
Update a group
updateGroup 1 param body → 200401
DELETE
/issuer/groups/{group_id}
Delete a group
deleteGroup 1 param → 200401
GET
/issuer/all_groupsdeprecated
View all groups (deprecated)
listAllGroups 3 params → 200401
POST
/issuer/groups/search
Search for groups
searchGroups body → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are GroupInput (5 properties), Error (2 properties), GroupEnvelope (1 property). Each schema is shown below with its type and property counts.

GroupEnvelope
object
1 property
Group
Error
object
2 properties
GroupInput
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

accredible-groups-api-openapi.yml Raw ↑

Other APIs Accredible publishes across the network.

Accredible Analytics API
Accredible Credentials API
Accredible Departments API
Accredible Designs API
Accredible Evidence Items API
Accredible Issuer API
Accredible References API
Accredible SSO API
Accredible Team Members API