OpenAPI::Client::OpenAI::Path::organization-invites(3)

NAME
OpenAPI::Client::OpenAI::Path::organization-invites - Documentation for the /organization/invites path.

DESCRIPTION
This document describes the API endpoint at "/organization/invites".

PATHS

  "GET /organization/invites"
Returns a list of invites in the organization.

Operation ID

"list-invites"

    $client->list-invites( ... );

Parameters

•   "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

Invites 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.invite\",\n  \"id\": \"invite-abc\",\n  \"email\": \"user@example.com\",\n  \"role\": \"owner\",\n  \"status\": \"accepted\",\n  \"invited_at\": 1711471533,\n  \"expires_at\": 1711471533,\n  \"accepted_at\": 1711471533,\n  \"projects\": [\n    {\n      \"id\": \"project-xyz\",\n      \"role\": \"member\"\n    }\n  ]\n}\n"
           ]
        }

  "POST /organization/invites"
Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.

Operation ID

"inviteUser"

    $client->inviteUser( ... );

Parameters

Request Body

Content Type: "application/json"

Example:

    {
       "projects" : [
          null
       ]
    }

Responses

Status Code: 200

User invited 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.invite",
          "id": "invite-abc",
          "email": "user@example.com",
          "role": "owner",
          "status": "accepted",
          "invited_at": 1711471533,
          "expires_at": 1711471533,
          "accepted_at": 1711471533,
          "projects": [
            {
              "id": "project-xyz",
              "role": "member"
            }
          ]
        }

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.