List Projects

Endpoint

GET /apiops/projects/

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

None

Query Parameters

None

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "default",
      "description": "description text",
      "relativePath": "/default",
      "enableRelativePath": true,
      "tags": ["core"]
    },
    {
      "id": "507f1f77bcf86cd799439012",
      "name": "MyProject",
      "description": "My project description",
      "relativePath": "/my-project",
      "enableRelativePath": false,
      "tags": []
    }
  ],
  "resultCount": 2
}

Response Fields

Field	Type	Description
status	string	Response status: SUCCESS or FAILURE
resultList	array	List of project objects
resultCount	integer	Total number of projects returned

Project Object Fields

Field	Type	Description
id	string	Unique project identifier
name	string	Project name
description	string	Project description
relativePath	string	Relative path prefix configured for the project
enableRelativePath	boolean	Whether the relative path is enabled for routing
tags	array	List of tag strings assigned to the project

EnumStatus

• SUCCESS - Operation successful
• FAILURE - Operation failed

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Token is not valid!"
}

Causes

• Missing or invalid Authorization header
• Token expired or revoked
• Invalid token format

Error Response (500 Internal Server Error)

{
  "status": "FAILURE",
  "resultMessage": "An unexpected error occurred"
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Full JSON Body Example

This endpoint does not require a request body.

Notes and Warnings

• Filtered Results: Only projects where the user is a member are returned
• Permissions: Project access is based on user membership and roles
• Empty List: If the user has no projects, an empty resultList is returned
• Case Sensitivity: Project names are case-sensitive

Related Documentation

• Authentication Guide - How to obtain and use API tokens
• Error Handling - Error response formats