Skip to main content
API docs by Redocly

overlord API definition (1.0.0)

overlord API definition

/v1/aggregation-requests

/v1/aggregation-requests/

Request Body schema: application/json
required
object
type
required
string
Value: "aggregation-requests"
required
object
required
Array of objects
Array
column
required
string <= 64 characters
individual-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/bulk-interviews

/v1/bulk-interviews/

Request Body schema: application/json
Any of
all-participants
required
any
Value: true
organization-id
required
string <uuid>
profile-name
required
string <= 255 characters
answer-url
string <= 255 characters
auto-open
boolean
Default: false
auto-start
boolean
Default: false

Interviews will start in a background task

blocking
boolean
Default: false
dismissible
boolean
Default: true
expired-at
string <datetime>
version
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "answer-url": "string",
  • "auto-open": false,
  • "auto-start": false,
  • "blocking": false,
  • "dismissible": true,
  • "expired-at": "string",
  • "individual-group-ids": [
    ],
  • "individual-ids": [
    ],
  • "organization-id": "11111111-1111-1111-1111-111111111111",
  • "profile-name": "string",
  • "version": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/form-instances

/v1/form-instances/

query Parameters
filter[spec-name]
string <= 255 characters
filter[spec-type]
string
Enum: "participant-extension" "standard"
filter[state]
string
Enum: "completed" "created" "started"
filter[version-id]
string <uuid>
Example: filter[version-id]=11111111-1111-1111-1111-111111111111
include[internal]
boolean
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/form-instances/

Request Body schema: application/json
required
object
type
required
string
Value: "form-instances"
required
object
individual-id
required
string <uuid>
version-id
required
string <uuid>
assigned-to-individual
boolean
Default: false
description
string <= 255 characters
object (FormSchemaOverride)
properties
object
object (FormSchemaExtensionOverride)
notify-user
boolean
Default: true
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/form-instances/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/form-instances/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/form-instances/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "form-instances"
required
object
assigned-to-individual
boolean
description
string <= 255 characters
object (FormSchemaOverride)
properties
object
object (FormSchemaExtensionOverride)
notify-user
boolean
object
type
required
string
Value: "string"
value
required
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/form-instances/{id}/assign-anonymous-url/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "anonymous-url": "string"
}

/v1/form-instances/{id}/respond/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
response-values
required
object
instance-state
string
Default: "started"
Enum: "completed" "started"
remove-missing
boolean
Default: false

Remove all previous responses missing from response-values

Responses

Request samples

Content type
application/json
{
  • "instance-state": "completed",
  • "remove-missing": false,
  • "response-values": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/form-spec-versions

/v1/form-spec-versions/

query Parameters
spec-id
required
string <uuid>
Example: spec-id=11111111-1111-1111-1111-111111111111
filter[assignable]
boolean
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/form-spec-versions/

Request Body schema: application/json
required
object
type
required
string
Value: "form-spec-versions"
required
object
required
FormSchema (object) or FormSchemaV2 (object)
Any of
order
required
Array of strings[ items <= 999 characters ]
properties
required
object
required
required
Array of strings[ items <= 999 characters ]
type
required
string
Value: "object"
additionalProperties
boolean
GridLayoutSchema (object) (LayoutSchema)
Array of objects (FormSchemaLimit)

Used to define validation limits between properties

Array of objects (SectionSchema)
spec-id
required
string <uuid>
assignable
boolean
Default: true
description
string <= 255 characters
make-current-version
boolean
Default: false
response-schema
object

Defaults to form-schema-template if omitted

meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/form-spec-versions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/form-spec-versions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/form-spec-versions/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "form-spec-versions"
required
object
assignable
boolean
description
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/form-specs

/v1/form-specs/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[assignable]
boolean
filter[name]
string <= 255 characters
filter[type]
string
Enum: "participant-extension" "standard"
filter[ui-managed]
boolean
include[internal]
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/form-specs/

Request Body schema: application/json
required
object
type
required
string
Value: "form-specs"
required
object
name
required
string <= 255 characters
organization-id
required
string <uuid>
internal
boolean
Default: false
type
string
Default: "standard"
Enum: "participant-extension" "standard"
ui-managed
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/form-specs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/form-specs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/form-specs/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "form-specs"
required
object
current-version-id
string <uuid>
internal
boolean
name
string <= 255 characters
type
string
Enum: "participant-extension" "standard"
ui-managed
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individual-groups

/v1/individual-groups/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interaction-invocations

/v1/interaction-invocations/

query Parameters
interaction-id
required
string <uuid>
Example: interaction-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interaction-invocations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interaction-invocations/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

/v1/interaction-profile-versions

/v1/interaction-profile-versions/

Request Body schema: application/json
filter[name]
string <= 255 characters
filter[spec]
object
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
page[offset]
integer (PageOffset) >= 0
with-spec
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "filter[name]": "string",
  • "filter[spec]": { },
  • "organization-id": "11111111-1111-1111-1111-111111111111",
  • "page[limit]": 100,
  • "page[offset]": 0,
  • "with-spec": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interaction-profiles

/v1/interaction-profiles/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
filter[name][contains]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interaction-profiles/

Request Body schema: application/json
required
object
type
required
string
Value: "interaction-profiles"
required
object
name
required
string <= 255 characters
organization-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interaction-profiles/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/interaction-profiles/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interaction-profiles/{id}/add-version/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
spec
required
object
name
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "spec": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "created-at": "string",
  • "created-by": "11111111-1111-1111-1111-111111111111",
  • "created-by-first-name": "string",
  • "created-by-last-name": "string",
  • "default": true,
  • "hash-id": "string",
  • "last-modified-at": "string",
  • "last-modified-by": "11111111-1111-1111-1111-111111111111",
  • "last-modified-by-first-name": "string",
  • "last-modified-by-last-name": "string",
  • "name": "string",
  • "profile-id": "11111111-1111-1111-1111-111111111111",
  • "spec": { }
}

