/ 
OpenAPI-Client-OpenAI-0.28
⭐ Starred 7 / OpenAPI::Client::OpenAI::Path::organization-projects-project_id-users

NAME

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

OPERATIONS

GET /organization/projects/{project_id}/users

list-project-users

$client->list_project_users({
    body => { ... },
});

Returns a list of users in the project.

Path/query parameters

  • project_id (in path, required, string) - The ID of the project.

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

    Default: 20

  • after (in query, optional, string) - 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.

Responses

200 - Project users listed successfully.

Content-Type: application/json

Example:

{
   "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"
   ],
   "first_id" : "string",
   "has_more" : false,
   "last_id" : "string",
   "object" : "string"
}

400 - Error response when project is archived.

Content-Type: application/json

Example:

{
   "error" : {
      "code" : "string",
      "message" : "string",
      "param" : "string",
      "type" : "string"
   }
}

POST /organization/projects/{project_id}/users

create-project-user

$client->create_project_user({
    body => { ... },
});

Adds a user to the project. Users must already be members of the organization to be added to a project.

Path/query parameters

  • project_id (in path, required, string) - The ID of the project.

Responses

200 - User added to project successfully.

Content-Type: application/json

Example:

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

400 - Error response for various conditions.

Content-Type: application/json

Example:

{
   "error" : {
      "code" : "string",
      "message" : "string",
      "param" : "string",
      "type" : "string"
   }
}

SCHEMAS

Error

Properties:

  • code (anyOf, required)

  • message (string, required)

  • param (anyOf, required)

  • type (string, required)

ErrorResponse

Properties:

  • error (Error, required)

    See "Error" below for shape.

ProjectUser

Properties:

  • added_at (integer, required) - The Unix timestamp (in seconds) of when the project was added.

  • email (anyOf) - The email address of the user

  • id (string, required) - The identifier, which can be referenced in API endpoints

  • name (anyOf) - The name of the user

  • object (string, required) - The object type, which is always organization.project.user

    Allowed values: organization.project.user

  • role (string, required) - owner or member

ProjectUserCreateRequest

Properties:

  • email (anyOf) - Email of the user to add.

  • role (string, required) - owner or member

  • user_id (anyOf) - The ID of the user.

ProjectUserListResponse

Properties:

  • data (array of ProjectUser, required)

  • first_id (anyOf)

  • has_more (boolean, required)

  • last_id (anyOf)

  • object (string, required)

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2026 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.