Skip to content

project/all

Lists projects available to the authenticated user.

Method and path

GET /project/all

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.

Example request

bash
curl "$SIGNAL_API_BASE_URL/project/all" \
  -H "X-Api-Key: $SIGNAL_API_KEY"

Example response

json
{
  "data": [
    {
      "id": 123,
      "label": "example_project",
      "name": "Example Project",
      "description": "Project used in API examples",
      "longDescription": null,
      "keywords": null,
      "has_alerting": true,
      "has_autosentiment": false,
      "has_aisentiment": false,
      "has_image_cache": false,
      "has_engagement_updates": true,
      "archived": false,
      "tabs": [],
      "postCount": "1.2K",
      "userCount": 5,
      "jobCount": 3
    }
  ]
}

Response fields

FieldTypeDescription
dataarray<object>Project collection visible to the authenticated user.

Project object fields

FieldTypeDescription
idintegerProject identifier.
labelstringProject label.
namestringnull
descriptionstringnull
longDescriptionstringnull
keywordsstringnull
has_alertingbooleannull
has_autosentimentbooleannull
has_aisentimentbooleannull
has_image_cachebooleannull
has_engagement_updatesbooleannull
archivedbooleannull
tabsarray<object>Project tabs.
postCountstringboolean
userCountintegerNumber of users linked to the project.
jobCountintegerNumber of active jobs linked to the project.

Notes

  • Admin users receive all projects; non-admin users receive only linked projects.

Doc rev.1.12.3 2026.05.08