Appearance
project endpoints
Reference for the /project endpoint family.
What is a project?
A project is the main organizational unit in Signal. All collected posts, tags, jobs, dashboards, and users are scoped to a project. A project has a unique identifier (id) and a unique lowercase label (label) used throughout the API.
Projects can optionally enable features such as alerting, engagement refresh, and auto-sentiment.
Scope
The /project family manages:
- project creation and updates
- project listing and single project detail
- project-job associations
- project-user associations
- project-scoped tag and tag folder reads
Authentication
Authentication is required. See Authentication.
Permissions
Permissions are tier-based and depend on the specific endpoint.
| Endpoint group | Minimum tier |
|---|---|
project/new | 2 (Superuser) |
project/edit | 2 (Superuser) |
project/addjob, project/removejob | 2 (Superuser) |
project/adduser, project/removeuser | 2 (Superuser) |
project/all, project/single | 4 (User) |
project/tags, project/tag, project/tagfolders, project/users | 4 (User) |
Endpoints
- project/new — create a project
- project/edit — update a project
- project/all — list all accessible projects
- project/single — get one project by id
- project/addjob — associate a job with a project
- project/removejob — remove a job association
- project/adduser — grant a user access to a project
- project/removeuser — revoke user access
- project/tags — list tags for a project
- project/tag — get one tag for a project
- project/tagfolders — list tag folders for a project
- project/users — list users with access to a project
Notes
- For tag create, update, delete, and tagging-rule management, see tag endpoints.
- This section documents only V2 paths (
/v2/...).