Retrieve Project

curl --request GET \
  --url https://api.teleskop.dev/projects/{id} \
  --header 'x-api-key: <api-key>'

{
  "status": "success",
  "statusCode": 200,
  "data": {
    "name": "Turkish Airlines",
    "languages": [
      "tr",
      "en"
    ],
    "channels": [
      "news",
      "twitter"
    ],
    "keywords": [
      {
        "main_keyword": "Turkish Airlines",
        "required_keywords": [
          "Istanbul Airport"
        ],
        "excluded_keywords": [
          "Sabiha Gökçen"
        ],
        "id": "c167d51e-7249-4430-a13e-043eab185b58"
      }
    ],
    "id": "c0bb3b48-60eb-4afe-a229-3207e7ad800a",
    "keywords_count": 1,
    "creator_id": "a76ea981-f007-44e6-b4d7-2dbdc61ce338",
    "workspace_id": "2cca4ace-63a0-41f0-a73f-0b8abe2909a5",
    "workspace_name": "My Organization",
    "created_at": "2025-07-29T13:37:12.547Z",
    "updated_at": "2025-07-29T13:37:12.547Z",
    "members_ids": []
  },
  "message": "Request successful",
  "metadata": {}
}

GET

projects

{id}

Retrieve Project

curl --request GET \
  --url https://api.teleskop.dev/projects/{id} \
  --header 'x-api-key: <api-key>'

{
  "status": "success",
  "statusCode": 200,
  "data": {
    "name": "Turkish Airlines",
    "languages": [
      "tr",
      "en"
    ],
    "channels": [
      "news",
      "twitter"
    ],
    "keywords": [
      {
        "main_keyword": "Turkish Airlines",
        "required_keywords": [
          "Istanbul Airport"
        ],
        "excluded_keywords": [
          "Sabiha Gökçen"
        ],
        "id": "c167d51e-7249-4430-a13e-043eab185b58"
      }
    ],
    "id": "c0bb3b48-60eb-4afe-a229-3207e7ad800a",
    "keywords_count": 1,
    "creator_id": "a76ea981-f007-44e6-b4d7-2dbdc61ce338",
    "workspace_id": "2cca4ace-63a0-41f0-a73f-0b8abe2909a5",
    "workspace_name": "My Organization",
    "created_at": "2025-07-29T13:37:12.547Z",
    "updated_at": "2025-07-29T13:37:12.547Z",
    "members_ids": []
  },
  "message": "Request successful",
  "metadata": {}
}

Authorizations

x-api-key

string

header

required

API Key for authentication

Path Parameters

string

required

Response

200 - application/json

Project retrieved successfully

status

enum<string>

required

Response status

Available options:

success,

error

Example:

"success"

statusCode

number

required

HTTP status code

Example:

200

data

object

required

Response data

Show child attributes

data.name

string

required

Display name of the project

Example:

"Turkish Airlines"

data.languages

string[]

required

Selected languages for this project

Example:

["tr", "en"]

data.channels

string[]

required

Selected channels for this project

Example:

["news", "twitter"]

data.keywords

object[]

required

Array of keyword objects, each containing main_keyword, required_keywords, and excluded_keywords.

Show child attributes

data.keywords.main_keyword

string

required

The main keyword (minimum length 3).

Example:

"Turkish Airlines"

data.keywords.required_keywords

string[]

required

Array of required keywords (minimum length per item 3).

Example:

["Istanbul Airport"]

data.keywords.excluded_keywords

string[]

required

Array of excluded keywords (minimum length per item 3).

Example:

["Sabiha Gökçen"]

data.keywords.id

string

Example:

"c167d51e-7249-4430-a13e-043eab185b58"

data.id

string

required

Project ID

Example:

"c0bb3b48-60eb-4afe-a229-3207e7ad800a"

data.keywords_count

number

required

Keywords count of the project

Example:

1

data.creator_id

object

required

Creator ID

Example:

"a76ea981-f007-44e6-b4d7-2dbdc61ce338"

data.workspace_id

object

required

Workspace ID

Example:

"2cca4ace-63a0-41f0-a73f-0b8abe2909a5"

data.workspace_name

object

required

Name of the workspace

Example:

"My Organization"

data.created_at

string<date-time>

required

Creator ID

Example:

"2025-07-29T13:37:12.547Z"

data.updated_at

string<date-time>

required

Creator ID

Example:

"2025-07-29T13:37:12.547Z"

data.members_ids

string[]

message

string

required

Response message

Example:

"Request successful"

metadata

object

Additional metadata

Create Project Update Project

⌘I

API Reference

Channels

Projects

Posts

Labels

Retrieve Project

Authorizations

Path Parameters

Response