> ## Documentation Index
> Fetch the complete documentation index at: https://www.vollna.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List invitations

> Returns a list of invitations for a specific Upwork profile



## OpenAPI

````yaml get /invitations
openapi: 3.0.4
info:
  title: Vollna API
  description: API for managing Upwork profiles, proposals, results, and filters
  version: 1.0.0
servers:
  - url: https://api.vollna.com/v1
security: []
tags:
  - name: Profiles
    description: Manage Upwork profiles
  - name: Proposals
    description: Access and manage Upwork proposals
  - name: Results
    description: View monitoring results and projects
  - name: Filters
    description: Manage monitoring filters
  - name: Auto Bidding
    description: Manage auto bidding jobs and setups
paths:
  /invitations:
    get:
      tags:
        - Invitations
      summary: List invitations
      description: Returns a list of invitations for a specific Upwork profile
      parameters:
        - name: profileId
          in: query
          description: Upwork profile ID (from `/profiles` API endpoint)
          required: true
          schema:
            type: integer
        - name: organizationId
          in: query
          description: Organization ID (from `/organizations` API endpoint)
          deprecated: true
          schema:
            type: integer
        - name: page
          in: query
          description: Page number
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          description: Items per page
          required: false
          schema:
            type: integer
            minimum: 10
            maximum: 100
            default: 20
        - name: sort
          in: query
          description: Sort field
          required: false
          schema:
            type: string
            enum:
              - invitedAt
            default: invitedAt
        - name: order
          in: query
          description: Sort order
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
            default: DESC
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Invitation'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiToken: []
components:
  schemas:
    Invitation:
      type: object
      properties:
        id:
          type: integer
          description: Invitation ID
          example: 13
        upworkProfile:
          type: object
          description: Upwork profile details
          properties:
            id:
              type: integer
              description: Upwork profile ID
              example: 1
            label:
              type: string
              description: Upwork profile name
            type:
              type: string
              description: Upwork profile type
              example: freelancer
        upworkOrganization:
          type: object
          deprecated: true
          description: Deprecated, use `upworkProfile` instead
          properties:
            id:
              type: integer
              description: Organization ID
              example: 1
            label:
              type: string
              description: Organization name
            type:
              type: string
              description: Organization type
              example: freelancer
        invitationUid:
          type: string
          description: Invitation UID from Upwork
          example: '1234567890'
        title:
          type: string
          description: Job title
          example: Symfony PHP Developer for Educational Application
        jobPostingUid:
          type: string
          description: Job posting UID from Upwork
          example: '1234567890'
        invitationLetter:
          type: string
          description: Invitation letter content
          example: |-
            Hello!

            I'd like to invite you to take a look at the job I've posted...
        clientUid:
          type: string
          description: Client UID from Upwork
          example: '1234567890'
        contractor:
          type: object
          description: Contractor details
          properties:
            id:
              type: integer
              description: Contractor ID
              example: 1
            fullName:
              type: string
              description: Contractor full name
              example: John Doe
        contractorUid:
          type: string
          description: Contractor UID from Upwork
          example: '1234567890'
        invitedAt:
          type: string
          format: date-time
          description: Invitation date and time
          example: '2022-08-01T20:04:53+00:00'
        createdAt:
          type: string
          format: date-time
          description: Record creation date and time
          example: '2025-05-17T13:30:44+00:00'
        updatedAt:
          type: string
          format: date-time
          description: Record last update date and time
          example: '2025-05-17T13:30:44+00:00'
        statusLabel:
          type: string
          description: Current status of the invitation
          example: Job is closed
        project:
          $ref: '#/components/schemas/Project'
          nullable: true
          description: Linked project from Vollna database (if found via Elasticsearch)
    Pagination:
      type: object
      properties:
        total:
          type: integer
          description: Total number of items
          example: 100
        page:
          type: integer
          description: Current page number
          example: 1
        limit:
          type: integer
          description: Number of items per page
          example: 20
        pages:
          type: integer
          description: Total number of pages
          example: 5
    Error:
      type: object
      properties:
        error:
          type: string
    Project:
      type: object
      properties:
        title:
          type: string
          description: Project title
        description:
          type: string
          description: Project description
        skills:
          type: string
          description: Required skills, comma-separated
        url:
          type: string
          format: uri
          description: Project URL
        publishedAt:
          type: string
          format: date-time
          description: When the project was published
        clientQuestions:
          type: array
          items:
            type: string
          nullable: true
          description: Questions from the client
        categories:
          type: array
          items:
            type: string
          description: Project categories
        site:
          type: string
          description: Source site (e.g. Upwork.com)
        budget:
          type: object
          properties:
            type:
              type: string
              enum:
                - Fixed price
                - Hourly rate
              description: Budget type
            amount:
              type: string
              description: Budget amount with currency symbol
        clientDetails:
          type: object
          properties:
            paymentMethodVerified:
              type: boolean
              description: Whether client's payment method is verified
            country:
              type: string
              description: Client's country
            totalSpent:
              type: number
              format: float
              description: Total amount spent by client
              example: 103580
            totalHires:
              type: integer
              description: Total number of hires by client
              example: 100
            hireRate:
              type: number
              format: float
              description: Client's hire rate
              example: 0.5
            rating:
              type: number
              format: float
              description: Client's rating
              example: 4.5
            reviews:
              type: integer
              description: Number of client reviews
              example: 78
        clientWorkHistory:
          type: array
          nullable: true
          description: Client's work history with previous freelancers
          items:
            type: object
            properties:
              job_info:
                type: object
                properties:
                  uid:
                    type: string
                    nullable: true
                    description: Job UID
                  title:
                    type: string
                    nullable: true
                    description: Job title
                  type:
                    type: string
                    nullable: true
                    description: Job type
              status:
                type: string
                nullable: true
                description: Job status (e.g., 'ACTIVE' for jobs in progress)
              start_date:
                type: string
                nullable: true
                description: Job start date
              end_date:
                type: string
                nullable: true
                description: Job end date
              total_hours:
                type: number
                format: float
                nullable: true
                description: Total hours worked
              total_charge:
                type: number
                format: float
                nullable: true
                description: Total amount charged
              feedback:
                type: object
                nullable: true
                description: Feedback from client to freelancer
                properties:
                  score:
                    type: number
                    format: float
                    nullable: true
                    description: Rating score
                  comment:
                    type: string
                    nullable: true
                    description: Feedback comment
              feedback_to_client:
                type: object
                nullable: true
                description: Feedback from freelancer to client
                properties:
                  score:
                    type: number
                    format: float
                    nullable: true
                    description: Rating score
                  comment:
                    type: string
                    nullable: true
                    description: Feedback comment
              rate:
                type: object
                nullable: true
                description: Rate information
                properties:
                  amount:
                    type: number
                    format: float
                    nullable: true
                    description: Rate amount
  securitySchemes:
    apiToken:
      type: apiKey
      name: X-API-TOKEN
      in: header
      description: API token for authentication

````