Skip to main content
GET
/
api
/
v1
/
workflow_responses
/
{id}
Get a specific workflow response
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/workflow_responses/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "workflow_response",
    "attributes": {
      "step_name": "<string>",
      "completed_at": "<string>",
      "sections": [
        "<any>"
      ]
    },
    "relationships": {
      "candidate": {
        "data": {
          "type": "profile",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "links": {
          "related": "<string>"
        },
        "meta": {}
      },
      "workflow_case": {
        "data": {
          "type": "workflow_case",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "links": {
          "related": "<string>"
        },
        "meta": {}
      },
      "workflow": {
        "data": {
          "type": "workflow",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "links": {
          "related": "<string>"
        },
        "meta": {}
      },
      "workflow_group": {
        "data": {
          "type": "workflow_group",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "links": {
          "related": "<string>"
        },
        "meta": {}
      },
      "assignees": {
        "data": [
          {
            "type": "user",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "links": {
          "related": "<string>"
        },
        "meta": {}
      }
    }
  }
}

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

id
string
required

Workflow Response ID

Response

workflow response accessible by profile owner

data
object
required
I