Get workflow

GET

https://api.sureshake.com/v2/directory/workflows/{id}

Path parameters

id
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- followRequestId
  string
  required
  format: uuid
- relationshipId
  string
  required
  format: uuid
- status
  queued
  or
  running
  or
  completed
  or
  partial
  or
  failed
  required
- counts
  object
  required
  attempted
  integer
  required
  minimum: 0
  succeeded
  integer
  required
  minimum: 0
  failed
  integer
  required
  minimum: 0
  skipped
  integer
  required
  minimum: 0
- fatalError
  string
  or null
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- completedAt
  string
  or null
  required
  format: date-time
- grants
  array of
  object
  required
  id
  string
  required
  format: uuid
  collectionId
  string
  required
  format: uuid
  status
  pending
  or
  active
  or
  failed
  or
  expired
  or
  revoked
  required
  expiresAt
  string
  or null
  required
  format: date-time
  tokenId
  string
  or null
  required
  transactionHash
  string
  or null
  required
  revocationTransactionHash
  string
  or null
  required
  error
  string
  or null
  required
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Get workflow

curl --request GET \
  --url 'https://api.sureshake.com/v2/directory/workflows/<id>'

const url = 'https://api.sureshake.com/v2/directory/workflows/<id>';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "followRequestId": "dec11372-5401-4d80-a198-f2d8f9ab62bf",
    "relationshipId": "928dd5b8-3ead-4528-bdef-9c0b867a5d7d",
    "status": "queued",
    "counts": {
      "attempted": 0,
      "succeeded": 0,
      "failed": 0,
      "skipped": 0
    },
    "fatalError": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z",
    "grants": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
        "status": "pending",
        "expiresAt": "2019-08-24T14:15:22Z",
        "tokenId": "string",
        "transactionHash": "string",
        "revocationTransactionHash": "string",
        "error": "string"
      }
    ]
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}