Accredify Workflows API
The Workflows API from Accredify — 5 operation(s) for workflows.
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/accredify0604-workflows-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: Workflow Module Workflows API
version: '1.0'
description: Workflow module endpoints
contact:
name: Accredify
url: https://accredify.io
email: support@accredify.io
termsOfService: https://www.accredify.io/legal
servers:
- url: https://nexus.staging.accredify.io
description: Staging
- url: https://nexus.uat.accredify.io
description: UAT
- url: https://nexus.accredify.io
description: Production
tags:
- name: Workflows
paths:
/api/v1/workflows:
parameters: []
get:
summary: Get list of workflows
description: Retrieve a paginated list of workflows with optional filtering by status, groups, search terms, and other criteria
tags:
- Workflows
security:
- OAuth2:
- workflows:read
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Workflow'
links:
$ref: '#/components/schemas/PaginationLinks'
meta:
$ref: '#/components/schemas/PaginationMeta'
required:
- links
- meta
examples:
Example 1:
value:
data:
- uuid: 9f2d6f69-8e2d-4310-8bfb-4edc8f93724f
name: OpenCert
description: null
created_at: '2025-06-17T15:41:55.000000Z'
updated_at: '2025-06-17T15:42:14.000000Z'
updated_by: John Doe
created_by: John Doe
active: true
has_active_runs: false
runs_count: 0
- uuid: 9f06bd25-c468-4b2a-8f47-cb5725dc02b2
name: Badge Workflow
description: null
created_at: '2025-05-29T10:01:59.000000Z'
updated_at: '2025-05-29T10:02:24.000000Z'
updated_by: John Doe
created_by: John Doe
active: true
has_active_runs: false
runs_count: 0
- uuid: 9f06871b-faa4-48c6-8516-23e13fac12eb
name: PDF Workflow
description: null
created_at: '2025-05-29T07:30:53.000000Z'
updated_at: '2025-05-29T09:54:40.000000Z'
updated_by: John Doe
created_by: John Doe
active: true
has_active_runs: false
runs_count: 0
links:
first: https://nexus.staging.accredify.io/api/v1/workflows?page=1
last: https://nexus.staging.accredify.io/api/v1/workflows?page=1
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
links:
- url: null
label: '« Previous'
active: false
- url: https://nexus.staging.accredify.io/api/v1/workflows?page=1
label: '1'
active: true
- url: null
label: Next »
active: false
path: https://nexus.staging.accredify.io/api/v1/workflows
per_page: 10
to: 5
total: 5
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
operationId: get-workflows
parameters:
- name: page
in: query
description: Page number for pagination
required: false
schema:
type: integer
minimum: 1
default: 1
example: 1
- name: per_page
in: query
description: Number of workflows per page
required: false
schema:
type: integer
enum:
- 10
- 20
- 30
- 40
- 50
default: 10
example: 10
- name: sort_order
in: query
description: Sort order for workflows by updated_at timestamp
required: false
schema:
type: string
default: desc
enum:
- asc
- desc
example: desc
- name: tab
in: query
description: Filter workflows by publication status
required: false
schema:
type: string
default: published
enum:
- published
- draft
example: published
- name: group_uuids[]
in: query
description: Filter workflows by organization group UUIDs. Repeat this parameter for multiple organization groups.
required: false
schema:
type: array
items:
type: string
format: uuid
style: form
explode: true
example:
- 9f854436-2e67-439e-bdda-e7ab6a4b5874
- 9fb13026-0719-4cf5-b559-8fd312eebdbd
- name: search
in: query
description: Search workflows by name (case-insensitive partial match)
required: false
schema:
type: string
maxLength: 255
example: Introduction to Statistics
- name: created_after
in: query
description: Filter workflows created at or after this timestamp (ISO 8601)
required: false
schema:
type: string
format: date-time
example: '2025-06-01T00:00:00.000000Z'
- name: created_before
in: query
description: Filter workflows created at or before this timestamp (ISO 8601)
required: false
schema:
type: string
format: date-time
example: '2025-06-30T23:59:59.000000Z'
- name: updated_after
in: query
description: Filter workflows updated at or after this timestamp (ISO 8601)
required: false
schema:
type: string
format: date-time
example: '2025-06-01T00:00:00.000000Z'
- name: updated_before
in: query
description: Filter workflows updated at or before this timestamp (ISO 8601)
required: false
schema:
type: string
format: date-time
example: '2025-06-30T23:59:59.000000Z'
- name: active[]
in: query
description: Filter workflows by active status. Repeat this parameter for multiple active statuses.
required: false
schema:
type: array
items:
type: string
enum:
- 'true'
- 'false'
style: form
explode: true
example:
- 'true'
- name: created_by[]
in: query
description: Filter workflows by creator user IDs. Repeat this parameter for multiple creator users.
required: false
schema:
type: array
items:
type: string
style: form
explode: true
example:
- 9fb13043-3833-4f0e-8aff-996a007e0aa5
requestBody:
content: {}
/api/v1/workflows/{workflow}:
parameters:
- schema:
type: string
name: workflow
in: path
required: true
get:
summary: Get workflow by workflow ID
description: Retrieve detailed information about a specific workflow including its configuration, status, and metadata
tags:
- Workflows
security:
- OAuth2:
- workflows:read
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowDetails'
examples:
Example 1:
value:
uuid: 9f001c24-eef9-4b82-8399-d4eaa1add4c5
name: OA Workflow (No Design)
description: null
created_at: '2025-05-26T02:56:49.000000Z'
updated_at: '2025-09-10T05:20:56.000000Z'
updated_by: John Doe
created_by: John Doe
active: true
versions:
- version: 10
published_at: null
created_at: '2025-09-10T05:20:56.000000Z'
updated_at: '2025-09-10T05:20:56.000000Z'
- version: 9
published_at: '2025-08-20T04:11:43.000000Z'
created_at: '2025-08-20T04:11:40.000000Z'
updated_at: '2025-08-20T04:11:43.000000Z'
- version: 8
published_at: '2025-08-20T04:09:39.000000Z'
created_at: '2025-08-20T04:09:26.000000Z'
updated_at: '2025-08-20T04:09:39.000000Z'
- version: 7
published_at: '2025-08-20T04:09:16.000000Z'
created_at: '2025-08-20T04:09:01.000000Z'
updated_at: '2025-08-20T04:09:16.000000Z'
- version: 6
published_at: '2025-06-16T05:41:16.000000Z'
created_at: '2025-06-16T05:40:06.000000Z'
updated_at: '2025-06-16T05:41:16.000000Z'
- version: 5
published_at: '2025-06-02T02:28:47.000000Z'
created_at: '2025-06-02T02:28:45.000000Z'
updated_at: '2025-06-02T02:28:47.000000Z'
- version: 4
published_at: '2025-06-02T02:26:26.000000Z'
created_at: '2025-05-29T09:55:07.000000Z'
updated_at: '2025-06-02T02:26:26.000000Z'
- version: 3
published_at: '2025-05-29T09:54:59.000000Z'
created_at: '2025-05-29T07:43:52.000000Z'
updated_at: '2025-05-29T09:54:59.000000Z'
- version: 2
published_at: '2025-05-29T07:25:42.000000Z'
created_at: '2025-05-26T05:28:55.000000Z'
updated_at: '2025-05-29T07:25:42.000000Z'
- version: 1
published_at: '2025-05-26T02:57:11.000000Z'
created_at: '2025-05-26T02:56:50.000000Z'
updated_at: '2025-05-26T02:57:11.000000Z'
latest_version:
version: 9
api_schema:
schema:
type: object
title: OA Document (No Design)
$schema: http://json-schema.org/draft-07/schema#
required:
- documents
properties:
documents:
type: array
items:
type: object
required:
- unique_id
properties:
id:
type: string
examples:
- '1234567890'
description: Internal reference, usually serial number, of this document
recipient:
type: object
required: []
properties:
name:
type: string
examples:
- John Doe
description: Recipient's name
additionalProperties: false
unique_id:
type: string
examples:
- '123'
description: ''
additionalProperties: false
description: ''
additionalProperties: false
flattened_schema:
- key: id
name: ID
example: '1234567890'
required: false
description: Internal reference, usually serial number, of this document
document_attribute_type: string
- key: recipient.name
name: Recipient Name
example: John Doe
required: false
description: Recipient's name
document_attribute_type: string
- key: unique_id
name: UniqueId
example: '123'
required: true
description: null
document_attribute_type: string
published_at: '2025-08-20T04:11:43.000000Z'
created_at: '2025-08-20T04:11:40.000000Z'
updated_at: '2025-08-20T04:11:43.000000Z'
has_active_runs: false
runs_count: 9
Example 2:
value:
uuid: 9fea65a9-a8a6-49cc-8141-de56b6a4f872
name: Untitled Workflow
description: null
created_at: '2025-09-19T14:06:07.000000Z'
updated_at: '2025-09-20T01:47:13.000000Z'
created_by:
uuid: 9fea6582-7340-4e37-b5e8-c4ab17cd2099
name: '[Seed] Darron AD'
role: admin
email: admin@accredify.io
status: active
updated_by:
uuid: 9fea6582-7340-4e37-b5e8-c4ab17cd2099
name: '[Seed] Darron AD'
role: admin
email: admin@accredify.io
status: active
active: true
versions:
- version: 4
published_at: '2025-09-20T01:47:13.000000Z'
created_at: '2025-09-20T01:47:13.000000Z'
updated_at: '2025-09-20T01:47:13.000000Z'
- version: 3
published_at: null
created_at: '2025-09-20T01:46:34.000000Z'
updated_at: '2025-09-20T01:46:34.000000Z'
- version: 2
published_at: '2025-09-20T01:45:13.000000Z'
created_at: '2025-09-20T01:45:13.000000Z'
updated_at: '2025-09-20T01:45:13.000000Z'
- version: 1
published_at: '2025-09-19T14:06:18.000000Z'
created_at: '2025-09-19T14:06:07.000000Z'
updated_at: '2025-09-19T14:06:18.000000Z'
latest_version:
version: 4
api_schema:
schema:
type: object
title: Default Education
$schema: http://json-schema.org/draft-07/schema#
required:
- documents
properties:
documents:
type: array
items:
type: object
required:
- issuedOn
- recipient
- courseCode
properties:
id:
type: string
examples:
- 07cf07ec-b5a5-41c2-938c-9849a47b9f02
description: System-generated and unique to each document. This cannot be edited.
name:
type: string
examples:
- Certificate of Participation
description: Name of the document
issuedOn:
type: string
format: date-time
examples:
- '2020-01-01T19:23:24Z'
description: The date that this certificate was issued by the issuer
expiresOn:
type: string
format: date-time
examples:
- '2020-01-01T19:23:24Z'
description: The date that this certificate expires
recipient:
type: object
required:
- name
- nric
- idType
properties:
name:
type: string
examples:
- John Doe
description: The name of the recipient.
nric:
type: string
examples:
- S1234567A
description: The nric of the recipient.
email:
type: string
format: email
examples:
- john.doe@example.com
description: The email of the recipient.
idType:
enum:
- SP
- SB
- SO
- OT
type: string
examples:
- SP
description: 'Type of identification document for the recipient. Required for Skills Passport uploads. Available types: SP (Singapore Pink IC Card - for Singapore citizens), SB (Singapore Blue IC Card - for Singapore permanent residents), SO (FIN/Work Permit - for foreigners), OT (Other - for other identification types).'
studentId:
type: string
examples:
- A123456789
description: The student ID of the recipient.
additionalProperties: false
courseCode:
enum:
- IS1013112
- IS101311234
type: string
examples:
- IS1013112
description: Code that identifies the course. Required to link the document to the selected course.
admissionDate:
type: string
format: date-time
examples:
- '2020-01-01T19:23:24Z'
description: The date that this student was admitted to the course
attainmentDate:
type: string
format: date-time
examples:
- '2020-01-01T19:23:24Z'
description: The date that this qualification was awarded to the recipient
graduationDate:
type: string
format: date-time
examples:
- '2020-01-01T19:23:24Z'
description: The date that this student graduated from the course
additionalProperties: false
description: This is for default education document
additionalProperties: false
flattened_schema:
- key: id
name: ID
example: 07cf07ec-b5a5-41c2-938c-9849a47b9f02
required: false
description: System-generated and unique to each document. This cannot be edited.
document_attribute_type: string
- key: name
name: Document Name
example: Certificate of Participation
required: false
description: Name of the document
document_attribute_type: string
- key: issuedOn
name: Issued On
example: '2020-01-01T19:23:24Z'
required: true
description: The date that this certificate was issued by the issuer
document_attribute_type: datetime
- key: expiresOn
name: Expires On
example: '2020-01-01T19:23:24Z'
required: false
description: The date that this certificate expires
document_attribute_type: datetime
- key: admissionDate
name: Admission Date
example: '2020-01-01T19:23:24Z'
required: false
description: The date that this student was admitted to the course
document_attribute_type: datetime
- key: graduationDate
name: Graduation Date
example: '2020-01-01T19:23:24Z'
required: false
description: The date that this student graduated from the course
document_attribute_type: datetime
- key: attainmentDate
name: Attainment Date
example: '2020-01-01T19:23:24Z'
required: false
description: The date that this qualification was awarded to the recipient
document_attribute_type: datetime
- key: recipient.name
name: Recipient Name
example: John Doe
required: true
description: The name of the recipient.
document_attribute_type: string
- key: recipient.email
name: Recipient Email
example: john.doe@example.com
required: false
description: The email of the recipient.
document_attribute_type: email
- key: recipient.nric
name: Recipient NRIC
example: S1234567A
required: true
description: The nric of the recipient.
document_attribute_type: nric
- key: recipient.studentId
name: Recipient Student ID
example: A123456789
required: false
description: The student ID of the recipient.
document_attribute_type: string
- key: courseCode
name: Course Code
example: IS1013112
required: true
description: Code that identifies the course. Required to link the document to the selected course.
allowed_options:
- label: IS1013112 - Introduction to Statistics
value: IS1013112
- label: IS101311234 - Introduction to Statistics
value: IS101311234
document_attribute_type: string
- key: recipient.idType
name: Recipient NRIC Type
example: SP
required: true
description: 'Type of identification document for the recipient. Required for Skills Passport uploads. Available types: SP (Singapore Pink IC Card - for Singapore citizens), SB (Singapore Blue IC Card - for Singapore permanent residents), SO (FIN/Work Permit - for foreigners), OT (Other - for other identification types).'
allowed_options:
- label: Singapore Pink IC Card
value: SP
- label: Singapore Blue IC Card
value: SB
- label: FIN/Work Permit
value: SO
- label: Other
value: OT
document_attribute_type: string
published_at: '2025-09-20T01:47:13.000000Z'
created_at: '2025-09-20T01:47:13.000000Z'
updated_at: '2025-09-20T01:47:13.000000Z'
has_active_runs: false
runs_count: 1
document_template:
id: 8
name: Default Education
description: This is for default education document
document_standard: OCv2
type: certificate
is_draft: false
created_at: '2025-09-19T14:05:43.000000Z'
updated_at: '2025-09-19T14:05:43.000000Z'
created_by: null
updated_by: null
tags: []
attributes:
- name: ID
key: id
type: string
description: System-generated and unique to each document. This cannot be edited.
example: 07cf07ec-b5a5-41c2-938c-9849a47b9f02
required: true
- name: Document Name
key: name
type: string
description: Name of the document
example: Certificate of Participation
required: true
- name: Issued On
key: issuedOn
type: datetime
description: The date that this certificate was issued by the issuer
example: '2020-01-01T19:23:24Z'
required: true
- name: Expires On
key: expiresOn
type: datetime
description: The date that this certificate expires
example: '2020-01-01T19:23:24Z'
required: false
- name: Admission Date
key: admissionDate
type: datetime
description: The date that this student was admitted to the course
example: '2020-01-01T19:23:24Z'
required: false
- name: Graduation Date
key: graduationDate
type: datetime
description: The date that this student graduated from the course
example: '2020-01-01T19:23:24Z'
required: false
- name: Attainment Date
key: attainmentDate
type: datetime
description: The date that this qualification was awarded to the recipient
example: '2020-01-01T19:23:24Z'
required: false
- name: Recipient Name
key: recipient.name
type: string
description: The name of the recipient.
example: John Doe
required: true
- name: Recipient Email
key: recipient.email
type: email
description: The email of the recipient.
example: john.doe@example.com
required: false
- name: Recipient NRIC
key: recipient.nric
type: nric
description: The nric of the recipient.
example: S1234567A
required: false
- name: Recipient Student ID
key: recipient.studentId
type: string
description: The student ID of the recipient.
example: A123456789
required: false
design_template:
id: 25
name: Default Education
description: This is for default education document
document_standard: OCv2
document_templates_count: 1
is_custom_design: true
type: certificate
tags: []
thumbnails:
- url: http://localhost:9000/local/custom_designs/DEFAULT-EDUCATION/thumbnail.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=sail%2F20250920%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250920T015942Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=d096835ff7c195c57b37fbf93344a1acc01d1c46dd8400b1dd118c76fe0f81a9
label: Custom Certificate
attributes:
- name: ID
key: id
type: string
description: Document ID
example: '1234567890'
required: true
- name: Certificate Name
# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/accredify0604/refs/heads/main/openapi/accredify0604-workflows-api-openapi.yml