/v1/interaction-profiles/{id}/get-versions/

path Parameters
id
required
string

Resource identifier

query Parameters
name
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
with-spec
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interaction-profiles/{id}/update-version/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
name
required
string <= 255 characters
default
boolean
spec
object

Responses

Request samples

Content type
application/json
{
  • "default": true,
  • "name": "string",
  • "spec": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "created-at": "string",
  • "created-by": "11111111-1111-1111-1111-111111111111",
  • "created-by-first-name": "string",
  • "created-by-last-name": "string",
  • "default": true,
  • "hash-id": "string",
  • "last-modified-at": "string",
  • "last-modified-by": "11111111-1111-1111-1111-111111111111",
  • "last-modified-by-first-name": "string",
  • "last-modified-by-last-name": "string",
  • "name": "string",
  • "profile-id": "11111111-1111-1111-1111-111111111111",
  • "spec": { }
}

/v1/interaction-storage-entries

/v1/interaction-storage-entries/

query Parameters
storage-id
required
string <uuid>
Example: storage-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interaction-storage-entries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interaction-storages

/v1/interaction-storages/

query Parameters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interaction-storages/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interactions

/v1/interactions/

query Parameters
filter[include-inactive]
boolean
Default: false
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[profile-id]
string <uuid>
Example: filter[profile-id]=11111111-1111-1111-1111-111111111111
filter[profile-name]
string <= 255 characters
filter[workflow-id]
string <uuid>
Example: filter[workflow-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interactions/

Request Body schema: application/json
required
object
type
required
string
Value: "interactions"
required
object
individual-id
required
string <uuid>
user-id
required
string <uuid>
args
object
organization-id
string <uuid>
profile-id
string <uuid>
profile-name
string <= 255 characters
version
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interactions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "task-id": "string"
}

/v1/interactions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interactions/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
created-after
string <uuid>
Example: created-after=11111111-1111-1111-1111-111111111111
level
string
Enum: "CRITICAL" "DEBUG" "ERROR" "INFO" "WARN"
page[limit]
integer [ 1 .. 1000 ]
Default: 500
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings
Default: "created"
Items Enum: "-created" "-type" "created" "type"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interactions/{id}/restart/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
version
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "version": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "task-id": "string"
}

/v1/interview-profiles

/v1/interview-profiles/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[auto-open]
boolean
filter[display-name]
string <= 255 characters
filter[exclude-types]
Array of strings <= 2 items
Items Enum: "general" "internal"
filter[include-types]
Array of strings <= 2 items
Items Enum: "general" "internal"
filter[name]
string <= 255 characters
filter[ui-managed]
boolean
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
use-stats-v2
boolean
Deprecated
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interview-profiles/

Request Body schema: application/json
required
object
type
required
string
Value: "interview-profiles"
required
object
organization-id
required
string <uuid>
auto-open
boolean
Default: false
blocking
boolean
Default: false
can-retake
boolean
Default: false
description
string <= 255 characters
display-name
string <= 255 characters
individual-group-id
string <uuid>
name
string <= 255 characters
type
string
Default: "internal"
Enum: "general" "internal"
ui-managed
boolean
Default: false
object
spec
required
object
name
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-profiles/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/interview-profiles/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
include-default-version
boolean
Default: false
use-stats-v2
boolean
Deprecated
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-profiles/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
required
object
auto-open
boolean
blocking
boolean
can-retake
boolean
description
string <= 255 characters
display-name
string <= 255 characters
name
string <= 255 characters
type
string
Enum: "general" "internal"
ui-managed
boolean
type
required
string
Value: "interview-profiles"
id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-profiles/{id}/add-version/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
spec
required
object
name
string <= 255 characters
profile-display-name
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "profile-display-name": "string",
  • "spec": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "created-at": "string",
  • "created-by": "11111111-1111-1111-1111-111111111111",
  • "default": true,
  • "last-modified-at": "string",
  • "last-modified-by": "11111111-1111-1111-1111-111111111111",
  • "name": "string",
  • "profile-id": "11111111-1111-1111-1111-111111111111",
  • "spec": { }
}

/v1/interview-profiles/{id}/get-dot/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "dot": "string"
}

/v1/interview-profiles/{id}/get-versions/

path Parameters
id
required
string

Resource identifier

query Parameters
name
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
with-spec
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interview-profiles/{id}/retake/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-profiles/{id}/update-version/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
name
required
string <= 255 characters
default
boolean
spec
object

Responses

Request samples

Content type
application/json
{
  • "default": true,
  • "name": "string",
  • "spec": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "created-at": "string",
  • "created-by": "11111111-1111-1111-1111-111111111111",
  • "default": true,
  • "last-modified-at": "string",
  • "last-modified-by": "11111111-1111-1111-1111-111111111111",
  • "name": "string",
  • "profile-id": "11111111-1111-1111-1111-111111111111",
  • "spec": { }
}

/v1/interview-questions

/v1/interview-questions/

query Parameters
interview-id
required
string <uuid>
Example: interview-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interview-questions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-questions/{id}/answer/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
value
required
string <= 9999 characters

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-questions/{id}/get-next/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-questions/{id}/get-previous/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-schedulers

