Skip to content

project/single

Returns one project with aggregate counters.

Method and path

GET /project/single/{project_id}

Authentication

Authentication is required. See Authentication.

Permissions

Accessible to tiers 1, 2, 3, and 4.

Request headers

HeaderRequiredDescription
X-Api-Key or X_API_KEYyesAPI key.

Path parameters

ParameterTypeRequiredDescription
project_idintegeryesProject identifier.

Example request

bash
curl "$SIGNAL_API_BASE_URL/project/single/<project_id>" \
  -H "X-Api-Key: $SIGNAL_API_KEY"

Example response

json
{
  "data": [
    {
      "id": 123,
      "name": "Example Project",
      "label": "example_project",
      "description": "Project used in API examples",
      "has_alerting": 1,
      "masterindex_threshold": 0,
      "has_autosentiment": 0,
      "has_engagement_updates": 1,
      "posts": "1.2K",
      "posts_numeric": 1200,
      "thumbnail": "https://cdn.example.com/example-thumbnail.jpg",
      "jobs": 3,
      "users": 5
    }
  ]
}

Response fields

FieldTypeDescription
dataarray<object>Single-item array containing the project payload.

Project object fields

FieldTypeDescription
idintegerProject identifier.
namestringnull
labelstringnull
descriptionstringnull
has_alertingintegerboolean
masterindex_thresholdintegernull
has_autosentimentintegerboolean
has_engagement_updatesintegerboolean
postsstringinteger
posts_numericintegerNumeric posts count.
thumbnailstringThumbnail URL or placeholder path.
jobsintegerNumber of linked jobs.
usersintegerNumber of linked users.

Notes

  • The endpoint returns one project object inside data, not as a top-level object.

Doc rev.1.12.3 2026.05.08