GET
/
versions
curl --request GET \
  --url https://platform.happyrobot.ai/api/v1/versions \
  --header 'authorization: <authorization>' \
  --header 'x-organization-id: <x-organization-id>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "use_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "name": "<string>",
    "is_published": true,
    "is_live": true,
    "environment": "staging",
    "source_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "published_at": "2023-11-07T05:31:56Z",
    "is_deleted": true,
    "description": "<string>",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "changelog": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "type": "fork",
      "description": "<string>",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  }
]

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

​
x-organization-id
string
required

The organization ID to use for the request. Required if your user is associated to more than one organization.

Query Parameters

​
use_case_id
string
required

The ID of the use case.

​
with_changelog
boolean | null
default:false

Whether to include the changelog.

Response

200
application/json

200

A list of workflow versions.

GET
/
versions
curl --request GET \
  --url https://platform.happyrobot.ai/api/v1/versions \
  --header 'authorization: <authorization>' \
  --header 'x-organization-id: <x-organization-id>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "use_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "name": "<string>",
    "is_published": true,
    "is_live": true,
    "environment": "staging",
    "source_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "published_at": "2023-11-07T05:31:56Z",
    "is_deleted": true,
    "description": "<string>",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "changelog": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "type": "fork",
      "description": "<string>",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  }
]

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

​
x-organization-id
string
required

The organization ID to use for the request. Required if your user is associated to more than one organization.

Query Parameters

​
use_case_id
string
required

The ID of the use case.

​
with_changelog
boolean | null
default:false

Whether to include the changelog.

Response

200
application/json

200

A list of workflow versions.