Skip to main content
GET
/
api
/
v1
/
workflow_steps
/
{id}
Get a workflow step
curl --request GET \
  --url https://api.scholarlysoftware.com/api/v1/workflow_steps/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.scholarlysoftware.com/api/v1/workflow_steps/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.scholarlysoftware.com/api/v1/workflow_steps/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "workflow_step",
    "attributes": {
      "created_at": "<string>",
      "updated_at": "<string>",
      "name": "<string>",
      "key": "<string>",
      "position": 123
    },
    "relationships": {
      "definition": {
        "links": {
          "related": "<string>"
        },
        "meta": {},
        "data": {
          "type": "workflow_definition",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}
{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>"
}
]
}
{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<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

id
string
required

Query Parameters

include
string

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

Response

workflow step found

data
object
required