> ## Documentation Index > Fetch the complete documentation index at: https://docs.journeybee.io/llms.txt > Use this file to discover all available pages before exploring further. # List partnership deals ## OpenAPI ````yaml /partner-openapi.json get /partner/{partnershipId}/deals openapi: 3.1.0 info: title: Journeybee Partner API description: Partner-facing REST API for the Journeybee PRM platform. version: 1.0.0 servers: - url: https://api.journeybee.io/v1 description: Production security: - apiKey: [] tags: - name: Partner description: Partner-facing API endpoints — used only by the partner spec paths: /partner/{partnershipId}/deals: get: tags: - Partner summary: List partnership deals operationId: listPartnerDeals parameters: - schema: type: string maxLength: 200 in: query name: search required: false - schema: type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ in: query name: stages required: false - schema: type: array items: type: string enum: - new - in_progress - won - lost - expired - on_hold in: query name: phases required: false - schema: type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ in: query name: tags required: false - schema: type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ in: query name: users required: false - schema: type: boolean in: query name: includeCustomFields required: false - schema: default: 1 type: integer exclusiveMinimum: 0 maximum: 9007199254740991 in: query name: page required: false - schema: default: 25 type: integer exclusiveMinimum: 0 maximum: 200 in: query name: perPage required: false - schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ in: path name: partnershipId required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: data: type: array items: type: object properties: uuid: type: string created_at: type: string updated_at: type: string label: type: string deal_value: type: number currency_code: anyOf: - type: string - type: 'null' stage_id: anyOf: - type: string - type: 'null' stage: anyOf: - type: object properties: id: type: string label: anyOf: - type: string - type: 'null' series: anyOf: - type: number - type: 'null' phase: anyOf: - type: string enum: - new - in_progress - won - lost - expired - on_hold - type: 'null' required: - id - label - series - phase additionalProperties: false - type: 'null' total_commission_value: anyOf: - type: number - type: 'null' expiration_date: anyOf: - type: string - type: 'null' expired_at: anyOf: - type: string - type: 'null' created_by_user_id: anyOf: - type: string - type: 'null' lock_deal_stage: type: boolean lead_id: type: string lead_company_name: anyOf: - type: string - type: 'null' lead_first_name: anyOf: - type: string - type: 'null' lead_last_name: anyOf: - type: string - type: 'null' lead_email: anyOf: - type: string - type: 'null' lead_phone_number: anyOf: - type: string - type: 'null' lead_direction: anyOf: - type: string enum: - sent - received - type: 'null' lead_campaign_id: anyOf: - type: string - type: 'null' campaign_title: anyOf: - anyOf: - type: string - type: 'null' - type: 'null' partnership: anyOf: - type: object properties: id: type: string uuid: type: string name: anyOf: - type: string - type: 'null' partner_type: type: string enum: - referral - reseller - distributor logo_square_id: anyOf: - type: number - type: 'null' logo_square_uuid: anyOf: - type: string - type: 'null' partnership_distributors_id: anyOf: - type: string - type: 'null' distributor_name: anyOf: - type: string - type: 'null' distributor_logo_square_id: anyOf: - type: number - type: 'null' distributor_logo_square_uuid: anyOf: - type: string - type: 'null' required: - id - uuid - name - partner_type - logo_square_id - logo_square_uuid - partnership_distributors_id - distributor_name - distributor_logo_square_id - distributor_logo_square_uuid additionalProperties: false - type: 'null' tags: type: array items: type: object properties: id: type: string label: type: string background_color: type: string text_color: anyOf: - type: string - type: 'null' required: - id - label - background_color - text_color additionalProperties: false assigned_users: type: array items: type: object properties: id: type: string first_name: anyOf: - type: string - type: 'null' last_name: anyOf: - type: string - type: 'null' email: type: string profile_image_id: anyOf: - type: number - type: 'null' profile_image_uuid: anyOf: - type: string - type: 'null' required: - id - first_name - last_name - email - profile_image_id - profile_image_uuid additionalProperties: false assigned_contacts: type: array items: type: object properties: id: type: string first_name: anyOf: - type: string - type: 'null' last_name: anyOf: - type: string - type: 'null' email: type: string profile_image_id: anyOf: - anyOf: - type: number - type: 'null' - type: 'null' profile_image_uuid: anyOf: - type: string - type: 'null' required: - id - first_name - last_name - email - profile_image_id - profile_image_uuid additionalProperties: false custom_field_values: type: array items: type: object properties: custom_field_id: type: string label: type: string type: type: string enum: - text - textarea - number - date - boolean - select - multi_select value: anyOf: - type: object properties: text: description: Value for text/url/email/phone fields anyOf: - type: string - type: 'null' number: description: Value for number fields anyOf: - anyOf: - type: number - type: string - type: 'null' date: description: >- Value for date fields (ISO 8601 date string) anyOf: - type: string - type: 'null' boolean: description: Value for checkbox fields anyOf: - anyOf: - type: boolean - type: string - type: 'null' select: description: Option ID for single-select fields anyOf: - type: number - type: 'null' multi_select: description: Option IDs for multi-select fields anyOf: - type: array items: type: number - type: 'null' additionalProperties: false description: >- Custom field value. Set the key matching the field type: text (text/url/email/phone), number, date, boolean (checkbox), select (option ID), or multi_select (array of option IDs). - type: 'null' options: anyOf: - type: array items: type: object properties: id: type: number label: type: string required: - id - label additionalProperties: false - type: 'null' required: - custom_field_id - label - type - value - options additionalProperties: false id: type: string required: - uuid - created_at - updated_at - label - deal_value - currency_code - stage_id - stage - total_commission_value - expiration_date - expired_at - created_by_user_id - lead_id - lead_company_name - lead_first_name - lead_last_name - lead_email - lead_phone_number - lead_direction - lead_campaign_id - campaign_title - partnership - tags - assigned_users - custom_field_values - id additionalProperties: false pagination: type: object properties: page: type: number per_page: type: number total: type: number total_pages: type: number required: - page - per_page - total - total_pages additionalProperties: false required: - data - pagination additionalProperties: false components: securitySchemes: apiKey: type: http scheme: bearer description: API key authentication. Use "Bearer " or "Api-Key ". ````