Skip to main content
GET
/
project
/
{projectId}
Retrieve a project
curl --request GET \
  --url https://app.myhero.so/project/{projectId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "_id": "<string>",
    "userId": "<string>",
    "workspaceId": "<string>",
    "name": "<string>",
    "createdAt": 123,
    "updatedAt": 123,
    "originId": "<string>",
    "icon": {
      "name": "<string>",
      "color": "<string>"
    },
    "emoji": {
      "unified": "<string>",
      "emojiStyle": "<string>"
    },
    "reference": "<string>",
    "description": "<string>",
    "published": [
      {
        "slug": "<string>",
        "domain": "<string>",
        "homepage": "<string>",
        "password": "<string>",
        "disabled": true
      }
    ],
    "publishedBranding": {
      "company": {
        "name": "<string>",
        "logo": "<string>",
        "url": "<string>"
      },
      "callToAction": {
        "icon": {
          "name": "<string>",
          "color": "<string>"
        },
        "text": "<string>",
        "url": "<string>"
      }
    }
  }
}

Authorizations

Authorization
string
header
required

HERO personal access token

Path Parameters

projectId
string
required
Minimum string length: 1

Response

200 response

data
object
required