Skip to main content
GET
/
api
/
v1
/
workflow_cases
/
{workflow_case_id}
/
workflow_responses
List workflow responses for a workflow case
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/workflow_cases/{workflow_case_id}/workflow_responses \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "workflow_response",
      "attributes": {
        "created_at": "<string>",
        "updated_at": "<string>",
        "step_name": "<string>",
        "completed_at": "<string>",
        "sections": "<array>"
      },
      "relationships": {
        "candidate": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "profile",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "workflow_case": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "workflow_case",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "workflow": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "workflow",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "workflow_group": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": {
            "type": "workflow_group",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "assignees": {
          "links": {
            "related": "<string>"
          },
          "meta": {},
          "data": [
            {
              "type": "user",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "page": {
      "size": 123
    },
    "total": 123
  },
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "last": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required

Bearer token

Path Parameters

​
workflow_case_id
string
required

Query Parameters

​
include
string

Comma-separated list of relationships to include. Allowed: candidate, workflow_case, workflow, workflow_group, assignees

​
sort
string

Sort order. Prefix with - for descending. Allowed: created_at, updated_at, completed_at

​
filter[key]
string

Filter results. Available filters: candidate, candidate.exists, workflow_case, step, step.exists, workflow, workflow.exists, workflow_group, workflow_group.exists.

​
page[size]
integer

Number of items per page (max 100)

​
page[after]
string

Cursor for next page

​
page[before]
string

Cursor for previous page

Response

workflow responses found

​
data
object[]
required
​
meta
object
​
links
object