---
title: "Get workflow"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › directory

`GET /v2/directory/workflows/{id}`

## Path parameters

- `id` (`directory-get-workflow.path.id`; string, required)
  - format `uuid`

## Code samples

### cURL

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

### TypeScript

```typescript
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));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/directory/workflows/<id>"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "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"
  }
}
```

- `data` (`directory-get-workflow.response.200.data`; object, required)
  - `id` (`directory-get-workflow.response.200.data.id`; string, required)
    - format `uuid`
  - `followRequestId` (`directory-get-workflow.response.200.data.followRequestId`; string, required)
    - format `uuid`
  - `relationshipId` (`directory-get-workflow.response.200.data.relationshipId`; string, required)
    - format `uuid`
  - `status` (`directory-get-workflow.response.200.data.status`; string, required)
    - one of `"queued"`, `"running"`, `"completed"`, `"partial"`, `"failed"`
  - `counts` (`directory-get-workflow.response.200.data.counts`; object, required)
    - `attempted` (`directory-get-workflow.response.200.data.counts.attempted`; integer, required)
      - min 0
    - `succeeded` (`directory-get-workflow.response.200.data.counts.succeeded`; integer, required)
      - min 0
    - `failed` (`directory-get-workflow.response.200.data.counts.failed`; integer, required)
      - min 0
    - `skipped` (`directory-get-workflow.response.200.data.counts.skipped`; integer, required)
      - min 0
  - `fatalError` (`directory-get-workflow.response.200.data.fatalError`; string, required, nullable)
  - `createdAt` (`directory-get-workflow.response.200.data.createdAt`; string, required)
    - format `date-time`
  - `updatedAt` (`directory-get-workflow.response.200.data.updatedAt`; string, required)
    - format `date-time`
  - `completedAt` (`directory-get-workflow.response.200.data.completedAt`; string, required, nullable)
    - format `date-time`
  - `grants` (`directory-get-workflow.response.200.data.grants`; array<object>, required)
    - `id` (`directory-get-workflow.response.200.data.grants.id`; string, required)
      - format `uuid`
    - `collectionId` (`directory-get-workflow.response.200.data.grants.collectionId`; string, required)
      - format `uuid`
    - `status` (`directory-get-workflow.response.200.data.grants.status`; string, required)
      - one of `"pending"`, `"active"`, `"failed"`, `"expired"`, `"revoked"`
    - `expiresAt` (`directory-get-workflow.response.200.data.grants.expiresAt`; string, required, nullable)
      - format `date-time`
    - `tokenId` (`directory-get-workflow.response.200.data.grants.tokenId`; string, required, nullable)
    - `transactionHash` (`directory-get-workflow.response.200.data.grants.transactionHash`; string, required, nullable)
    - `revocationTransactionHash` (`directory-get-workflow.response.200.data.grants.revocationTransactionHash`; string, required, nullable)
    - `error` (`directory-get-workflow.response.200.data.grants.error`; string, required, nullable)
- `meta` (`directory-get-workflow.response.200.meta`; object, optional)
  - `timestamp` (`directory-get-workflow.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

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

- `error` (`directory-get-workflow.response.400.error`; object, required)
  - `code` (`directory-get-workflow.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-workflow.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-workflow.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-workflow.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

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

- `error` (`directory-get-workflow.response.401.error`; object, required)
  - `code` (`directory-get-workflow.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-workflow.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-workflow.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-workflow.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

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

- `error` (`directory-get-workflow.response.403.error`; object, required)
  - `code` (`directory-get-workflow.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-workflow.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-workflow.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-workflow.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

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

- `error` (`directory-get-workflow.response.404.error`; object, required)
  - `code` (`directory-get-workflow.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-workflow.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-workflow.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-workflow.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

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

- `error` (`directory-get-workflow.response.409.error`; object, required)
  - `code` (`directory-get-workflow.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-workflow.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-workflow.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-workflow.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

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

- `error` (`directory-get-workflow.response.429.error`; object, required)
  - `code` (`directory-get-workflow.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-workflow.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-workflow.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-workflow.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

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

- `error` (`directory-get-workflow.response.500.error`; object, required)
  - `code` (`directory-get-workflow.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-workflow.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-workflow.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-workflow.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

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

- `error` (`directory-get-workflow.response.503.error`; object, required)
  - `code` (`directory-get-workflow.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-get-workflow.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`directory-get-workflow.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-get-workflow.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/directory-get-workflow/index.md