/v1/interview-schedulers/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interview-schedulers/

Request Body schema: application/json
required
object
type
required
string
Value: "interview-schedulers"
required
object
individual-group-id
required
string <uuid>
organization-id
required
string <uuid>
profile-name
required
string <= 255 characters
rrule
required
string <rrule>
start
required
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-schedulers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/interview-schedulers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-schedulers/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "interview-schedulers"
required
object or object
Any of
rrule
required
string <rrule>
start
required
string <datetime>
profile-name
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interview-schedulers/{id}/trigger/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interviews

/v1/interviews/

query Parameters
filter[auto-open]
boolean
filter[group-id]
string <uuid>
Example: filter[group-id]=11111111-1111-1111-1111-111111111111
filter[include-expired]
boolean
Default: false
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[profile-display-name]
string <= 255 characters
filter[profile-id]
string <uuid>
Example: filter[profile-id]=11111111-1111-1111-1111-111111111111
filter[profile-name]
string <= 255 characters
filter[simulation-owner-id]
string <uuid>
Example: filter[simulation-owner-id]=11111111-1111-1111-1111-111111111111
filter[state2]
Array of strings
Items Enum: "cancelled" "completed" "created" "inprogress" "started"
filter[state]
string
Deprecated
Enum: "created" "running" "stopped"
include-individuals
boolean
Default: false
include-questions
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings
Default: "-created-at"
Items Enum: "-completed-at" "-created-at" "completed-at" "created-at"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/interviews/

Request Body schema: application/json
required
object
type
required
string
Value: "interviews"
required
object
individual-id
required
string <uuid>
organization-id
required
string <uuid>
profile-name
required
string <= 255 characters
answer-url
string <= 255 characters
auto-open
boolean
Default: false
auto-start
boolean
Default: false
blocking
boolean
dismissible
boolean
Default: true
expired-at
string <datetime>
external-data
object
notify-user
boolean
Default: true
simulation-owner-id
string <uuid>
version
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interviews/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{ }

/v1/interviews/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
include-questions
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interviews/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "interviews"
required
object
external-data
object
object
type
required
string
Value: "string"
value
required
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interviews/{id}/dismiss/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interviews/{id}/start/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/interviews/{id}/stop/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-block-types

/v1/lnp-block-types/

query Parameters
filter[include-internal]
boolean
Default: false
filter[name]
string <= 64 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-block-types/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-event-schedulers

/v1/lnp-event-schedulers/

query Parameters
program-id
required
string <uuid>
Example: program-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-event-schedulers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-event-schedulers/{id}/timer/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "task-id": "string"
}

/v1/lnp-event-types

/v1/lnp-event-types/

query Parameters
filter[include-internal]
boolean
Default: false
filter[name]
string <= 64 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-event-types/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-program-versions

/v1/lnp-program-versions/

query Parameters
program-id
required
string <uuid>
Example: program-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 64 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-program-versions/

Request Body schema: application/json
required
object
type
required
string
Value: "lnp-program-versions"
required
object
program-id
required
string <uuid>
description
string <= 9999 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-program-versions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/lnp-program-versions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-program-versions/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "lnp-program-versions"
required
object
description
string <= 9999 characters
initial-block-id
string <uuid>
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-program-versions/{id}/clone/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
description
string <= 9999 characters

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Get dynamic options for a specific block argument

Get dynamic options for a specific block argument

path Parameters
id
required
string

Resource identifier

query Parameters
arg-name
required
string <= 255 characters
block-type
required
string <= 64 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/v1/lnp-programs

/v1/lnp-programs/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[exact-name]
string <= 255 characters

Exact name match

filter[name]
string <= 255 characters

Partial, case-insensitive name match

page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-programs/

Request Body schema: application/json
required
object
type
required
string
Value: "lnp-programs"
required
object
event-type
required
string <= 64 characters
name
required
string <= 255 characters
organization-id
required
string <uuid>
armed
boolean
Default: false
description
string <= 9999 characters
event-filter
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-programs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/lnp-programs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-programs/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "lnp-programs"
required
object
armed
boolean
description
string <= 9999 characters
event-filter
object
event-type
string <= 64 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-programs/{id}/get-event-filter/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/v1/lnp-programs/{id}/select-version/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
version-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "version-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-run-blocks

/v1/lnp-run-blocks/

query Parameters
run-id
required
string <uuid>
Example: run-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 64 characters
filter[status]
string
Enum: "failed" "running" "success"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-run-blocks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-run-logs

/v1/lnp-run-logs/

query Parameters
run-id
required
string <uuid>
Example: run-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-run-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-runs

/v1/lnp-runs/

query Parameters
version-id
required
string <uuid>
Example: version-id=11111111-1111-1111-1111-111111111111
filter[status]
string
Enum: "failed" "running" "success"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-runs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-version-blocks

/v1/lnp-version-blocks/

query Parameters
version-id
required
string <uuid>
Example: version-id=11111111-1111-1111-1111-111111111111
filter[type]
string <= 64 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-version-blocks/

Request Body schema: application/json
required
object
type
required
string
Value: "lnp-version-blocks"
required
object
args
required
object
type
required
string <= 64 characters
version-id
required
string <uuid>
arg-variables
object
description
string <= 9999 characters
is-initial-block
boolean
Default: false
source-block-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-version-blocks/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
reconnect-link
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/lnp-version-blocks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-version-blocks/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "lnp-version-blocks"
required
object
arg-variables
object
args
object
description
string <= 9999 characters
type
string <= 64 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-version-blocks/{id}/get-args/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/v1/lnp-version-builds

