---
title: "Get publish status"
---

> 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 › reports

`GET /v2/reports/{id}/publish`

## Path parameters

- `id` (`report-get-publish-status.path.id`; string, required)
  - format `uuid`

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/reports/<id>/publish';
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/reports/<id>/publish"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "isPublic": true,
    "status": "string",
    "hasIpfsHash": true,
    "tags": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "visibility": "private",
        "createdBy": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "publishedAt": "string",
    "canPublish": true,
    "publishRequirements": {
      "hasIpfsHash": true,
      "isOwner": true,
      "hasRegisteredAgentIdentity": true,
      "agentIdentityStatus": "not_started",
      "agentIdentityFailurePublicMessage": "string"
    }
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`report-get-publish-status.response.200.data`; object, required)
  - `isPublic` (`report-get-publish-status.response.200.data.isPublic`; boolean, required)
  - `status` (`report-get-publish-status.response.200.data.status`; string, required)
  - `hasIpfsHash` (`report-get-publish-status.response.200.data.hasIpfsHash`; boolean, required)
  - `tags` (`report-get-publish-status.response.200.data.tags`; array<object>, required)
    - `id` (`report-get-publish-status.response.200.data.tags.id`; string, required)
      - format `uuid`
    - `name` (`report-get-publish-status.response.200.data.tags.name`; string, required)
    - `visibility` (`report-get-publish-status.response.200.data.tags.visibility`; string, required)
      - one of `"private"`, `"public"`
    - `createdBy` (`report-get-publish-status.response.200.data.tags.createdBy`; string, required)
    - `createdAt` (`report-get-publish-status.response.200.data.tags.createdAt`; string, required)
      - format `date-time`
    - `updatedAt` (`report-get-publish-status.response.200.data.tags.updatedAt`; string, required)
      - format `date-time`
  - `publishedAt` (`report-get-publish-status.response.200.data.publishedAt`; string, required, nullable)
  - `canPublish` (`report-get-publish-status.response.200.data.canPublish`; boolean, required)
  - `publishRequirements` (`report-get-publish-status.response.200.data.publishRequirements`; object, required)
    - `hasIpfsHash` (`report-get-publish-status.response.200.data.publishRequirements.hasIpfsHash`; boolean, required)
    - `isOwner` (`report-get-publish-status.response.200.data.publishRequirements.isOwner`; boolean, required)
    - `hasRegisteredAgentIdentity` (`report-get-publish-status.response.200.data.publishRequirements.hasRegisteredAgentIdentity`; boolean, required)
    - `agentIdentityStatus` (`report-get-publish-status.response.200.data.publishRequirements.agentIdentityStatus`; string, required)
      - one of `"not_started"`, `"queued"`, `"pending_tx"`, `"registered"`, `"failed"`
    - `agentIdentityFailurePublicMessage` (`report-get-publish-status.response.200.data.publishRequirements.agentIdentityFailurePublicMessage`; string, required, nullable)
- `meta` (`report-get-publish-status.response.200.meta`; object, optional)
  - `timestamp` (`report-get-publish-status.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

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

- `error` (`report-get-publish-status.response.400.error`; object, required)
  - `code` (`report-get-publish-status.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-publish-status.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-publish-status.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-publish-status.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` (`report-get-publish-status.response.401.error`; object, required)
  - `code` (`report-get-publish-status.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-publish-status.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-publish-status.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-publish-status.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` (`report-get-publish-status.response.403.error`; object, required)
  - `code` (`report-get-publish-status.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-publish-status.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-publish-status.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-publish-status.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` (`report-get-publish-status.response.404.error`; object, required)
  - `code` (`report-get-publish-status.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-publish-status.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-publish-status.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-publish-status.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

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

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


Source: https://docs.sureshake.com/reference/report-get-publish-status/index.md