> ## Documentation Index > Fetch the complete documentation index at: https://developer.comstruct.com/llms.txt > Use this file to discover all available pages before exploring further. # Get project by external ID > **Erforderliche Berechtigungen:** `projects:read` ## OpenAPI ````yaml GET /projects/byExternalId/{external_id} openapi: 3.0.3 info: title: comstruct Public API description: > Die comstruct API ist eine umfassende und flexible Lösung zur Optimierung des Materialbeschaffungsprozesses für Unternehmen. Diese API bietet eine einfache Schnittstelle für Entwickler, um auf Materialbeschaffungsdaten zuzugreifen und diese zu verwalten, einschließlich Lieferanteninformationen, Lieferungen und Projekte. ## Erste Schritte Um Zugang zur comstruct API zu erhalten, wenden Sie sich bitte an Ihren zuständigen Customer Success Manager. Unser Expertenteam steht Ihnen mit erstklassigem Support zur Verfügung, um Ihnen zu helfen, das Beste aus unserer API herauszuholen. ## Authentifizierung Alle API-Endpunkte unter `/v1` erfordern eine Authentifizierung mittels API-Schlüssel im `x-api-key`-Header. Jeder API-Schlüssel hat spezifische Berechtigungen (Scopes), die bestimmen, welche Endpunkte und Operationen verfügbar sind. Die Authentifizierung wird durch Middleware durchgesetzt, die den API-Schlüssel und die Berechtigungen für jede Anfrage validiert. Kalender-Endpunkte unter `/calendars` verwenden Token-basierte Authentifizierung anstelle von API-Schlüsseln. ## Datenformate - Alle Zeitstempel sind im ISO 8601-Format (UTC) - Geldbeträge werden als Dezimalzahlen dargestellt - IDs sind UUIDs, sofern nicht anders angegeben ## Anfragegrößenbeschränkungen - PDF-Rechnungsverarbeitung, benutzerdefinierte Rechnungsverarbeitung und Workflow-Verarbeitung: 32MiB - Alle anderen Endpunkte: 10MiB ## Fehlerbehandlung Die API verwendet Standard-HTTP-Statuscodes und gibt detaillierte Fehlermeldungen im JSON-Format zurück. Weitere Details finden Sie in den Fehlerschemas. ## Integrationsmuster - **SAP-Integration**: Spezialisierte Endpunkte für SAP-ERP-Systeme - **Projektverwaltung**: Vollständiges Projektlebenszyklusmanagement mit Benutzerrollen - **Lieferverfolgung**: Unterstützung mehrerer Lieferscheinformate (OpenTrans, PAHM, Q-Point, benutzerdefiniert) - **Rechnungsverarbeitung**: Automatisierte Rechnungsanalyse und -validierung mit KI/GPT-Unterstützung - **Auftragsverwaltung**: IDS-Auftragsverarbeitung mit XML-Parsing und Projektkalenderintegration - **Kalenderintegration**: Separate Kalender-Endpunkte für iCalendar-Abonnement-Feeds version: 1.0.9 license: name: Proprietary url: https://comstruct.com contact: name: comstruct ICT GmbH url: https://comstruct.com email: support@comstruct.com termsOfService: https://comstruct.com/datenschutzerklarung/ x-logo: url: https://app.comstruct.com/logo-light-text.png altText: comstruct logo servers: - url: https://api.comstruct.com/v1 description: Haupt-API-Endpunkte (erfordert API-Schlüssel-Authentifizierung) variables: {} - url: https://api.comstruct.com description: Basisserver für Kalender- und IDS-Endpunkte (andere Authentifizierung) variables: {} security: - ApiKey: [] tags: - name: Projects description: Endpunkte für Projekte. - name: Projects (SAP) description: SAP-spezifische Projekt-Endpunkte. - name: Project Regions description: Endpunkte für die Verwaltung von Projektregionen. - name: Deliveries description: Endpunkte für Lieferungen. - name: Deliveries (Supplier) description: Lieferantenspezifische Liefer-Endpunkte. - name: Accounts description: Endpunkte für die Verwaltung von Sachkonten. - name: Payment Terms description: Endpunkte für die Verwaltung von Zahlungsbedingungen. - name: Tax Codes description: Endpunkte für die Verwaltung von Steuercodes. - name: Company Codes description: Endpunkte für die Verwaltung von Buchungskreisen (juristische Einheiten). - name: Suppliers description: Endpunkte für die Verwaltung von Lieferanten. - name: Purchase Orders description: Endpunkte für Bestellungen. - name: Purchase Orders (SAP) description: SAP-spezifische Bestellungs-Endpunkte. - name: Orders (Supplier) description: >- Lieferantenspezifische Bestellungs-Endpunkte (Bestätigung, Ablehnung, Bearbeitung). - name: Suppliers (SAP) description: SAP-spezifische Lieferanten-Endpunkte. - name: Invoices description: Endpunkte für Rechnungen. - name: Invoices (Supplier) description: Lieferantenspezifische Rechnungs-Endpunkte. - name: Invoices (SAP) description: SAP-spezifische Rechnungs-Endpunkte. - name: Invoice Dimensions description: > Rechnungs-Dimensionen (benutzerdefinierte Eigenschaften) und Zuweisungen auf Rechnung (`header`), Position (`line_item`) oder Kontierung (`account`). Dimensionen haben den Typ `option` (vordefinierte Werte) oder `text` (Freitext über `dimension_id` + `text_value`). Bulk-Konto-POST (`/assignments/account/bulk`) unterstützt nur Options-Zuweisungen über `option_ids`; Freitext auf Kontoebene über Einzel-POST, PATCH-Bulk oder Positions-Bulk. - name: Workflows description: Endpunkte für Workflow- und Prozessmanagement. - name: Calendar description: Kalender-Abonnement-Endpunkte mit separater Authentifizierung. - name: Orders description: Endpunkte für Auftragsverarbeitung und -verwaltung. paths: /projects/byExternalId/{external_id}: get: tags: - Projects summary: Projekt nach externer ID abrufen description: | **Erforderliche Berechtigungen:** `projects:read` operationId: getProjectByExternalId parameters: - name: external_id in: path required: true schema: type: string description: Die externe Kennung des Projekts responses: '200': description: Projekt erfolgreich abgerufen content: application/json: schema: $ref: '#/components/schemas/Project' '400': description: Ungültige Eingabe '403': description: Verboten - Ungültige Berechtigung '404': description: Projekt nicht gefunden '500': description: Interner Serverfehler security: - ApiKey: - projects:read components: schemas: Project: type: object readOnly: true properties: id: type: string format: uuid description: Die eindeutige Kennung des Projekts external_id: type: string example: EXT-001 description: Die externe Kennung des Projekts title: type: string example: Example Site description: Der Titel des Projekts project_number: type: string nullable: true example: '23423420' description: Die Projektnummer description: type: string description: Eine Beschreibung des Projekts region: type: string example: Bavaria description: >- Die Region, in der sich das Projekt befindet, wird für Filterung verwendet project_region_id: type: string format: uuid nullable: true description: Die ID der verknüpften Projektregion active: type: boolean nullable: true description: Steuert, ob das Projekt aktiv ist alternative_project_number: type: string nullable: true description: Alternative Projektnummer zur Referenz, z. B. aus SAP status: type: string description: Der Status des Projekts customer_id: type: string format: uuid description: Die eindeutige Kennung des Kunden address: type: object description: Die Adressdetails des Projekts properties: address: type: string description: Die Straßenadresse city: type: string description: Die Stadt country: type: string description: Das Land house_number: type: string description: Die Hausnummer zip: type: string description: Die Postleitzahl legal_entity: type: object nullable: true description: Der dem Projekt zugeordnete Buchungskreis properties: id: type: string format: uuid description: Die eindeutige Kennung des Buchungskreises title: type: string description: Der Titel des Buchungskreises number: type: string description: Die Nummer des Buchungskreises project_invites: type: array description: Dem Projekt zugewiesene Benutzereinladungen items: $ref: '#/components/schemas/UserInvite' UserInvite: type: object readOnly: true properties: id: type: string format: uuid description: Die ID der Benutzereinladung email: type: string format: email description: Die E-Mail der Benutzereinladung role: type: string nullable: true description: Der Rollentitel der Benutzereinladung role_id: type: string format: uuid nullable: true description: Die Rollen-ID der Benutzereinladung project_id: type: string format: uuid description: Die Projekt-ID der Benutzereinladung tenant_id: type: string format: uuid description: Die Mandanten-ID der Benutzereinladung securitySchemes: ApiKey: type: apiKey in: header name: X-API-Key description: > API-Schlüssel zur Authentifizierung. Kontaktieren Sie Ihren Customer Success Manager, um einen API-Schlüssel zu erhalten. Jeder Endpunkt erfordert spezifische Berechtigungen (Scopes); die erforderlichen Scopes werden pro Endpunkt angezeigt. ````