/v1/lnp-version-builds/

query Parameters
version-id
required
string <uuid>
Example: version-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-version-builds/

Request Body schema: application/json
required
object
type
required
string
Value: "lnp-version-builds"
required
object
version-id
required
string <uuid>
apply
boolean
Default: false
publish
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-version-builds/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-version-links/

query Parameters
version-id
required
string <uuid>
Example: version-id=11111111-1111-1111-1111-111111111111
filter[destination-id]
string <uuid>
Example: filter[destination-id]=11111111-1111-1111-1111-111111111111
filter[source-id]
string <uuid>
Example: filter[source-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/lnp-version-links/

Request Body schema: application/json
required
object
type
required
string
Value: "lnp-version-links"
required
object
destination-id
required
string <uuid>
source-id
required
string <uuid>
version-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/lnp-version-links/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/lnp-version-links/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-forms

/v1/pathway-instance-forms/

query Parameters
filter[form-instance-id]
string <uuid>
Example: filter[form-instance-id]=11111111-1111-1111-1111-111111111111
filter[instance-id]
string <uuid>
Example: filter[instance-id]=11111111-1111-1111-1111-111111111111
filter[instance-step-id]
string <uuid>
Example: filter[instance-step-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-instance-forms/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instance-forms"
required
object
form-version-id
required
string <uuid>
instance-id
required
string <uuid>
assigned-to-individual
boolean
Default: false
blocking
boolean
Default: false
description
string <= 255 characters
instance-step-id
string <uuid>
notify-user
boolean
Default: true
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-forms/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-instance-forms/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-forms/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instance-forms"
required
object
blocking
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-logs

/v1/pathway-instance-logs/

query Parameters
instance-id
required
string <uuid>
Example: instance-id=11111111-1111-1111-1111-111111111111
filter[level]
integer
filter[step-id]
string <uuid>
Example: filter[step-id]=11111111-1111-1111-1111-111111111111
filter[system]
boolean
filter[type]
string
Enum: "api" "api-error" "internal" "text" "user-error"
filter[user-id]
string <uuid>
Example: filter[user-id]=11111111-1111-1111-1111-111111111111
include-data
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-instance-logs/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
include-data
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-notes

/v1/pathway-instance-notes/

query Parameters
filter[has-step]
boolean
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[instance-step-id]
string <uuid>
Example: filter[instance-step-id]=11111111-1111-1111-1111-111111111111
instance-id
string <uuid>
Example: instance-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-instance-notes/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instance-notes"
required
object
instance-id
required
string <uuid>
text
required
string <= 9999 characters
instance-step-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-notes/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-instance-notes/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-notes/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instance-notes"
required
object
text
string <= 9999 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-reminders

/v1/pathway-instance-reminders/

query Parameters
instance-step-id
required
string <uuid>
Example: instance-step-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 64 characters ^[a-z0-9_-]+$
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings
Default: "-created-at"
Items Enum: "-created-at" "-scheduled-at" "created-at" "scheduled-at"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-instance-reminders/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instance-reminders"
required
object
instance-step-id
required
string <uuid>
name
required
string <= 64 characters ^[a-z0-9_-]+$
scheduled-at
required
string <datetime>
description
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-reminders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-instance-reminders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-reminders/{id}/arm/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-reminders/{id}/trigger/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-stages

/v1/pathway-instance-stages/

query Parameters
instance-id
required
string <uuid>
Example: instance-id=11111111-1111-1111-1111-111111111111
filter[spec-id]
string <uuid>
Example: filter[spec-id]=11111111-1111-1111-1111-111111111111
filter[state]
string
Enum: "completed" "started"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-instance-stages/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-steps

/v1/pathway-instance-steps/

query Parameters
filter[archived]
boolean
filter[assigned-group-id]
string <uuid>
Example: filter[assigned-group-id]=11111111-1111-1111-1111-111111111111
filter[assigned-user-id]
string <uuid>
Example: filter[assigned-user-id]=11111111-1111-1111-1111-111111111111
filter[current-stage]
boolean
filter[from-stage-id]
string <uuid>
Example: filter[from-stage-id]=11111111-1111-1111-1111-111111111111
filter[from-stage-spec-id]
string <uuid>
Example: filter[from-stage-spec-id]=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
filter[spec-id]
string <uuid>
Example: filter[spec-id]=11111111-1111-1111-1111-111111111111
filter[states]
Array of strings non-empty
Items Enum: "archived" "complete" "incomplete" "inprogress" "inreview" "new" "skipped"
instance-id
string <uuid>
Example: instance-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings
Items Enum: "-created-at" "-due-date" "created-at" "due-date" "order"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-instance-steps/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instance-steps"
required
object
instance-id
required
string <uuid>
args
object
assigned-group-id
string <uuid>
assigned-user-id
string <uuid>
description
string <= 255 characters
due-date
string <datetime>
event-trigger-types
Array of strings
Items Enum: "init" "patch" "reminder" "set-state"
generate-event
boolean
Default: false
name
string <= 255 characters
necessity
string
Default: "o"
Enum: "e" "o" "r"
order
integer
Default: 0
Array of objects non-empty
Array (non-empty)
days
integer
description
string <= 255 characters
hours
integer
microseconds
integer
milliseconds
integer
minutes
integer
name
string <= 64 characters ^[a-z0-9_-]+$
seconds
integer
weeks
integer
step-spec-id
string <uuid>
title
string <= 255 characters
type
string <= 64 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-steps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-instance-steps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-steps/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instance-steps"
required
object
args
object
null or string
Any of
null
null or string
Any of
null
description
string <= 255 characters
null or string
Any of
null
event-trigger-types
Array of strings
Items Enum: "init" "patch" "reminder" "set-state"
generate-event
boolean
order
integer
Array of objects
Array
days
integer
description
string <= 255 characters
hours
integer
microseconds
integer
milliseconds
integer
minutes
integer
name
string <= 64 characters ^[a-z0-9_-]+$
seconds
integer
weeks
integer
title
string <= 255 characters
type
string <= 64 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-steps/{id}/deferred-set-state/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
state
required
string
Enum: "archived" "complete" "incomplete" "inprogress" "inreview" "new" "skipped"

Responses

Request samples

Content type
application/json
{
  • "state": "archived"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-steps/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{ }

/v1/pathway-instance-steps/{id}/get-next-states/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "states": [
    ]
}

/v1/pathway-instance-store-forms

/v1/pathway-instance-store-forms/

query Parameters
pathway-spec-id
required
string <uuid>
Example: pathway-spec-id=11111111-1111-1111-1111-111111111111
section
required
string <= 64 characters
filter[names]
Array of strings[ items <= 9999 characters ]
id-in-key
boolean

When true, the form instance ID is in the 'key' of the store, not the 'value'

page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-instance-stores

/v1/pathway-instance-stores/

query Parameters
filter[key]
string <= 64 characters ^[a-z0-9_-]+$
filter[section]
string <= 64 characters ^[a-z0-9_-]+$
filter[step-id]
string <uuid>
Example: filter[step-id]=11111111-1111-1111-1111-111111111111
instance-id
string <uuid>
Example: instance-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
spec-id
string <uuid>
Example: spec-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-instance-stores/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instance-stores"
required
object
instance-id
required
string <uuid>
key
required
string <= 64 characters ^[a-z0-9_-]+$
value
required
string <= 9999 characters
section
string <= 64 characters ^[a-z0-9_-]+$
step-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-stores/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-instance-stores/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-stores/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instance-stores"
required
object
value
string <= 9999 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instance-todos

/v1/pathway-instance-todos/

query Parameters
filter[instance-id]
string <uuid>
Example: filter[instance-id]=11111111-1111-1111-1111-111111111111
filter[instance-step-id]
string <uuid>
Example: filter[instance-step-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-instance-todos/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instances

/v1/pathway-instances/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[first-name]
string <= 255 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[last-name]
string <= 255 characters
filter[spec-id]
string <uuid>
Example: filter[spec-id]=11111111-1111-1111-1111-111111111111
filter[stage-spec-id]
string <uuid>
Example: filter[stage-spec-id]=11111111-1111-1111-1111-111111111111
filter[state]
string
Enum: "archived" "completed" "created" "started"
filter[version-id]
string <uuid>
Example: filter[version-id]=11111111-1111-1111-1111-111111111111
include[store]
Array of strings[ items <= 64 characters ]
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings
Default: "created"
Items Enum: "-created" "-stage-created" "-stage-title" "-started" "created" "stage-created" "stage-title" "started"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-instances/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instances"
required
object
individual-id
required
string <uuid>
version-id
required
string <uuid>
auto-start
boolean
Default: false
description
string <= 255 characters
initial-spec-stage-id
string <uuid>
store-schema
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instances/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-instances/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instances/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instances"
required
object
description
string <= 255 characters
store-schema
object
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instances/{id}/archive/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
reason
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instances/{id}/deferred-next-stage/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
stage-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "stage-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instances/{id}/set-store/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
additional property
null or string
Any of
null

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-instances/{id}/start/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
initial-spec-stage-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "initial-spec-stage-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-dashboards

/v1/pathway-spec-dashboards/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-spec-dashboards/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-dashboards"
required
object
name
required
string <= 255 characters
required
object (DashboardSchema)
required
Array of DashboardColumnDate (object) or DashboardColumnForm (object) or DashboardColumnParticipant (object) or DashboardColumnReport (object) or DashboardColumnString (object) (DashboardColumn)
form-ids-in-key
required
boolean
form-store-section
required
string <= 64 characters
report-store-section
required
string <= 64 characters
store-keys
required
Array of strings[ items <= 64 characters ]
Array of objects (DashboardFilter)
spec-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-dashboards/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-spec-dashboards/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-dashboards/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-dashboards"
required
object
name
string <= 255 characters
object (DashboardSchema)
required
Array of DashboardColumnDate (object) or DashboardColumnForm (object) or DashboardColumnParticipant (object) or DashboardColumnReport (object) or DashboardColumnString (object) (DashboardColumn)
form-ids-in-key
required
boolean
form-store-section
required
string <= 64 characters
report-store-section
required
string <= 64 characters
store-keys
required
Array of strings[ items <= 64 characters ]
Array of objects (DashboardFilter)
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-forms

/v1/pathway-spec-forms/

query Parameters
filter[form-version-id]
string <uuid>
Example: filter[form-version-id]=11111111-1111-1111-1111-111111111111
filter[step-id]
string <uuid>
Example: filter[step-id]=11111111-1111-1111-1111-111111111111
filter[version-id]
string <uuid>
Example: filter[version-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-spec-forms/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-forms"
required
object
form-version-id
required
string <uuid>
version-id
required
string <uuid>
description
string <= 255 characters
step-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-forms/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-spec-forms/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-forms/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-forms"
required
object
description
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-groups

/v1/pathway-spec-groups/

query Parameters
spec-id
required
string <uuid>
Example: spec-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-spec-groups/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-groups"
required
object
group-id
required
string <uuid>
spec-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-groups/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-spec-groups/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-stages

/v1/pathway-spec-stages/

query Parameters
version-id
required
string <uuid>
Example: version-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-spec-stages/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-stages"
required
object
name
required
string [ 1 .. 200 ] characters ^[a-z0-9_-]+$
version-id
required
string <uuid>
allow-start
boolean
Default: false
description
string <= 255 characters
generate-event
boolean
Default: false
order
integer
Default: 0
title
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-stages/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-spec-stages/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-stages/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-stages"
required
object
allow-start
boolean
Default: false
description
string <= 255 characters
generate-event
boolean
name
string [ 1 .. 200 ] characters ^[a-z0-9_-]+$
order
integer
title
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-stages/{id}/add-link/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-stages/{id}/delete-link/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-steps

/v1/pathway-spec-steps/

query Parameters
stage-id
required
string <uuid>
Example: stage-id=11111111-1111-1111-1111-111111111111
filter[deferred]
boolean
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-spec-steps/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-steps"
required
object
name
required
string [ 1 .. 200 ] characters ^[a-z0-9_-]+$
stage-id
required
string <uuid>
type
required
string <= 64 characters
args
object
deferred
boolean
Default: false
description
string <= 255 characters
event-trigger-types
Array of strings
Items Enum: "init" "patch" "reminder" "set-state"
generate-event
boolean
necessity
string
Default: "o"
Enum: "e" "o" "r"
order
integer
Default: 0
title
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-steps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-spec-steps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-steps/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-steps"
required
object
args
object
deferred
boolean
description
string <= 255 characters
event-trigger-types
Array of strings
Items Enum: "init" "patch" "reminder" "set-state"
generate-event
boolean
name
string [ 1 .. 200 ] characters ^[a-z0-9_-]+$
necessity
string
Enum: "e" "o" "r"
order
integer
title
string <= 255 characters
type
string <= 64 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-version-loaders

/v1/pathway-spec-version-loaders/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-version-loaders"
required
object
method
required
string
Enum: "dump" "load"
version-id
required
string <uuid>
model
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-version-loaders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-versions

/v1/pathway-spec-versions/

query Parameters
spec-id
required
string <uuid>
Example: spec-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-spec-versions/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-versions"
required
object
spec-id
required
string <uuid>
description
string <= 255 characters
store-schema
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-versions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-spec-versions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-spec-versions/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-spec-versions"
required
object
description
string <= 255 characters
store-schema
object
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-specs

/v1/pathway-specs/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings
Default: "created"
Items Enum: "-created" "-name" "-version-name" "created" "name" "version-name"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-specs/

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-specs"
required
object
name
required
string <= 255 characters
organization-id
required
string <uuid>
allow-duplicate-instance
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-specs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/pathway-specs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-specs/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-specs"
required
object
allow-duplicate-instance
boolean
current-version-id
string <uuid>
name
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-step-types

/v1/pathway-step-types/

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/pathway-step-types/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/pathway-tasks

/v1/pathway-tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-designs

/v1/playground-designs/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/playground-designs/

Request Body schema: application/json
required
object
type
required
string
Value: "playground-designs"
required
object
name
required
string <= 255 characters
organization-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-designs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/playground-designs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-designs/{id}/download/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "interactions": { },
  • "workflow": { }
}

/v1/playground-designs/{id}/export/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
workflowtype-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "workflowtype-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-designs/{id}/import/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
workflowtype-id
required
string <uuid>
version
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "version": "string",
  • "workflowtype-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-designs/{id}/upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object
interactions
required
object
workflow
required
object

Responses

Request samples

Content type
application/json
{
  • "spec": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-designs/{id}/validate/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
realm-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "realm-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "failed-info": [
    ],
  • "success": true
}

/v1/playground-realms

/v1/playground-realms/

query Parameters
design-id
required
string <uuid>
Example: design-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/playground-realms/

Request Body schema: application/json
required
object
type
required
string
Value: "playground-realms"
required
object
design-id
required
string <uuid>
individual-id
required
string <uuid>
interaction-args
required
object
name
required
string <= 255 characters
user-id
required
string <uuid>
current-time
string <datetime>
description
string <= 255 characters
object
email
string <= 255 characters
first-name
string <= 255 characters
last-name
string <= 255 characters
locale
string <= 32 characters
locale-explicit
boolean
primary-individual-id
string <uuid>
tz
string <timezone>
tz-explicit
boolean
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-realms/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/playground-realms/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-realms/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "playground-realms"
required
object
current-time
string <datetime>
description
string <= 255 characters
interaction-args
object
name
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-simobjects

/v1/playground-simobjects/

query Parameters
simulation-id
required
string <uuid>
Example: simulation-id=11111111-1111-1111-1111-111111111111
filter[service]
string <= 16 characters
filter[type]
string <= 16 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/playground-simobjects/

Request Body schema: application/json
required
object
type
required
string
Value: "playground-simobjects"
required
object
content
required
object
service
required
string <= 16 characters
simulation-id
required
string <uuid>
type
required
string <= 16 characters
time
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-simobjects/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/playground-simobjects/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-simulations

/v1/playground-simulations/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[include-inactive]
boolean
Default: false
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/playground-simulations/

Request Body schema: application/json
required
object
type
required
string
Value: "playground-simulations"
required
object
profile-id
required
string <uuid>
realm-id
required
string <uuid>
name
string <= 255 characters
profile-version
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-simulations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/playground-simulations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-simulations/{id}/change-time/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
new-time
string <datetime>

Responses

Request samples

Content type
application/json
{
  • "new-time": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-simulations/{id}/start/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-simulations/{id}/stop/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-tx-actions

/v1/playground-tx-actions/

query Parameters
interaction-id
required
string <uuid>
Example: interaction-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/playground-tx-actions/

Request Body schema: application/json
required
object
type
required
string
Value: "playground-tx-actions"
required
object
interaction-id
required
string <uuid>
name
required
string <= 255 characters
type
required
string <= 255 characters
description
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-tx-actions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/playground-tx-actions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-tx-interactions

/v1/playground-tx-interactions/

query Parameters
design-id
required
string <uuid>
Example: design-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/playground-tx-interactions/

Request Body schema: application/json
required
object
type
required
string
Value: "playground-tx-interactions"
required
object
design-id
required
string <uuid>
name
required
string <= 255 characters
description
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-tx-interactions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/playground-tx-interactions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-tx-invocations

/v1/playground-tx-invocations/

query Parameters
interaction-id
required
string <uuid>
Example: interaction-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/playground-tx-invocations/

Request Body schema: application/json
required
object
type
required
string
Value: "playground-tx-invocations"
required
object
interaction-id
required
string <uuid>
name
required
string <= 255 characters
type
required
string <= 255 characters
description
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-tx-invocations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/playground-tx-invocations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-wf-events

/v1/playground-wf-events/

query Parameters
design-id
required
string <uuid>
Example: design-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/playground-wf-events/

Request Body schema: application/json
required
object
type
required
string
Value: "playground-wf-events"
required
object
design-id
required
string <uuid>
name
required
string <= 255 characters
display-name
string <= 255 characters
ui-order
integer
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-wf-events/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/playground-wf-events/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-wf-states

/v1/playground-wf-states/

query Parameters
design-id
required
string <uuid>
Example: design-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/playground-wf-states/

Request Body schema: application/json
required
object
type
required
string
Value: "playground-wf-states"
required
object
design-id
required
string <uuid>
name
required
string <= 255 characters
description
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-wf-states/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/playground-wf-states/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-wf-transitions

/v1/playground-wf-transitions/

query Parameters
state-id
required
string <uuid>
Example: state-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/playground-wf-transitions/

Request Body schema: application/json
required
object
type
required
string
Value: "playground-wf-transitions"
required
object
event-id
required
string <uuid>
next-state-id
required
string <uuid>
state-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/playground-wf-transitions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/playground-wf-transitions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/program-args-histories

/v1/program-args-histories/

query Parameters
program-id
required
string <uuid>
Example: program-id=11111111-1111-1111-1111-111111111111
filter[created-at][gte]
string <datetime>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings
Default: "-created-at"
Items Enum: "-created-at" "created-at"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/program-args-histories/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/program-configs

/v1/program-configs/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/program-configs/

Request Body schema: application/json
required
object
type
required
string
Value: "program-configs"
required
object
name
required
string <= 255 characters
organization-id
required
string <uuid>
apply-to-new-user
boolean
Default: false
args
object
billing-eligible-ccm
boolean
Default: false
billing-eligible-rpm
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/program-configs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/program-configs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/program-configs/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "program-configs"
required
object
apply
boolean
apply-to-new-user
boolean
args
object
billing-eligible-ccm
boolean
billing-eligible-rpm
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/program-configs/{id}/tick/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/program-logs

/v1/program-logs/

query Parameters
program-id
required
string <uuid>
Example: program-id=11111111-1111-1111-1111-111111111111
filter[data]
string <= 128 characters
Deprecated
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/program-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/program-stats

/v1/program-stats/

query Parameters
program-id
required
string <uuid>
Example: program-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/program-stats/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/programs

/v1/programs/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/programs/

Request Body schema: application/json
required
object
type
required
string
Value: "programs"
required
object
individual-id
required
string <uuid>
name
required
string <= 255 characters
organization-id
required
string <uuid>
args
object
auto-start
boolean
Default: false
billing-eligible-ccm
boolean
Default: false
billing-eligible-rpm
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/programs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/programs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/programs/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "programs"
required
object
args
object
billing-eligible-ccm
boolean
billing-eligible-rpm
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/programs/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

/v1/programs/{id}/start/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/programs/{id}/stop/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/purge-data

/v1/purge-data/

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/purge-data/

Request Body schema: application/json
required
object
type
required
string
Value: "system-purges"
required
object
entity-id
required
string <= 255 characters
entity-type
required
string
Enum: "individual" "organization" "user"
reference-id
required
string <= 255 characters
request-id
required
string <= 255 characters
archive
boolean
Default: false
property name*
additional property
any
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/replicators

/v1/replicators/

query Parameters
filter[classpath]
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/replicators/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers

/v1/sniffers/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/sniffers/

Request Body schema: application/json
required
object
type
required
string
Value: "sniffers"
required
object
user-id
required
string <uuid>
valid-until
required
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/tasks

/v1/tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/thinkific-accounts

/v1/thinkific-accounts/

query Parameters
filter[name]
string <= 255 characters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/thinkific-accounts/

Request Body schema: application/json
required
object
type
required
string
Value: "thinkific-accounts"
required
object
api-key
required
string <= 255 characters
name
required
string <= 255 characters
organization-id
required
string <uuid>
run-user-id
required
string <uuid>
subdomain
required
string <= 255 characters
base-url
string <= 255 characters
Default: "https://api.thinkific.com/api/public"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/thinkific-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/thinkific-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/thinkific-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "thinkific-accounts"
required
object
api-key
string <= 255 characters
base-url
string <= 255 characters
name
string <= 255 characters
run-user-id
string <uuid>
subdomain
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/thinkific-accounts/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/thinkific-accounts/{id}/setup/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

/v1/thinkific-calls

/v1/thinkific-calls/

Request Body schema: application/json
required
object
type
required
string
Value: "thinkific-calls"
required
object
account-id
required
string <uuid>
method
required
string
Enum: "delete" "get" "patch" "post"
path
required
string <= 64 characters
json
object
params
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/thinkific-calls/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/thinkific-courses

/v1/thinkific-courses/

query Parameters
account-id
required
string <uuid>
Example: account-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[last-modified-at][gt]
string <datetime>
filter[thinkific-id]
integer
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/thinkific-courses/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/thinkific-enrollments

/v1/thinkific-enrollments/

query Parameters
account-id
required
string <uuid>
Example: account-id=11111111-1111-1111-1111-111111111111
filter[course-id]
string <uuid>
Example: filter[course-id]=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[last-modified-at][gt]
string <datetime>
filter[step-id]
string <uuid>
Example: filter[step-id]=11111111-1111-1111-1111-111111111111
filter[thinkific-id]
integer
filter[thinkific-user-id]
string <uuid>
Example: filter[thinkific-user-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/thinkific-enrollments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/thinkific-users

/v1/thinkific-users/

query Parameters
account-id
required
string <uuid>
Example: account-id=11111111-1111-1111-1111-111111111111
filter[created-at][gt]
string <datetime>
filter[last-modified-at][gt]
string <datetime>
filter[thinkific-id]
integer
filter[user-id]
string <uuid>
Example: filter[user-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Items Enum: "-created-at" "-last-modified-at" "created-at" "last-modified-at"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/thinkific-users/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/thinkific-users/{id}/course-link/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/thinkific-users/{id}/get-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "short-url": "string",
  • "url": "string"
}

/v1/users

/v1/users/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/workflow-types

/v1/workflow-types/

query Parameters
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against last-modified-time. Specify [comparator][datetime]. Comparators supported <, >. Use multiple to build a bounded time frame.

filter[exclude-categories]
Array of strings[ items <= 255 characters ]
filter[include-categories]
Array of strings[ items <= 255 characters ]
filter[include-inactive]
boolean
Default: false
filter[name]
string <= 255 characters
filter[name][contains]
string <= 255 characters
filter[type]
string
Enum: "challenge" "other" "program" "referral"
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/workflow-types/

Request Body schema: application/json
required
object
type
required
string
Value: "workflow-types"
required
object
category
required
string <= 255 characters
name
required
string <= 255 characters
organization-id
required
string <uuid>
individual-group-id
string <uuid>
supports-unverified-users
boolean
Default: false
type
string
Default: "program"
Enum: "challenge" "other" "program" "referral"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/workflow-types/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/workflow-types/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/workflow-types/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "workflow-types"
required
Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com

Array
op
required
string
Enum: "add" "remove" "replace"
path
required
string <= 255 characters

Path in document to operate on. Starts with "/" which represents the root document

value
any
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/workflow-types/{id}/add-version/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
spec
required
object
name
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "spec": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "created-at": "string",
  • "created-by": "11111111-1111-1111-1111-111111111111",
  • "hash-id": "string",
  • "last-modified-at": "string",
  • "last-modified-by": "11111111-1111-1111-1111-111111111111",
  • "name": "string",
  • "spec": { }
}

/v1/workflow-types/{id}/get-metadata/

path Parameters
id
required
string

Resource identifier

query Parameters
name
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/v1/workflow-types/{id}/get-versions/

path Parameters
id
required
string

Resource identifier

query Parameters
name
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/workflows

/v1/workflows/

query Parameters
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against last-modified-time. Specify [comparator][datetime]. Comparators supported <, >. Use multiple to build a bounded time frame.

filter[exclude-categories]
Array of strings[ items <= 255 characters ]
filter[include-categories]
Array of strings[ items <= 255 characters ]
filter[include-inactive]
boolean
Default: false
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[user-metadata]
string <= 255 characters
filter[workflow-name]
string <= 255 characters
individual-id
string <uuid>
Deprecated
Example: individual-id=11111111-1111-1111-1111-111111111111

use filter[individual-id]

page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
user-metadata
string <= 255 characters
Deprecated

use filter[user-metadata]

workflow-name
string <= 255 characters
Deprecated

use filter[workflow-name]

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/workflows/

Request Body schema: application/json
required
object
type
required
string
Value: "workflows"
required
object
individual-id
required
string <uuid>
workflowtype-id
required
string <uuid>
interaction-args
object
parent-workflow-id
string <uuid>
simulation-args
object
user-metadata
any
version
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/workflows/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/workflows/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Inject an event into a particular workflow instanc

Inject an event into a particular workflow instance

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
event
required
string <= 255 characters
interaction-args
any

Responses

Request samples

Content type
application/json
{
  • "event": "string",
  • "interaction-args": null
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/workflows/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
created-after
string <uuid>
Example: created-after=11111111-1111-1111-1111-111111111111
filter[type]
string
Enum: "Action" "Exception" "FsmError" "FsmWarning" "InternalState" "StateChange"
level
string
Enum: "CRITICAL" "DEBUG" "ERROR" "INFO" "WARN"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}