Appearance
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
| Header | Required | Description |
|---|---|---|
X-Api-Key or X_API_KEY | yes | API 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
| Field | Type | Description |
|---|---|---|
data | array<object> | Project collection visible to the authenticated user. |
Project object fields
| Field | Type | Description |
|---|---|---|
id | integer | Project identifier. |
label | string | Project label. |
name | string | null |
description | string | null |
longDescription | string | null |
keywords | string | null |
has_alerting | boolean | null |
has_autosentiment | boolean | null |
has_aisentiment | boolean | null |
has_image_cache | boolean | null |
has_engagement_updates | boolean | null |
archived | boolean | null |
tabs | array<object> | Project tabs. |
postCount | string | boolean |
userCount | integer | Number of users linked to the project. |
jobCount | integer | Number of active jobs linked to the project. |
Notes
- Admin users receive all projects; non-admin users receive only linked projects.