1. Project Access
Apidog API
  • Introduction
  • API Versions
  • Authentication
  • Import & Export
    • Import OpenAPI/Swagger Data
      POST
    • Import Postman Collection Data
      POST
    • Export Data in OpenAPI/Swagger Format
      POST
  • Team Access Grants
    • Assign a team role via the external API
      POST
  • Project Access
    • Find Team Projects by Exact Match
      GET
    • Find Accessible Teams by Exact Match
      GET
    • Grant or Invite Project Access
      POST
    • List Available Project Roles for a Team
      GET
  • Organization Teams
    • Create organization team
      POST
  • Schemas
    • TeamRole
    • ErrorResponse
    • ProjectAccessMode
    • CreateTeamAccessGrantRequest
    • TeamAccessGrant
    • CreateTeamAccessGrantResponse
  1. Project Access

List Available Project Roles for a Team

GET
/v1/teams/{teamId}/project-roles
Returns built-in and existing custom project roles available in the specified team. Built-in roles are available for general-purpose collaboration. Creating and managing custom project roles is an Enterprise feature; organizations without an Enterprise plan cannot create custom roles. Existing custom roles are listed when they exist for the team, and the caller must be a Team Administrator. This endpoint lists roles and does not create or modify them.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Path Params

Query Params

Header Params

Responses

🟢200
application/json
Returns the built-in and custom project roles available for grants in the team.
Bodyapplication/json

🟠401
🟠403
🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.apidog.com/v1/teams/41/project-roles?locale=en-US' \
--header 'X-Apidog-Api-Version: 2026-05-28' \
--header 'X-Apidog-Api-Version: 2024-03-28' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success
{
    "success": true,
    "data": [
        {
            "name": "Admin",
            "builtIn": true,
            "role": "admin"
        },
        {
            "name": "Reviewer",
            "builtIn": false,
            "customProjectRoleId": 101
        }
    ]
}
Modified at 2026-09-01 06:21:01
Previous
Grant or Invite Project Access
Next
Create organization team
Built with