---
title: "Officer"
url: "https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/f42817f3-815f-4a74-8ba5-2f83efd8ab42/schemas/Officer"
---

> Full API specification: https://developer.pexa.co.uk/apis/workspace-v1-v1/versions/f42817f3-815f-4a74-8ba5-2f83efd8ab42.md

# Officer

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Workspace
  version: v1
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    Officer:
      type: object
      required:
        - forenames
        - surname
        - email
        - role
      properties:
        forenames:
          maxLength: 90
          minLength: 1
          type: string
          example: James Thomas
          pattern: ^[A-Za-z][A-Za-z\- ']*$
        surname:
          maxLength: 50
          minLength: 1
          type: string
          example: Smith
          pattern: ^[A-Za-z][A-Za-z\- ']*$
        email:
          type: string
          minLength: 1
          pattern: ^$|(?:[A-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-z0-9](?:[A-z0-9-]*[A-z0-9])?\.)+[A-z0-9](?:[A-z0-9-]*[A-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-z0-9-]*[A-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5A\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])
          example: approver@lawfirm.com
        role:
          type: string
          pattern: ^(DIRECTOR|SECRETARY)$
          example: DIRECTOR
          description: |
            Allowed values: [`DIRECTOR`, `SECRETARY`]
```
