> ## 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. # Lookup project by ciphertext or UID > Returns a single project by its Upwork ciphertext (~123456) or UID. This endpoint consumes credits when returning a project that hasn't been accessed before in the current billing period. ## OpenAPI ````yaml get /projects/lookup 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: /projects/lookup: get: tags: - Projects summary: Lookup project by ciphertext or UID description: >- Returns a single project by its Upwork ciphertext (~123456) or UID. This endpoint consumes credits when returning a project that hasn't been accessed before in the current billing period. parameters: - name: ciphertext in: query description: >- Upwork job ciphertext (e.g., ~123456). Provide either ciphertext or uid, not both. required: false schema: type: string pattern: ^~\d+$ example: ~0123456789 - name: uid in: query description: Upwork job UID. Provide either ciphertext or uid, not both. required: false schema: type: string example: '1234567890123456789' responses: '200': description: Successful operation content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Project' credits: type: object properties: remaining: type: integer description: >- Credits remaining in current billing period (-1 for unlimited) example: 9995 reset_date: type: string format: date-time description: When credits reset (ISO 8601) example: '2026-01-16T00:00:00+00:00' new_projects_consumed: type: integer description: >- Number of new projects that consumed credits (0 if already viewed) example: 1 total_projects_returned: type: integer description: Total projects returned example: 1 '400': description: Bad request - Invalid parameters content: application/json: schema: $ref: '#/components/schemas/Error' examples: missing_params: summary: Missing parameters value: error: 'Missing required parameter: ciphertext or uid' both_params: summary: Both parameters provided value: error: Provide either ciphertext or uid, not both invalid_format: summary: Invalid ciphertext format value: error: 'Invalid ciphertext format. Expected format: ~123456' '402': description: Payment required - Insufficient credits content: application/json: schema: type: object properties: error: type: string example: Insufficient credits credits_remaining: type: integer example: 0 credits_reset_date: type: string format: date-time example: '2026-01-16T00:00:00+00:00' '403': description: Forbidden - No active subscription content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not found - Project not found content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' security: - apiToken: [] components: schemas: 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 Error: type: object properties: error: type: string securitySchemes: apiToken: type: apiKey name: X-API-TOKEN in: header description: API token for authentication ````