Skip to main content
GET
/
api
/
v1
/
workflows
/
{id}
Get a workflow
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/workflows/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "workflow",
    "attributes": {
      "name": "<string>",
      "begins_on": "2023-12-25",
      "ends_on": "2023-12-25",
      "evaluation_period_start": "2023-12-25",
      "evaluation_period_end": "2023-12-25",
      "category": "<string>",
      "draft_mode": true,
      "archived_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "relationships": {
      "department": {
        "links": {
          "related": "<string>"
        },
        "meta": {},
        "data": {
          "type": "department",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}

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

Query Parameters

​
include
string

Comma-separated list of relationships to include. Allowed: department

Response

workflow found

​
data
object
required