# List Projects

Retrieves a list of projects from the inventory.

Endpoint: POST /core.project.listProjects
Security: oauth2

## Request fields (application/json):

  - `params` (object)

  - `params.filter` (object)
    Defines all required and optional filter parameters for the operation.

  - `params.pagination` (object)
    Defines all required and optional pagination parameters for the operation.

  - `params.pagination.limit` (integer)
    The number of elements to be returned
    Example: 20

  - `params.pagination.after` (string)
    The cursor to retrieve the next page. This is an opaque value that should not be interpreted by the client.
    Example: "aBc="

## Response 200 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful.
    Example: true

  - `result` (object)
    Contains the response data of a successful request.

  - `result.projects` (array)

  - `result.projects.id` (string)
    The unique identifier of the project
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `result.projects.name` (string)
    The name of the project
    Example: "Blend Experiments 2024"

  - `result.projects.description` (string)
    A description of the project
    Example: "This project contains all experiments for new blends in 2024"

  - `meta` (object)
    Contains the metadata (e.g. pagination information) of the response.

  - `meta.pagination` (object)
    Represents the pagination fields of the response.

  - `meta.pagination.endCursor` (string)
    Cursor value to retrieve the records of the next page. If there no further pages, this value is null.
    Example: "aBc="

## Response 400 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful or not

  - `error` (object)

  - `error.code` (string)
    Specifies error code that can be handled programmatically.
    Example: "invalid_parameter"

  - `error.message` (string)
    A detailed description of the occurred error.
    Example: "Invalid parameter provided"

## Response 401 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful or not

  - `error` (object)

  - `error.code` (string)
    Specifies error code that can be handled programmatically.
    Example: "invalid_parameter"

  - `error.message` (string)
    A detailed description of the occurred error.
    Example: "Invalid parameter provided"

## Response 403 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful or not

  - `error` (object)

  - `error.code` (string)
    Specifies error code that can be handled programmatically.
    Example: "invalid_parameter"

  - `error.message` (string)
    A detailed description of the occurred error.
    Example: "Invalid parameter provided"

## Response 422 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful or not

  - `error` (object)

  - `error.code` (string)
    Specifies error code that can be handled programmatically.
    Example: "invalid_parameter"

  - `error.message` (string)
    A detailed description of the occurred error.
    Example: "Invalid parameter provided"

## Response 500 fields (application/json):

  - `ok` (boolean)
    Indicates whether the request was successful or not

  - `error` (object)

  - `error.code` (string)
    Specifies error code that can be handled programmatically.
    Example: "invalid_parameter"

  - `error.message` (string)
    A detailed description of the occurred error.
    Example: "Invalid parameter provided"