NAME

OpenAPI::Client::OpenAI::Path::organization-invites-invite_id - Documentation for the /organization/invites/{invite_id} path.

DESCRIPTION

This document describes the API endpoint at /organization/invites/{invite_id}.

PATHS

DELETE /organization/invites/{invite_id}

Delete an invite. If the invite has already been accepted, it cannot be deleted.

Operation ID

delete-invite

            

              
              
$client->delete-invite( ... );
            
          

Parameters

• invite_id (in path) (Required) - The ID of the invite to delete.

  Type: string

Responses

Status Code: 200

Invite deleted successfully.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

GET /organization/invites/{invite_id}

Retrieves an invite.

Operation ID

retrieve-invite

            

              
              
$client->retrieve-invite( ... );
            
          

Parameters

• invite_id (in path) (Required) - The ID of the invite to retrieve.

  Type: string

Responses

Status Code: 200

Invite retrieved successfully.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  
              
  
                
                
  {
    "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.

cpanm OpenAPI::Client::OpenAI

perl -MCPAN -e shell
install OpenAPI::Client::OpenAI