# catalog_invitations_platform_retrieve

API View for managing platform invitations.

This endpoint allows querying, creating, and deleting platform invitations for users.

Query/Request Parameters:
    For GET:
        platform_key (str, optional): Filter by platform key
        org (str, optional): Filter by platform organization
        email (str, optional): Filter by user email
        source (str, optional): Filter by invitation source
        active (bool, optional): Filter by active status
        sort (str, optional): Field to sort results by (default: '-id')
        metadata fields: Any additional parameters will be treated as metadata filters

    For POST:
        platform_key (str, required): The platform to create an invitation for
        email (str, required): The email address to invite
        active (bool, optional): Whether the invitation is active
        metadata fields: Any additional parameters will be added as metadata

    For DELETE:
        id (int, required): The ID of the invitation to delete
        org (str, required): The platform organization for verification

Methods:
    GET: Retrieve a paginated list of platform invitations
    POST: Create a new platform invitation
    DELETE: Remove a platform invitation

Returns:
    GET: A paginated JSON response containing platform invitations:
        {
            "count": 10,
            "next": "https://example.com/api/catalog/invitations/platform/?page=2",
            "previous": null,
            "results": [
                {
                    "id": 123,
                    "user_id": 456,
                    "username": "username",
                    "email": "user@example.com",
                    "created": "2023-06-15T14:30:00Z",
                    "started": "2023-06-15T14:30:00Z",
                    "source": "source",
                    "redirect_to": "https://example.com",
                    "expired": null,
                    "active": true,
                    "metadata": {},
                    "platform_key": "platform1"
                },
                ...
            ]
        }

    POST: A JSON response containing the created invitation:
        {
            "id": 123,
            "user_id": 456,
            "username": "username",
            "email": "user@example.com",
            "created": "2023-06-15T14:30:00Z",
            "started": "2023-06-15T14:30:00Z",
            "source": "source",
            "redirect_to": "https://example.com",
            "expired": null,
            "active": true,
            "metadata": {},
            "platform_key": "platform1"
        }

    DELETE: A success response with status 200

Error Responses:
    400 Bad Request: If required parameters are missing or invalid
    401 Unauthorized: If the user is not authenticated
    403 Forbidden: If the user does not have permission to access this resource
    404 Not Found: If the platform or invitation doesn't exist
    500 Internal Server Error: If an unexpected error occurs

Access Control:
    - Requires IsDMAdmin or IsPlatformAdmin permission
    - Available to platform administrators and DM admins

Endpoint: GET /api/catalog/invitations/platform/
Version: 3.59.0-ai-plus
Security: PlatformApiKeyAuthentication

## Query parameters:

  - `active` (boolean)
    Filter by active status

  - `email` (string)
    Filter by user email

  - `org` (string)
    Filter by platform organization

  - `page` (integer)
    Page number for pagination

  - `page_size` (integer)
    Number of results per page

  - `platform_key` (string)
    Filter by platform key

  - `sort` (string)
    Field to sort results by

  - `source` (string)
    Filter by invitation source

  - `username` (string)
    Filter by username

  - `verbose` (boolean)
    Whether to include verbose output

## Response 200 fields (application/json):

  - `count` (integer, required)
    Total number of results

  - `next_page` (string,null, required)
    URL for next page of results

  - `previous_page` (string,null, required)
    URL for previous page of results

  - `results` (array, required)
    List of platform invitations

  - `results.id` (integer, required)
    The unique identifier for the invitation

  - `results.user_id` (integer,null)
    The ID of the user associated with the invitation

  - `results.username` (string,null, required)
    The username of the user associated with the invitation

  - `results.email` (string,null, required)
    The email address associated with the invitation

  - `results.created` (string)
    When the invitation was created

  - `results.started` (string,null, required)
    When the invitation was started

  - `results.expired` (string,null, required)
    When the invitation expires

  - `results.source` (string,null, required)
    The source of the invitation

  - `results.redirect_to` (string,null, required)
    URL to redirect to after accepting the invitation

  - `results.active` (boolean, required)
    Whether the invitation is active

  - `results.metadata` (object, required)
    Additional metadata for the invitation

  - `results.platform_key` (string, required)
    The platform key associated with the invitation