Navigation

Projects

Note

Groups and projects are synonymous terms. Your {PROJECT-ID} is the same as your project id. For existing groups, your group/project id remains the same. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

Endpoints

Manage Project Endpoints

Method Endpoint Description
GET /groups Get All Projects for the Current User
GET /groups/{PROJECT-ID} Get One Project by Its ID
GET /groups/byName/{GROUP-NAME} Get One Project by Its Name
GET /groups/byAgentApiKey/{AGENT-API-KEY} Get One Project by Its Agent API Key
POST /groups Create One Project
PATCH /groups/{PROJECT-ID}/ Update One Project
DELETE /groups/{PROJECT-ID} Delete One Project

Manage Users in One Project Endpoints

Method Endpoint Description
GET /groups/{PROJECT-ID}/users Get All Users in One Project
POST /groups/{PROJECT-ID}/users Add Users to One Project
DELETE /groups/{PROJECT-ID}/users/{USER-ID} Remove One User from One Project