OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users(3)

NAME
OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users - Documentation for the /organization/projects/{project_id}/users path.

DESCRIPTION
This document describes the API endpoint at "/organization/projects/{project_id}/users".

PATHS

  "GET /organization/projects/{project_id}/users"
Returns a list of users in the project.

Operation ID

"list-project-users"

    $client->list-project-users( ... );

Parameters

•   "project_id" (in path) (Required) - The ID of the project.

    Type: "string"

•   "limit" (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

    Type: "integer"

    Default: 20

•   "after" (in query) (Optional) - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

    Type: "string"

Responses

Status Code: 200

Project users listed successfully.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "data" : [
              "{\n    \"object\": \"organization.project.user\",\n    \"id\": \"user_abc\",\n    \"name\": \"First Last\",\n    \"email\": \"user@example.com\",\n    \"role\": \"owner\",\n    \"added_at\": 1711471533\n}\n"
           ]
        }

Status Code: 400

Error response when project is archived.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "error" : null
        }

  "POST /organization/projects/{project_id}/users"
Adds a user to the project. Users must already be members of the organization to be added to a project.

Operation ID

"create-project-user"

    $client->create-project-user( ... );

Parameters

•   "project_id" (in path) (Required) - The ID of the project.

    Type: "string"

Request Body

Content Type: "application/json"

Responses

Status Code: 200

User added to project successfully.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
            "object": "organization.project.user",
            "id": "user_abc",
            "name": "First Last",
            "email": "user@example.com",
            "role": "owner",
            "added_at": 1711471533
        }

Status Code: 400

Error response for various conditions.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "error" : null
        }

SEE ALSO
OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.