> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.useopenwrench.com/llms.txt > Use this file to discover all available pages before exploring further. # Provision a supplier user > Creates a supplier contact (and, when a password is given, a login-enabled user account) under the API key's supplier company. Rules: roles must be non-empty and may NOT include admin/super-admin roles (403); the target facility (facilityId, defaulting to the key's own facility) must belong to the same supplier company (403); an existing account or contact for the email is a 400 conflict. SUPPLIER_TECH roles additionally get a FieldTech record. Without a password, a sign-up invitation email is sent; with one, the account is created active (optionally with passwordResetRequired). Admin-granting shortcuts: any admin role would force hasAccessToAllLocations, but admin roles are rejected here. ## OpenAPI ````yaml /openapi/supplier.json post /v1/supplier/user/provision openapi: 3.1.0 info: title: OpenWrench Supplier API version: 1.0.0 description: >- External REST API for OpenWrench suppliers (service providers). ## Authentication Every request must carry a supplier API key in the `X-API-KEY` header. The key resolves to a supplier contact; all reads and writes are tenant-scoped to that contact's supplier facility/company. Missing or invalid keys are answered with 401. ## Rate limiting 10 requests per 20-second window per API key. Requests beyond that are answered with 429 and the standard error envelope. (A few endpoints, noted in their descriptions, are not rate-limited.) ## Response envelope Single entity: `{"type": "", "data": {...}, "status": "ok"}`. Lists: `{"type": "", "data": [...], "count": , "status": "ok"}`. count_by endpoints return the integer count in `data`. The `type` label is hard-coded on some endpoints (e.g. "WorkOrderNotes", "pingpong") and derived via Scala reflection on generic CRUD endpoints, where it may appear as the fully qualified server class name - treat it as informational. Errors: `{"message": "...", "type": "", "status": "error", "traceId": "..."}` with HTTP 400 (bad input, and also permission-denied reads/writes), 401 (missing/invalid key), 404 (not found), 429 (rate limit). ## Pagination List endpoints accept `offset`, `limit` (default 10, max 25 - the supplier locations list caps at 10), `sort_by` and `order` (`asc`|`desc`), plus entity-specific query-string filters on indexed columns. ## Data masking For third-party suppliers (keys whose supplier company is not a buyer's internal service team), work order, location and invoice responses are masked: buyer-private fields are blanked before the response is returned. ## Date formats Date-time fields serialize as strings in one of two shapes depending on the underlying type: ISO 8601 with offset (e.g. `2026-08-14T13:05:22.000-07:00`) for most timestamps, or `yyyy-MM-dd HH:mm:ss.S` (space-separated, no offset) for database timestamp fields. Plain dates are `yyyy-MM-dd`. When sending date-times, ISO 8601 is accepted. ## Required headers Every request must carry BOTH `X-API-KEY` (your API key) and `OW-KEY` (the OpenWrench shared secret issued with it). Requests missing either return 401. servers: - url: https://api.useopenwrench.com/api/external security: - ApiKeyAuth: [] OwKeyAuth: [] tags: - name: Ping - name: Buyer Companies - name: Locations - name: Regions - name: Asset Types - name: Assets - name: Asset Labels description: Read the asset label catalog and replace the labels applied to an asset. - name: Work Orders - name: Work Order Labels description: >- Read the work order label catalog visible to your key and replace the labels applied to a work order. - name: Service Calls - name: WrenchMode description: Read-only WrenchMode work logs and technician time analytics - name: Proposals - name: Invoices - name: Files - name: Purchase Requests - name: Purchase Orders - name: Purchase Order Receipts - name: Parts - name: Equipment Types - name: Stock Location Inventory - name: Vendors - name: Users paths: /v1/supplier/user/provision: post: tags: - Users summary: Provision a supplier user description: >- Creates a supplier contact (and, when a password is given, a login-enabled user account) under the API key's supplier company. Rules: roles must be non-empty and may NOT include admin/super-admin roles (403); the target facility (facilityId, defaulting to the key's own facility) must belong to the same supplier company (403); an existing account or contact for the email is a 400 conflict. SUPPLIER_TECH roles additionally get a FieldTech record. Without a password, a sign-up invitation email is sent; with one, the account is created active (optionally with passwordResetRequired). Admin-granting shortcuts: any admin role would force hasAccessToAllLocations, but admin roles are rejected here. operationId: provisionSupplierUser requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: REQUIRED. Lower-cased and trimmed. nameGiven: type: string description: REQUIRED nameFamily: type: string description: REQUIRED roles: type: array items: type: string description: >- REQUIRED, non-empty. Supplier role names (case-insensitive); admin and super-admin roles are rejected. facilityId: type: integer description: >- Target supplier facility; defaults to the API key contact's facility. Must belong to the same supplier company. title: type: string department: type: string isSharedContact: type: boolean description: Default false readOnlyAccess: type: boolean description: Default false hasAccessToAllLocations: type: boolean locationIds: type: array items: type: integer format: int64 description: >- Location ids the user may access (ignored when hasAccessToAllLocations is true) brandIds: type: array items: type: integer description: >- Brand ids the user may access (ignored when hasAccessToAllLocations is true) hasAccessToAllStockLocations: type: boolean description: >- Default false; forced false when stockLocationIds is non-empty canManageAllStockLocations: type: boolean description: >- Default false; forced false when stockLocationIds is non-empty stockLocationIds: type: array items: type: integer format: int64 epaCertificationType: type: string description: EPA 608 certification class; validated epaCertificationNumber: type: string password: type: string description: >- When present, an active user account is created with this password instead of sending a sign-up invite passwordResetRequired: type: boolean description: Only meaningful together with password required: - email - nameGiven - nameFamily - roles responses: '200': description: The created contact (envelope type "SupplierContact") content: application/json: schema: $ref: '#/components/schemas/ContactResponse' '400': description: >- Bad input, validation failure, or the API key's contact could not be resolved content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing or invalid X-API-KEY content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Admin/super-admin role requested, or facility belongs to a different supplier company content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limit exceeded (10 requests per 20-second window) content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: ContactResponse: type: object properties: type: type: string description: >- Entity type label, e.g. "SupplierContact". Endpoints that derive it via Scala reflection (most generic list/get endpoints) may return the fully qualified server class name instead (e.g. "models.workorder.WorkOrder"); treat this field as informational. data: $ref: '#/components/schemas/Contact' status: type: string description: '"ok" on success' enum: - ok required: - type - data - status Error: type: object properties: message: type: string description: Human-readable error message type: type: string description: >- Exception type identifier. Known values (exact casing): "unauthorizedException", "authorizationException", "ParseException", "UnexpectedException", "NotFoundException", "BadRequestException", "PaymentRequiredException", "InvalidInputDataException", "ConflictException", "ForbiddenException", "InvalidInputException" status: type: string enum: - error traceId: type: string description: >- Server-generated trace identifier for support (11 alphanumeric characters) required: - message - type - status - traceId description: Standard error envelope returned for 4xx/5xx responses. Contact: type: object properties: email: type: string nameGiven: type: string nameFamily: type: string title: anyOf: - type: string - type: 'null' department: anyOf: - type: string - type: 'null' facilityId: anyOf: - type: integer - type: 'null' contactType: type: string description: '"buyer" or "supplier"' isSharedContact: type: boolean readOnlyAccess: anyOf: - type: boolean - type: 'null' invitedByEmail: anyOf: - type: string - type: 'null' invitedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' epaCertificationType: anyOf: - type: string - type: 'null' epaCertificationNumber: anyOf: - type: string - type: 'null' createdAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' updatedAt: anyOf: - type: string format: date-time description: ISO 8601 date-time - type: 'null' required: - email - nameGiven - nameFamily - contactType description: >- Contact record (abridged - the full Contact model carries additional fields). additionalProperties: true securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY OwKeyAuth: type: apiKey in: header name: OW-KEY description: >- OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key. ````