Program

Get all Programs

get

HTTP Request

GET /{tenantName}/{instanceName}/formations/{version}/programs

in our example it would be:

GET https://api.live.welkincloud.io/gh/sb-demo/formations/current/programs

Responses

Code

Description

200

401

Unauthorized

403

Forbidden

404

Not Found

Authorizations

AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters

tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health

instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live

Query parameters

sortstringOptionalExample: title,asc

Responses

200

List of programs

application/json

namestringRequiredPattern: ^[a-z0-9A-Z\-_]+$

titlestring · nullableOptional

descriptionstring · nullableOptional

400

Bad request — the request could not be understood or was missing required parameters.

401

Unauthorized — the Bearer token is missing, expired, or invalid.

403

Forbidden — the API client role does not have permission for this resource. Check the role and security policy in Admin.

404

Not found — the requested resource does not exist.

429

Too many requests — rate limit exceeded. Implement exponential backoff.

500

Internal server error.

get/{tenantName}/{instanceName}/formations/current/programs

GET /{tenantName}/{instanceName}/formations/current/programs HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "text",
    "title": "text",
    "description": "text",
    "phases": [
      {
        "name": "text",
        "title": "text",
        "type": "START",
        "description": "text",
        "autoFinishProgram": true,
        "navigateTo": [
          {
            "name": "text"
          }
        ]
      }
    ],
    "nodes": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  }
]

Get Program by name

get