{"openapi":"3.0.0","info":{"title":"Team Manager API","version":"7.0.1","contact":{"name":"D4H Support","url":"https://help.d4h.com/","email":"help@d4h.com"},"description":"# Introduction\n\nWelcome to the D4H Team Manager REST API, a RESTful API that allows you to access Team Manager data and services. Our API is designed to enable seamless integration with your own applications, websites, and other tools.\n\nWith the REST API, you can perform most of the activities available from the Team Manager application, such as managing personel, equipment, exercises, updating their data, etc.\n\n**Notice: the D4H Team Manager REST API is not yet feature complete, future updates will increase functionality but please let us know if something you need is missing and we can try to prioritise it**\n\n## Getting Authenticated\n\nD4H Team Manager's API uses token-based authentication. There are two types of tokens:\n\n- **Personal Access Tokens**. These are used when developing an integration for yourself or for your organization. They have the convenience of being long-lived tokens, and they can be easily generated from the Unified Accounts web UI. Personal Access Tokens should only be used in applications that don't require the ability to authenticate multiple users. If your application needs to be able to support multiple users, then your application should use OAuth to obtain Standard UA Tokens.\n\nAll token types are accepted by the REST API and should be provided in the HTTP request Authorization header:\n\n```text\nAuthorization: Bearer \n```\n\n### Generating a Personal Access Token\n\nYour account must be migrated to Unified Accounts authentication to be able to use the Personal Access Tokens. Also, your Team or Organisation must enable Personal Access Tokens in their settings under _API Access_.\n\nThese can be created under _Manage Personal Access Tokens_:\n\n![The \"Manage Tokens\" Page in D4H Unified Accounts](public/docs/screenshot-my-account.jpg)\n\n1. In the page you can manage existing tokens or create a new one under the “Create Token” link.\n\n2. Make sure “Team Manager” is checked under the “Products access” section so you’re able to use these tokens in the D4H Team Manager REST API.\n\nFinally, after pressing “Next”, the token will be displayed. The token is not saved by D4H, so lost tokens are not recoverable.\n\nThe JWT token should then be used on the HTTP Request Authorization headers.\n\nPlease contact D4H support if you have any problems accessing or activating your Unified Account.\n\n## Making Requests\n\nIf you are completely unfamiliar with making REST API requests, a good first step would be trying\nsome simple requests using a terminal / command-line application called `curl`. This is installed by\ndefault on newer MacOs and Windows versions, but can be installed manually on older ones.\n\n### Your First Request\n\nAfter getting an access token of some kind, open your terminal / command line and try the following command (after\nmodifying it to replace `YOUR_ACCESS_TOKEN` with your token):\n\n```bash\ncurl -X GET -H \"Authorization: Bearer YOUR_ACCESS_TOKEN\" -o d4h-api-whoami-response.json https://api.team-manager.us.d4h.com/v3/whoami\n```\n\nThis will make a `GET` request to the `whoami` endpoint, which if successful will return a JSON\nresponse similar to that shown [here](#tag/Accounts-Credentials/paths/~1v3~1whoami/get). This will\nbe stored in `d4h-api-whoami-response.json` in the directory from which the command is run.\n\n### Request Contexts\n\nWithin the `whoami` response, you will find arrays of `members` and `officers` objects. Each of\nthese essentially represents a team-membership or organisation-officership which your token allows requests to be performed as.\n\nEach member or officer object will have an `owner` object within, this being a representation the team or organisation itself. Each `owner` will have an `id`, and this is their _context-identifier_.\n\nHere is a part of an example response from `whoami`\n\n```json\n{\n \"members\": [\n {\n \"id\": 1,\n \"owner\":\n {\n \"resourceType\": \"Team\",\n \"id\": 600,\n \"title\": \"Team Y\",\n },\n \"name\": \"Member X\",\n \"hasAccess\": true,\n \"resourceType\": \"Member\",\n },\n ]\n}\n```\n\nIn the Team Manager API most requests are made within a specific _context_, this can be thought of\nthe point-of-view from which a request is made. A request's context is included in the URL.\nBased on the above example, the _context_ is `team` and the _context-identifier_ is `600`. Hence, an example request\nurl would be `https://api.team-manager.us.d4h.com/v3/team/600/whiteboard`.\n\nThe two contexts that would apply for most\nusers are `team` and `organisation`, and these would be followed in the URL by the id of the team or\norganisation.\n\nSee the [General URL Structure](#section/Introduction/General-URL-Structure) for further information on contexts and what each part of the URL means.\n\n### Creating Data\n\nThe following command is slightly more complex:\n\n```bash\ncurl -X POST -H \"Content-Type: application/json\" -H \"Authorization: Bearer YOUR_ACCESS_TOKEN\" -d \"{ \\\"text\\\": \\\"I wrote this via the API\\\", \\\"important\\\": true }\" -o d4h-api-post-response.json https://api.team-manager.us.d4h.com/v3/YOUR_CONTEXT/YOUR_CONTEXT_ID_FROM_WHOAMI/whiteboard\n```\n\nIt will make a `POST` type request, which is usually used for the _creation_ of data. It will use the JSON\nyou provide via the `-d` flag in the command. The API will take whatever is after `-d` and try to\nuse it to create a resource. Your ability to create resources will be determined by your\npermissions, which are viewable in the data returned from the `whoami` request.\n\nThis command should create a whiteboard note (if you have that module turned on), that is marked as\nimportant and has the text contained in the JSON.\n\n### Alternative API clients\n\nIf you are not comfortable with the command line, or just want making requests to be more\nconvenient, there are many (many) varied GUI-based REST API clients. Some examples at\nthe time of writing:\n\n- [Bruno](https://docs.usebruno.com/)\n- [Httpie](https://httpie.io/desktop)\n- [Insomnia](https://insomnia.rest/)\n- [Postman](https://www.postman.com/)\n\n## General URL Structure\n\nConsider the following example URL template:\n\n```text\n[verb] https://api.team-manager.us.d4h.com/[version]/[context]/[context-identifier]/[resource]/[resource-identifier]?[query-params]\n```\n\nAn example would be:\n\n```text\nGET https://api.team-manager.us.d4h.com/v3/team/1/incidents/234?size=100&search=angry%20clown\n```\n\nAs a general rule, looking to the verb, the URL should indicate what the API endpoint does.\n\n- `version` should be increased on breaking changes\n- `context` represents the context the request is being made under, currently only `team` or `organisations`\n - `context-identifier` represents an unique identifier for the context\n- `resource` represents the entity domain relative to the context\n - `resource-identifier` represents an unique identifier for the resource\n- `query-params` represent contextual data attributes that don't change the resource domain.\n - They can be used for:\n - search\n - pagination / ordering / sorting\n - a team-context request wishing to include/exclude organisation-context resources from results\n - etc...\n\n### Contexts\n\nContexts are not a resource, but a point-of-view from which a request is made. There is an implicit `team`-`organisation` relationship that is not obvious from the url, but should be borne in mind. A `team` generally has access to its own data, but also _some_ data of its parent `organisation`. An `organisation` has access to its own data, but also _some_ of its multiple sub-`team`s. The data shared can vary by `resource`-type.\n\nTherefore, the `team` context in a request means: the data owned by this team and that implicitly shared by its associated `organisation` if any.\n\nCorrespondingly, the `organisation` context in a request means: the data owned by this organisation and that which is implicitly shared by its associated `team`s.\n\n#### Context-Entity Endpoints\n\nSince `team` and `organisation` are used in the URL structure to designate the context, their plural form can appear again in the same URL to request data about the entities themselves.\n\n- `/v3/team/123/teams/123` - returning data about the team `123`\n- `/v3/team/123/teams/456` - returning data about a sibling team `456`\n- `/v3/team/123/organisations/789` - returning data about a team's parent organisation\n- `/v3/organisation/789/organisations/789` - returning data about the organisation itself\n- `/v3/organisation/789/teams/123` - returning data about one of the organisation's child teams\n\nAs for any other endpoint, the data returned will be as from the point-of-view specified by the context.\n\n#### Requesting or filtering data from multiple contexts\n\nIt may be desirable to retrieve resources from multiple contexts in one request, or exclude data from the\nimplicit team/organisation relationship. In these cases specific query parameters (`exclude_org_data`, `exclude_teams_data`)\nare to be used as modifiers to indicate intent\n\n- `/v3/team/123/equipment-brands` - team-owned and org-owned\n- `/v3/team/123/equipment-brands?exclude_org_data=true` - team-owned only\n- `/v3/organisation/123/equipment-brands` org-owned and sub-team-owned\n- `/v3/organisation/123/equipment-brands?exclude_teams_data=true` org-owned only\n\nThese modifiers should be available on every appropriate `GET` route and also apply\nto functional `GET` endpoints\n\n\"Sibling\" teams' data must be requested separately\n\n## Resource Ownership\n\nIn responses resource ownership is represented\nas an `owner` object which includes the owner id and its resource type.\n\n```json\n{\n \"owner\": {\n \"id\": 1,\n \"resourceType\": \"Team\"\n }\n}\n```\n\n## Resource / Entity Bundles\n\n\"Bundling\" varies between resource types. The existing bundles based around string names is deprecated, and the goal is to eventually move all bundles over to resource-bundle endpoint.\nBut, in the meantime, bundle string properties will be named `deprecatedBundle`, reserving the `bundle` / `resourceBundle` property name for\na resource-bundle object in the future. `deprecated` should be included in both the payload and response keys.\n\n```json\n{\n \"bundle\": {\n \"id\": 1,\n \"resourceType\": \"ResourceBundle\"\n }\n}\n```\n\n## Member Addresses\n\nThe members endpoints currently return and accept a `deprecatedAddress` string to represent a member's address. This is to allow us to add an `address` object in the future\nwith individual `street`, `postcode`, etc properties without breaking backwards-compatability.\n\n## Enums\n\nEnums are always case-sensitive strings. Specifically:\n\n- Enums in query parameters, payloads, and responses are always in `SCREAMING_SNAKE_CASE`.\n- Context enums in urls (and urls in general) are always in `kebab-case`.\n- Resource type enums anywhere are always in `PascalCase`.\n\nExplanations for their meaning and use should be provided in either the validation description, or in a preface paragraph for the endpoint as a whole\n\n## Validation\n\nRequest parameters, queries and payloads will be validated against strict schemas as per the API endpoint reference below. Validation failure will generate meaningful 400 HTTP errors that will include all violations when possible.\n\nSupplying additional keys not defined in an endpoint schema is forbidden and will also result in 400 errors.\n\n### Important Remarks\n\n#### Sanitization\n\nStrings are not to be sanitized beyond what is needed for the API itself. It is up to the client to sanitize api responses for its own uses.\n\n#### Date Format\n\nDates should be on the wire as ISO 8601 strings (`\"1975-08-19T23:15:30.000Z\"`). Team Manager stores all date-times as UTC so received\ndate-times will be saved as that, and responses will be returned as UTC ISO 8601 strings.\n\n#### Value Conversion\n\nThe API will do no conversion of values, which will be stored in the lowest precision required using the metric system. This includes currency, which will be stored in the lowest denomination. It's up to clients to use the context's settings to determine how to display each value.\n\n#### Location data\n\nResponses will format location data as per the GeoJSON format for \"Point\" (see spec [here](https://geojson.readthedocs.io/en/latest/#point))\n\n```json\n{\n \"location\": {\n \"type\": \"Point\",\n \"coordinates\": [0.0, 0.0]\n }\n}\n```\n\n## Request Limits\n\nIf you're requesting **very** frequently, a slowdown will be applied to your requests in a sliding time window.\nIf the limit is `X` requests per minute, and your request frequency goes over this, an additional\n`Y` milliseconds will be added **cumulativly per request** to the response time of each subsequent request until your request rate falls back below `X` per minute.\n\nIf your request frequency reaches a further limit, you will receive only an error response with the [429 http status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).\n\nWe reserve the right to adjust the limits, but you should never run into them during normal use. If you have a use case requiring an increased limit, please contact support.\n\n### Response Headers\n\nIf your requests are subject to rate limiting each response will have additional headers that conform to [the seventh draft of the IETF rate limit header specification](https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-ratelimit-headers-07).\n\nThis amounts to the following additional headers:\n\n- `ratelimit-policy`\n - example value: `200;w=300`\n - 200 requests within a 300 second window\n- `ratelimit`\n - example value: `limit=200, remaining=199, reset=300`\n - the limit is `200`, you have `199` left in the current timeframe, and it will reset after `300` seconds\n\nThese headers refer to limit of requests before you start receiving 429 errors. Request slowdown will happen before these limits are exceeded.\n\n## Error Handling\n\nD4H Team Manager REST API uses a common data contract for returnings error (HTTP 4xx and 5xx) responses - `statusCode` represents the HTTP code. `code` is a machine readable error. `message` is a user focused error message. An optional `data` property contains additional details, for example validation errors.\n\n### Specific Errors\n\n#### HTTP 429\n\n[429 http status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) - See [Request Limits](#request-limits) for details\n","x-logo":{"url":"public/img/d4h-logo-transparent.png","altText":"D4H logo","backgroundColor":"#00000000"}},"servers":[{"url":"https://api.team-manager.us.d4h.com"}],"paths":{"/v3/healthcheck":{"get":{"summary":"Retrieve a Healthcheck response","description":"Retrieve a Healthcheck response ","parameters":[],"responses":{"200":{"description":"A simple healthcheck","content":{"application/json":{"example":{"server":"ok","version":"7.0.1","database":"ok"}}}}},"tags":["Healthcheck"]}},"/v3/whoami":{"get":{"summary":"Retrieve credential access for all available contexts","description":"Retrieve credential access for all available contexts ","parameters":[],"security":[{"Unified":[]}],"responses":{"200":{"description":"Access details of credentials for all available contexts","content":{"application/json":{"example":{"account":{"id":1,"resourceType":"Account"},"members":[{"id":1,"owner":{"resourceType":"Team","id":1,"title":"Team Y","owner":{"id":4,"resourceType":"Organisation"}},"name":"Member X","hasAccess":true,"resourceType":"Member","permissions":{"Animal":{"READ":false,"CREATE":false,"DELETE":false,"EXPORT":false,"UPDATE":false},"Handler":{"READ":false,"CREATE":false,"DELETE":false,"EXPORT":false,"UPDATE":false},"AnimalGroup":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true,"EXPORT":false},"AnimalQualification":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"AnimalQualificationAward":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"ActivityAttendance":{"CREATE":false,"DELETE":false,"READ":false,"UPDATE":false,"UPDATEOWN":true},"Audit":{"CREATE":false,"DELETE":false,"READ":false},"BillingUnit":{"DELETE":false,"READ":false,"CREATE":false,"UPDATE":false,"EXPORT":false},"CustomerIdentifier":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Division":{"CREATE":true,"DEFAULT_ACCESS":true,"DELETE":true,"READ":true},"Document":{"CREATE_SECURE":false,"CREATE":false,"DELETE_SECURE":false,"DELETE":false,"DOWNLOAD_SECURE":false,"DOWNLOAD":false,"EXPORT_SECURE":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE_SECURE":false,"UPDATE":false},"Duty":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"EntityToCustomField":{"UPDATE":false},"Equipment":{"CREATE_CUSTOM_FIELDS":false,"CREATE":true,"DELETE_CUSTOM_FIELDS":false,"DELETE":true,"EXPORT":true,"READ_SECURE":false,"READ":true,"RETIRE":true,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_COSTING":false,"UPDATE_SECURE":false,"UPDATE":true,"UPDATE_STATUS":true},"EquipmentInspection":{"CREATE":true,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"EquipmentInspectionResult":{"CREATE":true,"DELETE":true,"DELETE_LIMITED":true,"EXPORT":true,"READ":true,"UPDATE":true,"UPDATE_RESULT":true},"EquipmentLocation":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Event":{"ARCHIVED":false,"CREATE":false,"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"DRAFT":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"Exercise":{"ARCHIVED":false,"CREATE":false,"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"DRAFT":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"HandlerGroup":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true,"EXPORT":false},"HandlerQualification":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"HandlerQualificationAward":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"HealthSafetyCategory":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"HealthSafetyReport":{"APPROVE":false,"CREATE_SECURE":false,"CREATE":false,"DELETE":false,"EXPORT":false,"READ_SECURE":false,"READ":false,"UPDATE_SECURE":false,"UPDATE":false},"HealthSafetySeverity":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Incident":{"ARCHIVED":false,"CREATE":false,"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"DRAFT":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"LocationBookmark":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Member":{"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"CREATE":false,"DELETE_CUSTOM_FIELDS":false,"DELETE":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"RETIRE":true,"UPDATE_COSTING":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false,"UPDATE":false,"UPDATEOWN":false},"MemberCustomStatus":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true},"MemberGroup":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true,"EXPORT":false},"MemberQualification":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"MemberQualificationAward":{"ARCHIVED":false,"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"OfficerPermissionProfile":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"PermissionProfile":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"PersonInvolved":{"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"CREATE":false,"DELETE_CUSTOM_FIELDS":false,"DELETE":false,"EXPORT":false,"READ_SECURE":false,"READ":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false,"UPDATE":false},"Repair":{"ASSIGN_UNASSIGNED":false,"CREATE":true,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true,"UPDATEOWN":false},"Resource":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Role":{"CREATE":false,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true},"Setting":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":true,"UPDATE":true},"Tag":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Task":{"CREATE":true,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true},"TaskAssignment":{"CREATE":true,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true},"Team":{"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"Whiteboard":{"ARCHIVED":false,"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false,"UPDATEOWN":false}}}],"officers":[{"id":1,"owner":{"resourceType":"Organisation","id":1,"title":"Org Z"},"name":"Officer X","hasAccess":true,"resourceType":"Officer","permissions":{"Animal":{"READ":false,"CREATE":false,"DELETE":false,"EXPORT":false,"UPDATE":false},"Handler":{"READ":false,"CREATE":false,"DELETE":false,"EXPORT":false,"UPDATE":false},"AnimalGroup":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true,"EXPORT":false},"AnimalQualification":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"AnimalQualificationAward":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"ActivityAttendance":{"CREATE":false,"DELETE":false,"READ":true,"UPDATE":false,"UPDATEOWN":false},"Audit":{"CREATE":false,"DELETE":false,"READ":false},"BillingUnit":{"DELETE":false,"READ":false,"CREATE":false,"UPDATE":false,"EXPORT":false},"CustomerIdentifier":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Division":{"CREATE":true,"DEFAULT_ACCESS":true,"DELETE":true,"READ":true},"Document":{"CREATE_SECURE":false,"CREATE":false,"DELETE_SECURE":false,"DELETE":false,"DOWNLOAD_SECURE":false,"DOWNLOAD":false,"EXPORT_SECURE":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE_SECURE":false,"UPDATE":false},"Duty":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"EntityToCustomField":{"UPDATE":false},"Equipment":{"CREATE_CUSTOM_FIELDS":false,"CREATE":true,"DELETE_CUSTOM_FIELDS":false,"DELETE":true,"EXPORT":true,"READ_SECURE":false,"READ":true,"RETIRE":true,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false,"UPDATE":true},"EquipmentInspection":{"CREATE":true,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"EquipmentInspectionResult":{"CREATE":true,"DELETE":true,"DELETE_LIMITED":true,"EXPORT":true,"READ":true,"UPDATE":true,"UPDATE_RESULT":true},"EquipmentLocation":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Event":{"ARCHIVED":false,"CREATE":false,"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"DRAFT":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"Exercise":{"ARCHIVED":false,"CREATE":false,"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"DRAFT":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"HandlerGroup":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true,"EXPORT":false},"HandlerQualification":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"HandlerQualificationAward":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"HealthSafetyCategory":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"HealthSafetyReport":{"APPROVE":false,"CREATE_SECURE":false,"CREATE":false,"DELETE":false,"EXPORT":false,"READ_SECURE":false,"READ":false,"UPDATE_SECURE":false,"UPDATE":false},"HealthSafetySeverity":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Incident":{"ARCHIVED":false,"CREATE":false,"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"DRAFT":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"LocationBookmark":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Member":{"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"CREATE":false,"DELETE_CUSTOM_FIELDS":false,"DELETE":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"RETIRE":true,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false,"UPDATE":false,"UPDATEOWN":false},"MemberCustomStatus":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true},"MemberGroup":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true,"EXPORT":false},"MemberQualification":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"MemberQualificationAward":{"ARCHIVED":false,"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Officer":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":true,"UPDATE":false,"UPDATEOWN":false},"OfficerPermissionProfile":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"PermissionProfile":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"PersonInvolved":{"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"CREATE":false,"DELETE_CUSTOM_FIELDS":false,"DELETE":false,"EXPORT":false,"READ_SECURE":false,"READ":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false,"UPDATE":false},"Repair":{"ASSIGN_UNASSIGNED":false,"CREATE":true,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true,"UPDATEOWN":false},"Resource":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Role":{"CREATE":false,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true},"Setting":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":true,"UPDATE":true},"Tag":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Task":{"CREATE":true,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true},"TaskAssignment":{"CREATE":true,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true},"Team":{"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"Whiteboard":{"ARCHIVED":false,"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false,"UPDATEOWN":false}}}]}}}}},"tags":["Accounts / Credentials"]}},"/v3/organisation/{organisationId}/settings":{"get":{"summary":"Retrieve organisation settings","description":"Retrieve organisation settings

**Required modules:** ","parameters":[{"description":"An organisation id","in":"path","required":true,"name":"organisationId","schema":{"type":["integer"],"minimum":1,"description":"An organisation id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of organisation settings","content":{"application/json":{"example":{"results":[{"allowTeamOverride":true,"canChange":true,"key":"MODULE_ENABLED_ACTIVITIES","resourceType":"Setting","value":true,"valueForTeams":true},{"allowTeamOverride":true,"canChange":true,"key":"WEEK_START","resourceType":"Setting","value":"sunday","valueForTeams":"monday"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Settings"]}},"/v3/organisation/{organisationId}/teams":{"get":{"summary":"Retrieve a list of teams","description":"Retrieve a list of teams

**Required modules:** ","parameters":[{"description":"An organisation id","in":"path","required":true,"name":"organisationId","schema":{"type":["integer"],"minimum":1,"description":"An organisation id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of teams","content":{"application/json":{"example":{"results":[{"id":1,"globalSyncId":"62a68dac60b511f09c4a325096b39f47","owner":{"id":1,"resourceType":"Organisation"},"title":"Task Force Llama","location":{"type":"Point","coordinates":[0,0]},"memberCounts":{"total":192,"operational":89},"timezone":"America/New_York","country":"CA","deletedAt":null,"overview":"Some text about the team","createdAt":"2021-10-08T15:55:27.000Z","updatedAt":"2022-12-27T18:05:51.000Z","subdomain":"task-force-llama","resourceType":"Team"}],"page":0,"totalSize":1,"pageSize":1}}}}},"tags":["Teams"]}},"/v3/team/{teamId}/animal-group-memberships":{"post":{"summary":"Create an animal group membership","description":"Create an animal group membership ","parameters":[{"description":"Team's id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Team's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"groupId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The group's identifier"},"animalId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The animal's identifier"}},"required":["groupId","animalId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An animal group membership","content":{"application/json":{"example":{"id":1,"owner":{"resourceType":"Team","id":1},"group":{"resourceType":"AnimalGroup","id":1},"animal":{"resourceType":"Animal","id":1},"resourceType":"AnimalGroupMembership","createdAt":"2026-07-03T06:46:50.654Z","updatedAt":"2026-07-03T06:46:50.654Z"}}}}},"tags":["Group Memberships"]}},"/v3/team/{teamId}/attendance":{"post":{"summary":"Create an activity attendance","description":"Create an activity attendance

**Required modules:** activities,members","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"oneOf":[{"type":["integer"],"minimum":1},{"type":["string"],"minLength":32,"maxLength":32,"pattern":"^[0-9a-f]{32}$","description":"A global resource identifier for cross-product sync"}],"description":"A team id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"memberId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"activityId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"status":{"default":"REQUESTED","type":["string"],"enum":["ABSENT","ATTENDING","REQUESTED"],"description":"The status of the attendance resource"},"roleId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"startsAt":{"description":"An ISO8601 datetime string","type":["string"],"format":"date-time"},"endsAt":{"description":"An ISO8601 datetime string","type":["string"],"format":"date-time"}},"required":["memberId","activityId","startsAt","endsAt"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An activity attendance","content":{"application/json":{"example":{"activity":{"resourceType":"Incident","id":1},"createdAt":"2026-07-03T06:46:50.671Z","duration":1,"endsAt":"2026-07-03T06:46:50.671Z","id":1,"member":{"resourceType":"Member","id":1},"owner":{"resourceType":"Team","id":1},"startsAt":"2026-07-03T06:46:50.671Z","status":"ABSENT","resourceType":"ActivityAttendance","role":{"id":1,"resourceType":"Role"},"updatedAt":"2026-07-03T06:46:50.671Z"}}}}},"tags":["Activity Attendance"]}},"/v3/team/{teamId}/equipment-locations":{"post":{"summary":"Create an equipment location","description":"Create an equipment location

**Required modules:** equipment","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1},"deprecatedBundle":{"type":["string"],"minLength":1,"maxLength":50,"description":"The bundle of a resource"},"description":{"type":["string"],"description":"The description of a resource"},"address":{"type":["object"],"properties":{"country":{"type":["string"],"description":"Country"},"postcode":{"type":["string"],"maxLength":100,"description":"Postcode or ZIP code"},"region":{"type":["string"],"maxLength":100,"description":"Province, county or region"},"street":{"type":["string"],"maxLength":100,"description":"Number, street and house"},"town":{"type":["string"],"maxLength":100,"description":"City or town"}}},"location":{"type":["object","null"],"properties":{"latitude":{"type":["number"],"minimum":-90,"maximum":90,"description":"The latitude where this entity is located"},"longitude":{"type":["number"],"minimum":-180,"maximum":180,"description":"The longitude where this entity is located"}},"required":["latitude","longitude"]}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"The created equipment location","content":{"application/json":{"example":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"}}}}},"tags":["Equipment Locations"]}},"/v3/team/{teamId}/handler-group-memberships":{"post":{"summary":"Create a handler group membership","description":"Create a handler group membership ","parameters":[{"description":"Team's id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Team's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"groupId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The group's identifier"},"handlerId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The handler's identifier"}},"required":["groupId","handlerId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A handler group membership","content":{"application/json":{"example":{"id":1,"owner":{"resourceType":"Team","id":1},"group":{"resourceType":"HandlerGroup","id":1},"handler":{"resourceType":"Handler","id":1},"resourceType":"HandlerGroupMembership","createdAt":"2026-07-03T06:46:50.695Z","updatedAt":"2026-07-03T06:46:50.695Z"}}}}},"tags":["Group Memberships"]}},"/v3/team/{teamId}/health-safety-reports":{"post":{"summary":"Create a Health & Safety Report","description":"Create a Health & Safety Report

**Required modules:** healthsafety","parameters":[{"description":"Team's id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Team's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"targetResourceId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of an associated resource"},"targetResourceType":{"type":["string"],"enum":["Incident","Event","Exercise"],"description":"The resource-type associated with the report"},"address":{"type":["object"],"properties":{"country":{"type":["string"],"maxLength":100,"description":"The country where this occurance took place"},"postcode":{"type":["string"],"maxLength":100,"description":"The postcode where this occurance took place"},"region":{"type":["string"],"maxLength":100,"description":"The region where this occurance took place"},"street":{"type":["string"],"maxLength":100,"description":"The street where this occurance took place"},"town":{"type":["string"],"maxLength":100,"description":"The town where this occurance took place"}}},"categoryId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A Health & Safety Category ID"},"cause":{"type":["string","null"],"description":"The cause of this occurance"},"startsAt":{"description":"The date-time of this occurance","type":["string","null"],"format":"date-time"},"description":{"type":["string","null"],"description":"The description of this occurance"},"location":{"type":["object"],"properties":{"lat":{"type":["number","null"],"minimum":-90,"maximum":90,"description":"The latitude where this occurance took place"},"lng":{"type":["number","null"],"minimum":-180,"maximum":180,"description":"The longtitude where this occurance took place"}},"required":["lat","lng"]},"measures":{"type":["string","null"],"description":"The measures taken because of this occurance"},"severityId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A Health & Safety Severity ID"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}},"required":["categoryId","severityId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A Health & Safety Report","content":{"application/json":{"example":{"targetResource":{"id":1,"resourceType":"Incident"},"address":{"country":"","postcode":"","region":"","street":"","town":""},"approvedAt":"2026-07-03T06:46:43.215Z","category":{"id":1,"resourceType":"HealthSafetyCategory"},"cause":"Some cause","createdAt":"2026-07-03T06:46:43.215Z","startsAt":"2026-07-03T06:46:43.215Z","description":"","id":1,"location":{"type":"Point","coordinates":[0,0]},"measures":"","resourceType":"HealthSafetyReport","severity":{"id":1,"resourceType":"HealthSafetySeverity"},"owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:43.215Z","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Health & Safety"]}},"/v3/team/{teamId}/incident-involved-injuries":{"post":{"summary":"Create a record of a person involved injury","description":"Create a record of a person involved injury

**Required modules:** persons_involved_medical","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"personInvolvedId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Person involved id"},"injuryLocationId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Injury location id (see enum endpoint)"},"injuryTypeId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Injury type id (see enum endpoint)"}},"required":["personInvolvedId","injuryLocationId","injuryTypeId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A person involved injury","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:50Z","id":1,"injury":{"id":30,"title":"Face","category":"HEAD"},"injuryType":{"id":12,"title":"Sprain","bundle":"MUSCULOSKELETAL","location":"ANY"},"owner":{"id":1,"resourceType":"Team"},"person":{"resourceType":"PersonInvolved","id":1},"resourceType":"PersonInvolvedInjury","updatedAt":"2026-07-03T06:46:50Z"}}}}},"tags":["Incidents"]}},"/v3/team/{teamId}/incident-involved-persons":{"post":{"summary":"Create a record of a person involved in an incident","description":"Create a record of a person involved in an incident

**Required modules:** persons_involved","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"age":{"type":["integer"],"exclusiveMinimum":0,"maximum":666,"description":"Person age"},"areaKnowledge":{"type":["string"],"enum":["UNFAMILIAR","FAMILIAR"],"description":"Is person familiar with the locality"},"assistance":{"type":["string"],"maxLength":65535,"description":"Notes on medical assistance"},"cause":{"default":"NO_DATA","type":["string"],"enum":["NO_DATA","ACCIDENTAL","INTENTIONAL_SELF","INTENTIONAL_OTHER","UNDETERMINED"],"description":"Cause information"},"contact":{"type":["string"],"maxLength":65535,"description":"Contact information"},"dateOfBirth":{"type":["string"],"description":"Date of birth"},"handover":{"type":["string"],"enum":["NO_FURTHER_ASSISTANCE","HOSPITAL","ONSITE_FACILITY"],"description":"Handover information"},"incidentId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Incident's resource id"},"involvementNotes":{"description":"Involvement notes","type":["string"],"maxLength":65535},"involvementTypeId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Person involved involvement type id. Some involvement types also require an outcomeId. See enum endpoint for details."},"name":{"type":["string"],"maxLength":100,"description":"Person's name"},"nationality":{"type":["string"],"enum":["AF","AL","DZ","AD","AO","AG","AR","AM","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BT","BO","BA","BW","BR","BN","BG","BF","BI","KH","CM","CA","CV","CF","TD","CL","CN","CO","KM","CG","CD","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FJ","FI","FR","GA","GM","GE","DE","GH","GR","GD","GT","GN","GW","GY","HT","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KR","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MR","MU","MX","FM","MD","MC","MN","MA","MZ","MM","NA","NR","NP","NL","NZ","NI","NE","NG","NO","OM","PK","PW","PA","PG","PY","PE","PH","PL","PT","QA","RO","RU","RW","KN","LC","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","ES","LK","SD","SR","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TO","TT","TN","TR","TM","TV","UG","UA","AE","GB","US","UY","UZ","VU","VE","VN","VG","YE","ZM","ZW","XK"],"description":"Country code representing person's nationality"},"outcomeId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Person involved outcome id. Only applicable to certain involvement types. See enum endpoint for details."},"sex":{"type":["string"],"enum":["MALE","FEMALE","OTHER"],"description":"The person's sex"},"spinalInjury":{"default":"UNDETERMINED","type":["string"],"enum":["SUSPECTED","CLEARED","NOT_INDICATED","UNDETERMINED"],"description":"Spinal injury status"},"transfer":{"type":["string"],"enum":["SELF","HOSPITAL"],"description":"How they were transferred to hospital"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}},"required":["incidentId","involvementTypeId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A person involved in an incident","content":{"application/json":{"example":{"incident":{"resourceType":"Incident","id":1},"age":21,"areaKnowledge":"UNFAMILIAR","cause":"UNDETERMINED","contact":"Joe Duffy, call this number 123456789 and talk to Joe","createdAt":"2026-07-03T06:46:50Z","dateOfBirth":"1990-01-01","handover":"HOSPITAL","id":1,"involvementNotes":"Some involvement notes","involvementType":{"id":1,"title":"Victim"},"injuries":[{"createdAt":"2026-07-03T06:46:50Z","id":1,"injury":{"id":30,"title":"Face","category":"HEAD"},"injuryType":{"id":12,"title":"Sprain","bundle":"MUSCULOSKELETAL","location":"ANY"},"owner":{"id":1,"resourceType":"Team"},"person":{"resourceType":"PersonInvolved","id":1},"resourceType":"PersonInvolvedInjury","updatedAt":"2026-07-03T06:46:50Z"}],"name":"John Doe","nationality":"US","assistance":"Medical assistance notes","owner":{"id":1,"resourceType":"Team"},"outcome":{"id":4,"title":"Life Saved"},"resourceType":"PersonInvolved","sex":"MALE","spinalInjury":"SUSPECTED","transfer":"HOSPITAL","updatedAt":"2026-07-03T06:46:50Z","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Incidents"]}},"/v3/team/{teamId}/member-group-memberships":{"post":{"summary":"Create a member group membership","description":"Create a member group membership ","parameters":[{"description":"Team's id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Team's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"groupId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The group's identifier"},"memberId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The member's identifier"}},"required":["groupId","memberId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A member group membership","content":{"application/json":{"example":{"id":1,"owner":{"resourceType":"Team","id":1},"group":{"resourceType":"MemberGroup","id":1},"member":{"resourceType":"Member","id":1},"resourceType":"MemberGroupMembership","createdAt":"2026-07-03T06:46:50.741Z","updatedAt":"2026-07-03T06:46:50.741Z"}}}}},"tags":["Group Memberships"]}},"/v3/team/{teamId}/settings":{"get":{"summary":"Retrieve team settings","description":"Retrieve team settings

**Required modules:** ","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"oneOf":[{"type":["integer"],"minimum":1},{"type":["string"],"minLength":32,"maxLength":32,"pattern":"^[0-9a-f]{32}$","description":"A global resource identifier for cross-product sync"}],"description":"A team id"}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of team settings","content":{"application/json":{"example":{"results":[{"canChange":true,"key":"MODULE_ENABLED_ACTIVITIES","resourceType":"Setting","value":true},{"canChange":true,"key":"WEEK_START","resourceType":"Setting","value":"sunday"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Settings"]}},"/v3/team/{teamId}/task-assignments":{"post":{"summary":"Create a task assignment","description":"Create a task assignment

**Required modules:** tasks","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A task assignment","content":{"application/json":{"example":{"id":1,"task":{"resourceType":"Task","id":5},"assignee":{"resourceType":"Member","id":10},"completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"TaskAssignment"}}}}},"tags":["Tasks"]}},"/v3/team/{teamId}/tasks":{"post":{"summary":"Create a task","description":"Create a task

**Required modules:** tasks","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"ref":{"type":["string"],"minLength":1,"maxLength":40,"description":"The task resource ref"},"description":{"type":["string"],"description":"Description of task resource"},"targetResourceId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"ID of the resource the task is assigned to"},"targetResourceType":{"type":["string"],"enum":["AnimalGroup","Equipment","EquipmentBrand","EquipmentCategory","EquipmentFund","EquipmentInspection","EquipmentKind","EquipmentLocation","EquipmentModel","EquipmentSupplier","EquipmentSupplierRef","Event","Exercise","Folder","HandlerGroup","HealthSafetyReport","Incident","Member","MemberGroup","MemberQualification","Resource","Tag"],"description":"Resource types that can be associated with a task"},"dueAt":{"description":"Date task resource is due","type":["string","null"],"format":"date-time"},"status":{"default":"NOT_STARTED","type":["string"],"enum":["NOT_STARTED","IN_PROGRESS","COMPLETED"],"description":"Status of task"},"completionType":{"default":"ANY","type":["string"],"enum":["ANY"],"description":"Completion type of task"}},"required":["ref"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A task","content":{"application/json":{"example":{"id":1,"ref":"TASK-001","description":"Example task description","completionType":"ANY","assigned":[{"id":1,"task":{"resourceType":"Task","id":1},"assignee":{"resourceType":"Member","id":5},"completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"TaskAssignment"}],"createdBy":{"resourceType":"Member","id":5},"targetResource":{"resourceType":"Event","id":15},"dueAt":"2023-12-31T23:59:59.000Z","completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"Task"}}}}},"tags":["Tasks"]}},"/v3/{context}/{contextId}/animal-group-memberships":{"get":{"summary":"Retrieve a list of animal group memberships","description":"Retrieve a list of animal group memberships

**Required modules:** groups","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"One or more team identifiers","in":"query","name":"team_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more team identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more group identifiers","in":"query","name":"group_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more group identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more animal identifiers","in":"query","name":"animal_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more animal identifiers","type":"array","items":{"type":"number"}}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of animal group memberships","content":{"application/json":{"example":{"results":[{"id":1,"owner":{"resourceType":"Team","id":1},"group":{"resourceType":"AnimalGroup","id":1},"animal":{"resourceType":"Animal","id":1},"resourceType":"AnimalGroupMembership","createdAt":"2026-07-03T06:46:50.654Z","updatedAt":"2026-07-03T06:46:50.654Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Group Memberships"]}},"/v3/{context}/{contextId}/animal-groups":{"get":{"summary":"Retrieve a list of animal groups","description":"Retrieve a list of animal groups

**Required modules:** groups","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"One or more team identifiers","in":"query","name":"team_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more team identifiers","type":"array","items":{"type":"number"}}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"description":"A simple text search term, compared against the title"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of animal Groups","content":{"application/json":{"example":{"results":[{"id":1,"title":"Hundreds of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Animal","owner":{"resourceType":"Team","id":1},"resourceType":"AnimalGroup","createdAt":"2026-07-03T06:46:50.795Z","updatedAt":"2026-07-03T06:46:50.795Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Groups"]},"post":{"summary":"Create an animal group","description":"Create an animal group ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":50,"description":"The group's title"},"deprecatedBundle":{"type":["string"],"minLength":1,"maxLength":50,"description":"The group's bundle title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An animal group","content":{"application/json":{"example":{"id":1,"title":"Hundreds of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Animal","owner":{"resourceType":"Team","id":1},"resourceType":"AnimalGroup","createdAt":"2026-07-03T06:46:50.795Z","updatedAt":"2026-07-03T06:46:50.795Z"}}}}},"tags":["Groups"]}},"/v3/{context}/{contextId}/animal-qualifications":{"get":{"summary":"Retrieve a list of animal qualifications","description":"Retrieve a list of animal qualifications ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"The title of a resource","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"The title of a resource"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of animal qualifications","content":{"application/json":{"example":{"page":0,"pageSize":1,"totalSize":1,"results":[{"id":8,"owner":{"id":2,"resourceType":"Team"},"title":"Hat Wearing","description":"Dogs need help with hats","cost":123,"expiredCost":null,"deprecatedBundle":"Some bundle","expiresMonthsDefault":null,"reminderDays":30,"createdAt":"2026-07-03T06:46:50.801Z","updatedAt":"2026-07-03T06:46:50.801Z","resourceType":"AnimalQualification"}]}}}}},"tags":["Qualifications"]}},"/v3/{context}/{contextId}/animals":{"get":{"summary":"Retrieve a list of animals","description":"Retrieve a list of animals

**Required modules:** animals","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"The numeric identifier for a resource","in":"query","name":"team_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},{"description":"The member id or ids of the animal's handler(s)","in":"query","name":"handler_member_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"The member id or ids of the animal's handler(s)","type":"array","items":{"type":"number"}}},{"description":"The status of the animal","in":"query","name":"status","required":false,"schema":{"type":["string"],"enum":["OPERATIONAL","NON_OPERATIONAL"],"description":"The status of the animal"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of animals","content":{"application/json":{"example":{"results":[{"id":1,"name":"Bessie","breed":"Lab","type":"DOG","countRollingHours":12,"owner":{"resourceType":"Team","id":1},"ref":"0000123","notes":"None","status":"OPERATIONAL","resourceType":"Animal","bornAt":"2026-07-03T06:46:50.810Z","joinedAt":"2026-07-03T06:46:50.810Z","leftAt":null,"createdAt":"2026-07-03T06:46:50.810Z","updatedAt":"2026-07-03T06:46:50.810Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Animals"]}},"/v3/{context}/{contextId}/attendance":{"get":{"summary":"Retrieve a list of activity attendances","description":"Retrieve a list of activity attendances

**Required modules:** activities,members","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"One or more member resource identifiers","in":"query","name":"member_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more member resource identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more activity resource identifiers","in":"query","name":"activity_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more activity resource identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more role resource identifiers","in":"query","name":"role_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more role resource identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more activity resource types","in":"query","name":"activity_resource_type","required":false,"schema":{"description":"One or more activity resource types","oneOf":[{"type":["string"],"enum":["Event","Exercise","Incident"],"description":"The activity resource type"},{"type":["array"],"items":{"type":["string"],"enum":["Event","Exercise","Incident"],"description":"The activity resource type"}}]}},{"description":"One or more attendance statuses","in":"query","name":"status","required":false,"schema":{"description":"One or more attendance statuses","oneOf":[{"type":["string"],"enum":["ABSENT","ATTENDING","REQUESTED"],"description":"The status of the attendance resource"},{"type":["array"],"items":{"type":["string"],"enum":["ABSENT","ATTENDING","REQUESTED"],"description":"The status of the attendance resource"}}]}},{"description":"Return only resources starting before this datetime","in":"query","name":"starts_before","required":false,"schema":{"description":"Return only resources starting before this datetime","type":["string"],"format":"date-time"}},{"description":"Return only resources starting after this datetime","in":"query","name":"starts_after","required":false,"schema":{"description":"Return only resources starting after this datetime","type":["string"],"format":"date-time"}},{"description":"Return only resources ending before this datetime","in":"query","name":"ends_before","required":false,"schema":{"description":"Return only resources ending before this datetime","type":["string"],"format":"date-time"}},{"description":"Return only resources ending after this datetime","in":"query","name":"ends_after","required":false,"schema":{"description":"Return only resources ending after this datetime","type":["string"],"format":"date-time"}},{"description":"Return only attendances from deleted activities","in":"query","name":"deleted","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Return only attendances from deleted activities"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","startsAt"]}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of activity attendances","content":{"application/json":{"example":{"results":[{"activity":{"resourceType":"Incident","id":1},"createdAt":"2026-07-03T06:46:50.671Z","duration":1,"endsAt":"2026-07-03T06:46:50.671Z","id":1,"member":{"resourceType":"Member","id":1},"owner":{"resourceType":"Team","id":1},"startsAt":"2026-07-03T06:46:50.671Z","status":"ABSENT","resourceType":"ActivityAttendance","role":{"id":1,"resourceType":"Role"},"updatedAt":"2026-07-03T06:46:50.671Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Activity Attendance"]}},"/v3/{context}/{contextId}/custom-field-options":{"post":{"summary":"Create a custom field option for a CHOICE type field","description":"Create a custom field option for a CHOICE type field ","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"customFieldId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"label":{"type":["string"],"maxLength":150},"archived":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether this option is available or not"},"ordering":{"default":255,"type":["integer"],"maximum":4294967295,"minimum":0}},"required":["customFieldId","label"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A custom field option","content":{"application/json":{"example":{"id":43,"ordering":0,"customField":{"id":2,"resourceType":"CustomField"},"label":"Eius.","archivedAt":null,"owner":{"id":2,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:43.199Z","updatedAt":"2026-07-03T06:46:43.199Z"}}}}},"tags":["Custom Fields"]}},"/v3/{context}/{contextId}/custom-fields":{"get":{"summary":"Retrieve a list of custom fields","description":"Retrieve a list of custom fields ","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A resource type that supports custom fields","in":"query","name":"target_resource_type","required":false,"schema":{"description":"A resource type that supports custom fields","oneOf":[{"type":["string"],"enum":["Event","Exercise","Incident","IncidentWeather","Equipment","HealthSafetyReport","Member","PersonInvolved","Team"],"description":"A resource type that supports custom fields"},{"type":["array"],"items":{"type":["string"],"enum":["Event","Exercise","Incident","IncidentWeather","Equipment","HealthSafetyReport","Member","PersonInvolved","Team"],"description":"A resource type that supports custom fields"}}]}},{"description":"Filter returned custom fields by their archived status","in":"query","name":"archived","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Filter returned custom fields by their archived status"}},{"description":"A resource-bundle id. Use null to get un-bundled fields","in":"query","name":"resource_bundle_id","required":false,"schema":{"description":"A resource-bundle id. Use null to get un-bundled fields","oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"]}},{"description":"- `UNRESTRICTED`: No extra permissions required\n- `RESTRICTED`: Extra permissions required","in":"query","name":"restricted","required":false,"schema":{"type":["string"],"enum":["UNRESTRICTED","RESTRICTED"],"description":"- `UNRESTRICTED`: No extra permissions required\n- `RESTRICTED`: Extra permissions required"}},{"description":"- `HIDDEN`: Member cannot view own data\n- `EDITABLE`: Member can edit own data\n- `VIEWABLE`: Member can view own data","in":"query","name":"member_privacy","required":false,"schema":{"type":["string"],"enum":["HIDDEN","EDITABLE","VIEWABLE"],"description":"- `HIDDEN`: Member cannot view own data\n- `EDITABLE`: Member can edit own data\n- `VIEWABLE`: Member can view own data"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","ordering"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of custom fields","content":{"application/json":{"example":{"results":[{"id":93,"owner":{"id":1,"resourceType":"Team"},"targetResourceType":"Equipment","ordering":255,"title":"Rem corporis doloribus et neque rerum.","type":"TEXT","restricted":"UNRESTRICTED","memberPrivacy":"VIEWABLE","hint":null,"bundle":{"id":5,"resourceType":"ResourceBundle"},"searchable":false,"mandatory":false,"frozen":false,"archivedAt":null,"createdAt":"2026-07-03T06:46:43.200Z","updatedAt":"2026-07-03T06:46:43.200Z","options":[{"id":43,"ordering":0,"customField":{"id":2,"resourceType":"CustomField"},"label":"Eius.","archivedAt":null,"owner":{"id":2,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:43.199Z","updatedAt":"2026-07-03T06:46:43.199Z"}],"resourceType":"CustomField","valueUnits":null}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Custom Fields"]},"post":{"summary":"Create a custom field","description":"Create a custom field ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"targetResourceType":{"type":["string"],"enum":["Event","Exercise","Incident","IncidentWeather","Equipment","HealthSafetyReport","Member","PersonInvolved","Team"],"description":"A resource type that supports custom fields"},"ordering":{"default":0,"type":["integer"],"minimum":0,"maximum":4294967295,"description":"A user-specified order in which to present the resources"},"title":{"type":["string"],"minLength":1,"maxLength":150,"pattern":"^(?!.*\\|).+$","description":"The title of a resource"},"restricted":{"default":"RESTRICTED","type":["string"],"enum":["UNRESTRICTED","RESTRICTED"],"description":"- `UNRESTRICTED`: No extra permissions required\n- `RESTRICTED`: Extra permissions required"},"memberPrivacy":{"default":"HIDDEN","type":["string"],"enum":["HIDDEN","EDITABLE","VIEWABLE"],"description":"- `HIDDEN`: Member cannot view own data\n- `EDITABLE`: Member can edit own data\n- `VIEWABLE`: Member can view own data"},"hint":{"type":["string"],"maxLength":65535,"description":"A hint to show users of the field"},"resourceBundleId":{"type":["integer","null"],"minimum":1,"maximum":2147483647,"description":"A resource bundle id"},"searchable":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether the field should be included in its parent's (targetResourceType) entity search index or not. Field must also be `UNRESTRICTED`."},"mandatory":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether this field will be required in order to create/approve the attached entity or not"},"archived":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether this field is enabled or not for the target entities"},"type":{"type":["string"],"enum":["DATE","DATETIME","MULTIPLE_CHOICE","NUMBER","SINGLE_CHOICE","TEXT","TEXT_AREA","TIME"],"description":"- `DATE`: A date with no time component\n- `DATETIME`: A standard date-time\n- `MULTIPLE_CHOICE`: Allows selection of multiple custom-field-options\n- `NUMBER`: A numeric value\n- `SINGLE_CHOICE`: Allows selection of a single custom-field-option\n- `TEXT`: Plaintext, generally used for short single-line text\n- `TEXT_AREA`: Plaintext, generally used larger bodies of text\n- `TIME`: A time of day with no date component"},"options":{"type":["array"],"items":{"type":["object"],"properties":{"label":{"type":["string"],"minLength":1,"maxLength":150},"ordering":{"default":0,"type":["integer"],"minimum":0,"maximum":4294967295}},"required":["label"]},"description":"For enumerated custom field types (`SINGLE_CHOICE`, `MULTIPLE_CHOICE`), the options to choose from"},"valueUnits":{"description":"Text description of what a numerical value represents. Can only be used with type `NUMBER`","type":["string"],"minLength":1,"maxLength":10}},"required":["targetResourceType","title","type"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A custom field","content":{"application/json":{"example":{"id":93,"owner":{"id":1,"resourceType":"Team"},"targetResourceType":"Equipment","ordering":255,"title":"Rem corporis doloribus et neque rerum.","type":"TEXT","restricted":"UNRESTRICTED","memberPrivacy":"VIEWABLE","hint":null,"bundle":{"id":5,"resourceType":"ResourceBundle"},"searchable":false,"mandatory":false,"frozen":false,"archivedAt":null,"createdAt":"2026-07-03T06:46:43.200Z","updatedAt":"2026-07-03T06:46:43.200Z","options":[{"id":43,"ordering":0,"customField":{"id":2,"resourceType":"CustomField"},"label":"Eius.","archivedAt":null,"owner":{"id":2,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:43.199Z","updatedAt":"2026-07-03T06:46:43.199Z"}],"resourceType":"CustomField","valueUnits":null}}}}},"tags":["Custom Fields"]}},"/v3/{context}/{contextId}/customer-identifiers":{"get":{"summary":"Retrieve the customer identifier for this context","description":"Retrieve the customer identifier for this context ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The Customer Identifiers this context has","content":{"application/json":{"example":{"results":[{"id":1,"identifier":"CI-LK99","resourceType":"CustomerIdentifier"}],"page":0,"pageSize":10,"totalSize":1}}}}},"tags":["Customer Identifiers"]}},"/v3/{context}/{contextId}/documents":{"get":{"summary":"Retrieve a list of documents","description":"Retrieve a list of documents

**Required modules:** ","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}],"description":"A list of ids"}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"A simple text search term, compared against the title"}},{"description":"- `UNRESTRICTED`: No extra permissions required\n- `RESTRICTED`: Extra permissions required","in":"query","name":"restricted","required":false,"schema":{"type":["string"],"enum":["UNRESTRICTED","RESTRICTED"],"description":"- `UNRESTRICTED`: No extra permissions required\n- `RESTRICTED`: Extra permissions required"}},{"description":"Whether return or exclude profile documents ","in":"query","name":"profile","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Whether return or exclude profile documents "}},{"in":"query","name":"target_resource_type","required":true,"schema":{"type":["array"],"items":{"type":["string"],"enum":["Animal","AnimalGroup","AnimalQualification","AnimalQualificationAward","Equipment","EquipmentBrand","EquipmentCategory","EquipmentModel","EquipmentKind","EquipmentSupplier","EquipmentSupplierRef","Event","Exercise","Folder","Handler","HandlerGroup","HandlerQualification","HandlerQualificationAward","HealthSafetyReport","Incident","EquipmentInspection","EquipmentInspectionResult","Member","MemberGroup","MemberQualification","MemberQualificationAward","Repair","Resource","Tag","Task","Team"],"description":"A resource type that supports attaching documents"}}},{"description":"The related resource id","in":"query","name":"target_resource_id","required":false,"schema":{"description":"The related resource id","oneOf":[{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}]},{"type":["string"],"enum":["null"]}],"type":["null"]}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of documents","content":{"application/json":{"example":{"results":[{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A document","createdAt":"2026-07-03T06:46:50.937Z","updatedAt":"2026-07-03T06:46:50.937Z","description":"","targetResource":{"id":1,"resourceType":"Equipment","deleted":false},"restricted":"UNRESTRICTED","profile":1,"downloads":1,"avScanStatus":"SAFE","availableSizes":["ORIGINAL","PREVIEW","THUMBNAIL"],"fileExt":"txt","fileType":"text/txt","fileSize":100,"revision":1,"createdBy":{"id":1,"resourceType":"Member"},"resourceType":"Document"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Documents"]},"post":{"summary":"Upload a document","description":"Upload a document

**Required modules:** ","parameters":[],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":256,"description":"The document's name"},"targetResourceType":{"type":["string"],"enum":["Animal","AnimalGroup","AnimalQualification","AnimalQualificationAward","Equipment","EquipmentBrand","EquipmentCategory","EquipmentModel","EquipmentKind","EquipmentSupplier","EquipmentSupplierRef","Event","Exercise","Folder","Handler","HandlerGroup","HandlerQualification","HandlerQualificationAward","HealthSafetyReport","Incident","EquipmentInspection","EquipmentInspectionResult","Member","MemberGroup","MemberQualification","MemberQualificationAward","Repair","Resource","Tag","Task","Team"],"description":"A resource type that supports attaching documents"},"targetResourceId":{"oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"],"description":"The related resource id. Mandatory if resource type is \"folder\""},"description":{"default":"","type":["string"],"minLength":0,"maxLength":65535,"description":"The desired file name"},"restricted":{"default":"UNRESTRICTED","type":["string"],"enum":["UNRESTRICTED","RESTRICTED"],"description":"- `UNRESTRICTED`: No extra permissions required\n- `RESTRICTED`: Extra permissions required"},"profile":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Whether this document is the profile image"},"file":{"type":"string","format":"binary"}},"required":["targetResourceType"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"The Document details","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A document","createdAt":"2026-07-03T06:46:50.937Z","updatedAt":"2026-07-03T06:46:50.937Z","description":"","targetResource":{"id":1,"resourceType":"Equipment","deleted":false},"restricted":"UNRESTRICTED","profile":1,"downloads":1,"avScanStatus":"SAFE","availableSizes":["ORIGINAL","PREVIEW","THUMBNAIL"],"fileExt":"txt","fileType":"text/txt","fileSize":100,"revision":1,"createdBy":{"id":1,"resourceType":"Member"},"resourceType":"Document"}}}}},"tags":["Documents"]}},"/v3/{context}/{contextId}/duties":{"get":{"summary":"Retrieve a list of duties","description":"Retrieve a list of duties

**Required modules:** duty","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"Return only duties starting before this date","in":"query","name":"before","required":false,"schema":{"description":"Return only duties starting before this date","type":["string"],"format":"date-time"}},{"description":"Return only duties ending after this date","in":"query","name":"after","required":false,"schema":{"description":"Return only duties ending after this date","type":["string"],"format":"date-time"}},{"description":"Whether on-call or off-call was specified","in":"query","name":"type","required":false,"schema":{"type":["string"],"enum":["OFF","ON"],"description":"Whether on-call or off-call was specified"}},{"description":"One or more team identifiers","in":"query","name":"team_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more team identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more member identifiers","in":"query","name":"member_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more member identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more parent duty identifiers","in":"query","name":"parent_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more parent duty identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more role identifiers","in":"query","name":"role_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more role identifiers","type":"array","items":{"type":"number"}}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","startsAt","endsAt"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of Duties","content":{"application/json":{"example":{"results":[{"id":1,"notes":"A note about this duty","startsAt":"2026-07-03T06:46:50.987Z","endsAt":"2026-07-03T06:46:50.987Z","type":"OFF","role":{"id":1,"title":"This role's title","deprecatedBundle":"This role's bundle","owner":{"resourceType":"Team","id":1},"order":0,"cost":{"hour":20,"use":100},"resourceType":"Role","createdAt":"2026-07-03T06:46:50.985Z","updatedAt":"2026-07-03T06:46:50.985Z"},"parent":{"resourceType":"Duty","id":1},"member":{"alertActivityApproval":true,"alertAllQualifications":true,"alertGear":true,"alertQualifications":true,"chatAutosubscribe":true,"chatDailyDigest":true,"contactUpdateMail":true,"costPerHour":50,"costPerUse":10,"countReportingEvent":20,"countReportingExercise":10,"countReportingHours":40,"countReportingIncident":5,"countRollingHours":30,"countRollingHoursEvent":15,"countRollingHoursExercise":25,"countRollingHoursIncident":3,"createdAt":"2026-07-03T06:46:50Z","credits":100,"defaultDuty":"ON","defaultEquipmentLocation":{"id":2,"resourceType":"EquipmentLocation"},"deprecatedAddress":"456 Oak Ave, Springfield, London, SW1A 1AA, England","email":{"value":"john.doe@example.com","verified":true},"primaryEmergencyContact":{"name":"Emergency Contact 1","primaryPhone":"555-123-4567","secondaryPhone":"555-987-6543","relation":"Parent"},"secondaryEmergencyContact":{"name":"Emergency Contact 2","primaryPhone":"555-555-5555","secondaryPhone":"555-666-6666","relation":"Sibling"},"endsAt":"2026-07-03T06:46:50Z","globalSyncId":"62a68dac60b511f09c4a325096b39f47","home":{"phone":"555-789-0123","verified":true},"icalSecret":"icalSecret123","id":1,"idTag":"RFID123","startsAt":"2026-07-03T06:46:50Z","lastLogin":"2026-07-03T06:46:50Z","location":{"type":"Point","coordinates":[12.3456,-78.9101]},"locationBookmark":{"id":4,"resourceType":"LocationBookmark"},"mobile":{"phone":"555-222-3333","verified":true},"name":"John Doe","notes":"Some notes here","pager":{"phone":"555-444-5555","email":"pager.email@example.com"},"percReportingEvent":50,"percReportingExercise":70,"percReportingIncident":30,"percRollingEvent":60,"percRollingExercise":80,"percRollingIncident":40,"permission":1,"deprecatedPermission":"MEMBER","position":"Manager","ref":"ABC123","retiredReason":{"id":null,"resourceType":"RetiredReason"},"role":{"id":7,"resourceType":"Role"},"signedTandC":"2026-07-03T06:46:50Z","status":"OPERATIONAL","customStatus":{"id":8,"resourceType":"CustomMemberStatus"},"teamAgreementSigned":"Agreement123","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:50Z","weeklyDayOfWeek":1,"weeklyDayOfWeekUtc":2,"weeklyHourOfDay":2,"weeklyHourOfDayUtc":2,"weeklyMail":true,"work":{"phone":"555-777-8888"},"resourceType":"Member","deletedAt":null,"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"owner":{"resourceType":"Team","id":1},"repeat":{"every":{"interval":"WEEK","period":1},"until":"2026-07-03T06:46:50.987Z"},"resourceType":"Duty","createdAt":"2026-07-03T06:46:50.987Z","updatedAt":"2026-07-03T06:46:50.987Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Duties"]}},"/v3/{context}/{contextId}/equipment-brands":{"get":{"summary":"Retrieve a list of equipment brands","description":"Retrieve a list of equipment brands

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}],"description":"A list of ids"}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"maxLength":80,"description":"A simple text search term, compared against the title"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment brands","content":{"application/json":{"example":{"results":[{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Brands"]},"post":{"summary":"Create an equipment brand","description":"Create an equipment brand

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The brands's title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment brand","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Brands"]}},"/v3/{context}/{contextId}/equipment-categories":{"get":{"summary":"Retrieve a list of equipment categories","description":"Retrieve a list of equipment categories

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}],"description":"A list of ids"}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"A simple text search term, compared against the title"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment categories","content":{"application/json":{"example":{"results":[{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Categories"]},"post":{"summary":"Create an equipment category","description":"Create an equipment category

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The category's title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment category","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Categories"]}},"/v3/{context}/{contextId}/equipment-funds":{"get":{"summary":"Retrieve a list of equipment funds","description":"Retrieve a list of equipment funds

**Required modules:** equipment_funding","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}],"description":"A list of ids"}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"description":"A simple text search term, compared against the title"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment funds","content":{"application/json":{"example":{"results":[{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A funding source","createdAt":"2026-07-03T06:46:51.033Z","updatedAt":"2026-07-03T06:46:51.033Z","value":10000,"spentTotal":20,"equipTotal":5,"resourceType":"EquipmentFund"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Funds"]},"post":{"summary":"Create an equipment fund","description":"Create an equipment fund

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":60,"description":"The title of a resource"},"value":{"type":["integer"],"minimum":0,"maximum":2147483647,"description":"Value of the fund in whole cents, or equivalent sub-unit of team's currency."}},"required":["title","value"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment fund","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A funding source","createdAt":"2026-07-03T06:46:51.033Z","updatedAt":"2026-07-03T06:46:51.033Z","value":10000,"spentTotal":20,"equipTotal":5,"resourceType":"EquipmentFund"}}}}},"tags":["Equipment Funds"]}},"/v3/{context}/{contextId}/equipment-inspection-results":{"get":{"summary":"Retrieve a list of equipment inspection results","description":"Retrieve a list of equipment inspection results

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"Whether the inspection result is completed","in":"query","name":"completed","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Whether the inspection result is completed"}},{"description":"The barcode of the equipment being inspected","in":"query","name":"barcode","required":false,"schema":{"type":["string","null"],"minLength":1,"maxLength":80,"description":"The barcode of the equipment being inspected"}},{"description":"A text to filter equipment being inspected based on kind title or ref","in":"query","name":"text","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"A text to filter equipment being inspected based on kind title or ref"}},{"description":"The id of the equipment resource","in":"query","name":"equipment_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The id of the equipment resource"}},{"description":"The id or array of ids of the inspection resource","in":"query","name":"equipment_inspection_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"The id or array of ids of the inspection resource","type":"array","items":{"type":"number"}}},{"description":"The identifier of the location to filter on. This will filter based on the location of the equipment - not the Inspection itself","in":"query","name":"location_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The identifier of the location to filter on. This will filter based on the location of the equipment - not the Inspection itself"}},{"description":"A team identifier","in":"query","name":"team_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A team identifier"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","dateDue","text"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of inspection result items","content":{"application/json":{"example":{"results":[{"id":1,"dateDue":"2026-07-03T06:46:51.043Z","description":"A description","equipmentInspection":{"resourceType":"EquipmentInspection","id":1},"equipment":{"resourceType":"Equipment","id":1},"member":{"resourceType":"Member","id":1},"owner":{"resourceType":"Team","id":1},"repair":{"resourceType":"Repair","id":1},"resourceType":"EquipmentInspectionResult","reminderDate":"2026-07-03T06:46:51.043Z","lastModified":"2026-07-03T06:46:51.043Z","completedAt":"2026-07-03T06:46:51.043Z","outcome":"PASS","createdAt":"2026-07-03T06:46:51.043Z","updatedAt":"2026-07-03T06:46:51.043Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Inspections"]}},"/v3/{context}/{contextId}/equipment-inspection-step-results":{"get":{"summary":"Retrieve equipment inspection result steps","description":"Retrieve equipment inspection result steps

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"An inspection result id","in":"query","name":"equipment_inspection_result_id","required":true,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection result id"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of inspection step results","content":{"application/json":{"example":{"results":[{"id":1,"notes":"A note on how the step went","outcome":"PASS","stepText":"Check seatbelts","equipmentInspectionResult":{"resourceType":"EquipmentInspectionResult","id":1},"owner":{"resourceType":"Team","id":40},"resourceType":"EquipmentInspectionStepResult","createdAt":"2026-07-03T06:46:51.054Z","updatedAt":"2026-07-03T06:46:51.054Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Inspections"]},"post":{"summary":"Create an equipment inspection step result","description":"Create an equipment inspection step result

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"notes":{"type":["string"],"description":"The inspection result step notes"},"outcome":{"type":["string","null"],"enum":["PASS","FAIL","NA"],"description":"The outcome of the inspection step"},"stepText":{"type":["string"],"description":"The inspection result step title, should match the inspection step title"},"equipmentInspectionResultId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection result id"}},"required":["stepText","equipmentInspectionResultId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An inspection result step","content":{"application/json":{"example":{"id":1,"notes":"A note on how the step went","outcome":"PASS","stepText":"Check seatbelts","equipmentInspectionResult":{"resourceType":"EquipmentInspectionResult","id":1},"owner":{"resourceType":"Team","id":40},"resourceType":"EquipmentInspectionStepResult","createdAt":"2026-07-03T06:46:51.054Z","updatedAt":"2026-07-03T06:46:51.054Z"}}}}},"tags":["Equipment Inspections"]}},"/v3/{context}/{contextId}/equipment-inspection-steps":{"get":{"summary":"Retrieve an equipment inspection steps","description":"Retrieve an equipment inspection steps

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"An inspection id","in":"query","name":"inspection_id","required":true,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection id"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"ordering","type":["string"],"enum":["createdAt","updatedAt","id","ordering"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of inspection step items","content":{"application/json":{"example":{"results":[{"id":1,"text":"A title","equipmentInspection":{"resourceType":"EquipmentInspection","id":1},"owner":{"resourceType":"Team","id":40},"ordering":1,"resourceType":"EquipmentInspectionStep","createdAt":"2026-07-03T06:46:51.064Z","updatedAt":"2026-07-03T06:46:51.064Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Inspections"]},"post":{"summary":"Create an equipment inspection step","description":"Create an equipment inspection step

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"inspectionId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection id"},"text":{"type":["string"],"minLength":1,"maxLength":100,"description":"The inspection step text"},"ordering":{"type":["integer"],"minimum":0,"maximum":4294967295,"description":"The numeric order of this step during the inspection"}},"required":["inspectionId","text","ordering"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An inspection step","content":{"application/json":{"example":{"id":1,"text":"A title","equipmentInspection":{"resourceType":"EquipmentInspection","id":1},"owner":{"resourceType":"Team","id":40},"ordering":1,"resourceType":"EquipmentInspectionStep","createdAt":"2026-07-03T06:46:51.064Z","updatedAt":"2026-07-03T06:46:51.064Z"}}}}},"tags":["Equipment Inspections"]}},"/v3/{context}/{contextId}/equipment-inspections":{"get":{"summary":"Retrieve a list of equipment inspections","description":"Retrieve a list of equipment inspections

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"Whether the inspection is active or archived","in":"query","name":"is_active","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Whether the inspection is active or archived"}},{"description":"The id or array of ids of the equipment item the inspection is attached to","in":"query","name":"equipment_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"The id or array of ids of the equipment item the inspection is attached to","type":"array","items":{"type":"number"}}},{"description":"The identifier of the location to filter on. This will filter based on the location of the equipment - not the Inspection itself","in":"query","name":"equipment_location_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The identifier of the location to filter on. This will filter based on the location of the equipment - not the Inspection itself"}},{"description":"A team identifier","in":"query","name":"team_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A team identifier"}},{"description":"One or more equipment kind ids","in":"query","name":"kind_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more equipment kind ids","type":"array","items":{"type":"number"}}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of inspection items","content":{"application/json":{"example":{"results":[{"id":1,"archivedAt":null,"allKinds":false,"deprecatedBundle":"aBundle","dateLast":"2026-07-03T06:46:51.075Z","dateNext":"2026-07-03T06:46:51.075Z","description":"A description","equipmentParent":{"resourceType":"Equipment","id":1},"intervalUnit":"DAY","intervalValue":2,"isAutoUnserviceable":true,"location":{"resourceType":"EquipmentLocation","id":1},"member":{"resourceType":"Member","id":1},"reminderUnit":"WEEK","reminderValue":2,"title":"A title","owner":{"resourceType":"Team","id":40},"resourceType":"EquipmentInspection","createdAt":"2026-07-03T06:46:51.075Z","updatedAt":"2026-07-03T06:46:51.075Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Inspections"]}},"/v3/{context}/{contextId}/equipment-kinds":{"get":{"summary":"Retrieve a list of equipment kinds","description":"Retrieve a list of equipment kinds

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"A simple text search term, compared against the title"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"An equipment kind location id","in":"query","name":"location_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An equipment kind location id"}},{"description":"An equipment category id","in":"query","name":"category_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An equipment category id"}},{"description":"- `VEHICLE`: A vehicle of some kind\n- `SUPPLY`: A supply of disposable items\n- `EQUIPMENT`: A re-usable piece of equipment","in":"query","name":"type","required":false,"schema":{"type":["string"],"enum":["VEHICLE","SUPPLY","EQUIPMENT"],"description":"- `VEHICLE`: A vehicle of some kind\n- `SUPPLY`: A supply of disposable items\n- `EQUIPMENT`: A re-usable piece of equipment"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment kinds","content":{"application/json":{"example":{"results":[{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Kinds"]},"post":{"summary":"Create an equipment kind","description":"Create an equipment kind

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The kind's title"},"categoryId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"This kind's parent category id"},"type":{"default":"EQUIPMENT","type":["string"],"enum":["VEHICLE","SUPPLY","EQUIPMENT"],"description":"- `VEHICLE`: A vehicle of some kind\n- `SUPPLY`: A supply of disposable items\n- `EQUIPMENT`: A re-usable piece of equipment"},"costPerUse":{"type":["integer"],"minimum":0,"description":"The cost incurred per use"},"costPerHour":{"type":["integer"],"minimum":0,"description":"The cost incurred per hour of use"},"costPerDistance":{"type":["integer"],"minimum":0,"description":"The cost incurred per distance of use"},"required":{"type":["integer"],"minimum":0,"description":"The required amount if this is a supply item"}},"required":["title","categoryId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment kind","content":{"application/json":{"example":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"}}}}},"tags":["Equipment Kinds"]}},"/v3/{context}/{contextId}/equipment-locations":{"get":{"summary":"Retrieve a list of equipment locations","description":"Retrieve a list of equipment locations

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"The title of a resource","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"The title of a resource"}},{"description":"Return only archived locations","in":"query","name":"deleted","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Return only archived locations"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment locations","content":{"application/json":{"example":{"results":[{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Locations"]}},"/v3/{context}/{contextId}/equipment-models":{"get":{"summary":"Retrieve a list of equipment models","description":"Retrieve a list of equipment models

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}],"description":"A list of ids"}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"description":"A simple text search term, compared against the title"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"An equipment brand id","in":"query","name":"brand_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An equipment brand id"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment models","content":{"application/json":{"example":{"results":[{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Models"]},"post":{"summary":"Create an equipment model","description":"Create an equipment model

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The model's title"},"brandId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The brand id this model belongs to"}},"required":["title","brandId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment model","content":{"application/json":{"example":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Models"]}},"/v3/{context}/{contextId}/equipment-retired-reasons":{"get":{"summary":"Retrieve a list of equipment retired reasons","description":"Retrieve a list of equipment retired reasons

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}],"description":"A list of ids"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment retired reasons","content":{"application/json":{"example":{"results":[{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A retired reason resource","createdAt":"2026-07-03T06:46:51.121Z","updatedAt":"2026-07-03T06:46:51.121Z","resourceType":"EquipmentRetiredReason"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Retirement Reasons"]},"post":{"summary":"Create an equipment retired reason","description":"Create an equipment retired reason

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":20,"description":"The title of a resource"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment retired reason resource","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A retired reason","createdAt":"2026-07-03T06:46:51.121Z","updatedAt":"2026-07-03T06:46:51.121Z","resourceType":"EquipmentRetiredReason"}}}}},"tags":["Equipment Retirement Reasons"]}},"/v3/{context}/{contextId}/equipment-supplier-refs":{"get":{"summary":"Retrieve a list of equipment supplier references","description":"Retrieve a list of equipment supplier references

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}],"description":"A list of ids"}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"description":"A simple text search term, compared against the title"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"One or more team identifiers","in":"query","name":"team_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more team identifiers","type":"array","items":{"type":"number"}}},{"description":"An equipment supplier reference id","in":"query","name":"supplier_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An equipment supplier reference id"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment references","content":{"application/json":{"example":{"results":[{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A reference","supplier":{"id":1,"resourceType":"EquipmentSupplier"},"createdAt":"2026-07-03T06:46:51.131Z","updatedAt":"2026-07-03T06:46:51.131Z","resourceType":"EquipmentSupplierRef"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Supplier References"]},"post":{"summary":"Create an equipment supplier reference","description":"Create an equipment supplier reference

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The supplier ref's title"},"supplierId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The supplier id this reference belongs to"}},"required":["title","supplierId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment supplier reference","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A reference","supplier":{"id":1,"resourceType":"EquipmentSupplier"},"createdAt":"2026-07-03T06:46:51.131Z","updatedAt":"2026-07-03T06:46:51.131Z","resourceType":"EquipmentSupplierRef"}}}}},"tags":["Equipment Supplier References"]}},"/v3/{context}/{contextId}/equipment-suppliers":{"get":{"summary":"Retrieve a list of equipment suppliers","description":"Retrieve a list of equipment suppliers

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}],"description":"A list of ids"}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"A simple text search term, compared against the title"}},{"description":"One or more team identifiers","in":"query","name":"team_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more team identifiers","type":"array","items":{"type":"number"}}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment suppliers","content":{"application/json":{"example":{"results":[{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A supplier","createdAt":"2026-07-03T06:46:51.145Z","updatedAt":"2026-07-03T06:46:51.145Z","resourceType":"EquipmentSupplier"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Suppliers"]},"post":{"summary":"Create an equipment supplier resource","description":"Create an equipment supplier resource

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The supplier's title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment supplier resource","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A supplier","createdAt":"2026-07-03T06:46:51.145Z","updatedAt":"2026-07-03T06:46:51.145Z","resourceType":"EquipmentSupplier"}}}}},"tags":["Equipment Suppliers"]}},"/v3/{context}/{contextId}/equipment-usages":{"get":{"summary":"Retrieve a list of equipment usages","description":"Retrieve a list of equipment usages

**Required modules:** activities,equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"activity_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"equipment_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"The resource type of an activity","in":"query","name":"activity_resource_type","required":false,"schema":{"type":["string"],"enum":["Event","Exercise","Incident"],"description":"The resource type of an activity"}},{"description":"- `VEHICLE`: A vehicle of some kind\n- `SUPPLY`: A supply of disposable items\n- `EQUIPMENT`: A re-usable piece of equipment","in":"query","name":"equipment_type","required":false,"schema":{"type":["string"],"enum":["VEHICLE","SUPPLY","EQUIPMENT"],"description":"- `VEHICLE`: A vehicle of some kind\n- `SUPPLY`: A supply of disposable items\n- `EQUIPMENT`: A re-usable piece of equipment"}},{"description":"A partial search on the Equipment item entity ref","in":"query","name":"ref","required":false,"schema":{"type":["string"],"maxLength":80,"description":"A partial search on the Equipment item entity ref"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment usages","content":{"application/json":{"example":{"results":[{"id":1,"used":20,"distance":null,"duration":0,"equipment":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"activity":{"resourceType":"Incident","id":1},"owner":{"resourceType":"Team","id":1},"resourceType":"EquipmentUsage","createdAt":"2026-07-03T06:46:51.166Z","updatedAt":"2026-07-03T06:46:51.166Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Activity Equipment Usage"]},"post":{"summary":"Create an equipment usage","description":"Create an equipment usage

**Required modules:** activities,equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"activityId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"equipmentId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"duration":{"type":["integer"],"maximum":4294967295,"minimum":0,"description":"The minutes the equipment was used. Only if the Equipment item's type is \"Equipment\""},"distance":{"type":["integer"],"maximum":4294967295,"minimum":0,"description":"The distance the equipment was used in the km / miles. Only if the Equipment item's type is \"Vehicle\""},"used":{"type":["integer"],"maximum":4294967295,"minimum":0,"description":"The quantity that was used. Only if the Equipment item's type is \"Supply\""}},"required":["activityId","equipmentId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment usage","content":{"application/json":{"example":{"id":1,"used":20,"distance":null,"duration":0,"equipment":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"activity":{"resourceType":"Incident","id":1},"owner":{"resourceType":"Team","id":1},"resourceType":"EquipmentUsage","createdAt":"2026-07-03T06:46:51.166Z","updatedAt":"2026-07-03T06:46:51.166Z"}}}}},"tags":["Activity Equipment Usage"]}},"/v3/{context}/{contextId}/equipment":{"get":{"summary":"Retrieve a list of equipment items","description":"Retrieve a list of equipment items

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"This item's ref. Mutually exclusive with search","in":"query","name":"ref","required":false,"schema":{"type":["string"],"maxLength":80,"description":"This item's ref. Mutually exclusive with search"}},{"description":"A simple text search term, compared against the ref and the kind's title. Mutually exclusive with ref","in":"query","name":"text","required":false,"schema":{"type":["string"],"minLength":3,"description":"A simple text search term, compared against the ref and the kind's title. Mutually exclusive with ref"}},{"description":"This item's brand id","in":"query","name":"brand_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"This item's brand id","type":"array","items":{"type":"number"}}},{"description":"This item's model id","in":"query","name":"model_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"This item's model id","type":"array","items":{"type":"number"}}},{"description":"This items's category id","in":"query","name":"category_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"This items's category id","type":"array","items":{"type":"number"}}},{"description":"This item's kind id","in":"query","name":"kind_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"This item's kind id","type":"array","items":{"type":"number"}}},{"description":"This item's supplier id","in":"query","name":"supplier_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"This item's supplier id","type":"array","items":{"type":"number"}}},{"description":"This item's supplier ref id","in":"query","name":"supplier_ref_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"This item's supplier ref id","type":"array","items":{"type":"number"}}},{"description":"This item's funding source id","in":"query","name":"fund_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"This item's funding source id","type":"array","items":{"type":"number"}}},{"description":"This item's inspection id","in":"query","name":"inspection_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"This item's inspection id"}},{"description":"Member holding this item. Either an id or \"me\". Mutually exclusive with location_id","in":"query","name":"member_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["string"],"enum":["me"]}],"description":"Member holding this item. Either an id or \"me\". Mutually exclusive with location_id"}},{"description":"Equipment item in which this item is stored","in":"query","name":"parent_id","required":false,"schema":{"oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"],"description":"Equipment item in which this item is stored"}},{"description":"Items flagged as critical","in":"query","name":"is_critical","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Items flagged as critical"}},{"description":"Items flagged as expired","in":"query","name":"is_expired","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Items flagged as expired"}},{"description":"The status of the equipment or a list of equipment statuses","in":"query","name":"status","required":false,"schema":{"oneOf":[{"type":["string"],"enum":["OPERATIONAL","UNSERVICEABLE","RETIRED","LOST","WISHLIST","INACTIVE"],"description":"The status of the equipment"},{"type":["array"],"items":{"type":["string"],"enum":["OPERATIONAL","UNSERVICEABLE","RETIRED","LOST","WISHLIST","INACTIVE"],"description":"The status of the equipment"}}],"description":"The status of the equipment or a list of equipment statuses","type":"array","items":{"type":"string"}}},{"description":"This item's barcode","in":"query","name":"barcode","required":false,"schema":{"type":["string","null"],"minLength":1,"maxLength":80,"description":"This item's barcode"}},{"description":"- `VEHICLE`: A vehicle of some kind\n- `SUPPLY`: A supply of disposable items\n- `EQUIPMENT`: A re-usable piece of equipment","in":"query","name":"type","required":false,"schema":{"type":["string"],"enum":["VEHICLE","SUPPLY","EQUIPMENT"],"description":"- `VEHICLE`: A vehicle of some kind\n- `SUPPLY`: A supply of disposable items\n- `EQUIPMENT`: A re-usable piece of equipment"}},{"description":"Only include items that are operational/non-operational","in":"query","name":"only_current","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Only include items that are operational/non-operational"}},{"description":"Only include lost, inactive, retired and other items","in":"query","name":"exclude_current","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Only include lost, inactive, retired and other items"}},{"description":"An equipment location, represented by either an id or enum. Mutually exclusive with member_id","in":"query","name":"location_id","required":false,"schema":{"oneOf":[{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}},{"type":["string"]}],"description":"An equipment location, represented by either an id or enum. Mutually exclusive with member_id"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","ref","barcode","status","memberId","locationId","manufacturerId","dateMoved","modelId","serial"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of equipment items","content":{"application/json":{"example":{"results":[{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Items"]},"post":{"summary":"Create a new equipment item","description":"Create a new equipment item

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"ref":{"type":["string"],"description":"This item's ref. If not provided, will be auto-generated"},"categoryId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"This item's category id"},"kindId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"This item's kind id"},"brandId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"This item's brand id"},"modelId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"This item's model id"},"supplierId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"This item's supplier id"},"supplierRefId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"This item's supplier ref id"},"fundId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"This item's funding source id"},"location":{"oneOf":[{"type":["object"],"properties":{"resourceType":{"type":["string"],"enum":["Equipment","Member","EquipmentLocation","Team"],"description":"A valid resource type that can contain equipment"},"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},"required":["resourceType","id"]},{"type":["object"],"properties":{"type":{"type":["string"],"enum":["Equipment","Member","EquipmentLocation","Team"],"description":"A valid resource type that can contain equipment"},"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},"required":["type","id"]}],"description":"The destination resource"},"quantity":{"default":1,"type":["integer"],"exclusiveMinimum":0,"description":"Quantity of the item"},"notes":{"default":"","type":["string"],"description":"Notes for the item"},"barcode":{"type":["string"],"description":"Barcode for the item"},"serial":{"type":["string"],"description":"Serial number for the item"},"replacementCost":{"type":["number"],"description":"Replacement cost of the item"},"weight":{"type":["number"],"description":"Weight of the item"},"dateManufactured":{"type":["string"],"format":"date-time","description":"Date when the item was manufactured"},"datePurchased":{"type":["string"],"format":"date-time","description":"Date when the item was purchased"},"dateWarranty":{"type":["string"],"format":"date-time","description":"Warranty expiry date"},"dateExpires":{"type":["string"],"format":"date-time","description":"Item expiry date"},"idMarks":{"type":["string"],"description":"ID marks for the item"},"isCritical":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Whether the item is critical"},"isMonitor":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Whether the item is a monitor"},"expireWarningDays":{"type":["integer"],"exclusiveMinimum":0,"description":"Days before expiry to warn"},"expireWarningUseCount":{"type":["integer"],"exclusiveMinimum":0,"description":"Use count before expiry warning"},"expireWarningUseMinutes":{"type":["integer"],"exclusiveMinimum":0,"description":"Use minutes before expiry warning"},"expireWarningUseOdometer":{"type":["number"],"description":"Odometer reading before expiry warning"},"costPerHour":{"type":["number"],"description":"Cost per hour of use"},"costPerUse":{"type":["number"],"description":"Cost per use"},"costPerDistance":{"type":["number"],"description":"Cost per distance unit"},"odometerReading":{"type":["number"],"description":"Current odometer reading"},"odometerReadingTotal":{"type":["number"],"description":"Total odometer reading"},"odometerReadingTotalAllowed":{"type":["number"],"description":"Maximum allowed odometer reading"},"usesAllowed":{"type":["integer"],"description":"Maximum allowed uses"},"minutesAllowed":{"type":["integer"],"description":"Maximum allowed minutes of use"}},"required":["categoryId","kindId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"The created equipment item","content":{"application/json":{"example":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Equipment Items"]}},"/v3/{context}/{contextId}/events":{"get":{"summary":"Retrieve a list of events","description":"Retrieve a list of events

**Required modules:** activities","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A simple text search term, compared against the reference and reference description","in":"query","name":"reference","required":false,"schema":{"type":["string"],"description":"A simple text search term, compared against the reference and reference description"}},{"description":"Return only activities starting before this datetime","in":"query","name":"before","required":false,"schema":{"description":"Return only activities starting before this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities ending before this datetime","in":"query","name":"ends_before","required":false,"schema":{"description":"Return only activities ending before this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities created or updated after this datetime","in":"query","name":"updated_after","required":false,"schema":{"description":"Return only activities created or updated after this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities with this tag bundle id","in":"query","name":"tag_bundle_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this tag bundle id"}},{"description":"Return only activities with this tag id","in":"query","name":"tag_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this tag id"}},{"description":"Return only activities with this team id","in":"query","name":"team_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this team id"}},{"description":"Return only activities with this location bookmark id","in":"query","name":"location_bookmark_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this location bookmark id"}},{"description":"Return only activities ending after this datetime","in":"query","name":"after","required":false,"schema":{"description":"Return only activities ending after this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities starting after this datetime","in":"query","name":"starts_after","required":false,"schema":{"description":"Return only activities starting after this datetime","type":["string"],"format":"date-time"}},{"description":"Filter by activity resource type, Event | Exercise | Incident","in":"query","name":"resource_type","required":false,"schema":{"type":["string"],"enum":["Event","Exercise","Incident"],"description":"Filter by activity resource type, Event | Exercise | Incident"}},{"description":"Return only deleted activities","in":"query","name":"deleted","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Return only deleted activities"}},{"description":"Return only published activities","in":"query","name":"published","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Return only published activities"}},{"description":"When true, also include activities with no end date (ongoing) in addition to those matching the ends_before/after window","in":"query","name":"include_ongoing","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"When true, also include activities with no end date (ongoing) in addition to those matching the ends_before/after window"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","teamId","reference","startsAt","percAttendance"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of Events","content":{"application/json":{"example":{"results":[{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.295Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.295Z","updatedAt":"2026-07-03T06:46:51.295Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.295Z","endsAt":"2026-07-03T06:46:51.295Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.295Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Events"]},"post":{"summary":"Create an event","description":"Create an event

**Required modules:** activities","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"reference":{"type":["string"],"maxLength":30,"description":"Reference code for activity. Must be unique. Only allowed if team has activity auto-id enabled."},"referenceDescription":{"type":["string"],"maxLength":100,"description":"A text description for the reference / the activity's title"},"description":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's description. Supports HTML."},"plan":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's plan. Supports HTML."},"trackingNumber":{"type":["string","null"],"maxLength":50,"description":"The activity's tracking number"},"shared":{"description":"Whether the activity is shared across the organisation","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"fullTeam":{"description":"Whether the activity requires the attendance of the full team or is selective. If set true on activity creation, the attendance records will automatically be created for appropriate team members.","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"address":{"type":["object"],"properties":{"country":{"type":["string"],"description":"Country"},"postcode":{"type":["string"],"maxLength":100,"description":"Postcode or ZIP code"},"region":{"type":["string"],"maxLength":100,"description":"Province, county or region"},"street":{"type":["string"],"maxLength":100,"description":"Number, street and house"},"town":{"type":["string"],"maxLength":100,"description":"City or town"}}},"location":{"type":["object"],"properties":{"latitude":{"type":["number"],"minimum":-90,"maximum":90,"description":"The latitude where this entity is located"},"longitude":{"type":["number"],"minimum":-180,"maximum":180,"description":"The longitude where this entity is located"}},"required":["latitude","longitude"]},"locationBookmarkId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"startsAt":{"description":"An ISO8601 datetime string","type":["string"],"format":"date-time"},"endsAt":{"description":"The activity's end date","type":["string"],"format":"date-time"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}},"required":["startsAt"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An event","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.295Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.295Z","updatedAt":"2026-07-03T06:46:51.295Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.295Z","endsAt":"2026-07-03T06:46:51.295Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.295Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Events"]}},"/v3/{context}/{contextId}/exercises":{"get":{"summary":"Retrieve a list of exercises","description":"Retrieve a list of exercises

**Required modules:** activities","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A simple text search term, compared against the reference and reference description","in":"query","name":"reference","required":false,"schema":{"type":["string"],"description":"A simple text search term, compared against the reference and reference description"}},{"description":"Return only activities starting before this datetime","in":"query","name":"before","required":false,"schema":{"description":"Return only activities starting before this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities ending before this datetime","in":"query","name":"ends_before","required":false,"schema":{"description":"Return only activities ending before this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities created or updated after this datetime","in":"query","name":"updated_after","required":false,"schema":{"description":"Return only activities created or updated after this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities with this tag bundle id","in":"query","name":"tag_bundle_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this tag bundle id"}},{"description":"Return only activities with this tag id","in":"query","name":"tag_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this tag id"}},{"description":"Return only activities with this team id","in":"query","name":"team_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this team id"}},{"description":"Return only activities with this location bookmark id","in":"query","name":"location_bookmark_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this location bookmark id"}},{"description":"Return only activities ending after this datetime","in":"query","name":"after","required":false,"schema":{"description":"Return only activities ending after this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities starting after this datetime","in":"query","name":"starts_after","required":false,"schema":{"description":"Return only activities starting after this datetime","type":["string"],"format":"date-time"}},{"description":"Filter by activity resource type, Event | Exercise | Incident","in":"query","name":"resource_type","required":false,"schema":{"type":["string"],"enum":["Event","Exercise","Incident"],"description":"Filter by activity resource type, Event | Exercise | Incident"}},{"description":"Return only deleted activities","in":"query","name":"deleted","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Return only deleted activities"}},{"description":"Return only published activities","in":"query","name":"published","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Return only published activities"}},{"description":"When true, also include activities with no end date (ongoing) in addition to those matching the ends_before/after window","in":"query","name":"include_ongoing","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"When true, also include activities with no end date (ongoing) in addition to those matching the ends_before/after window"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","teamId","reference","startsAt","percAttendance"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of Exercises","content":{"application/json":{"example":{"results":[{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.306Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.306Z","updatedAt":"2026-07-03T06:46:51.306Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.306Z","endsAt":"2026-07-03T06:46:51.306Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.306Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Exercises"]},"post":{"summary":"Create an exercise","description":"Create an exercise

**Required modules:** activities","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"reference":{"type":["string"],"maxLength":30,"description":"Reference code for activity. Must be unique. Only allowed if team has activity auto-id enabled."},"referenceDescription":{"type":["string"],"maxLength":100,"description":"A text description for the reference / the activity's title"},"description":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's description. Supports HTML."},"plan":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's plan. Supports HTML."},"trackingNumber":{"type":["string","null"],"maxLength":50,"description":"The activity's tracking number"},"shared":{"description":"Whether the activity is shared across the organisation","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"fullTeam":{"description":"Whether the activity requires the attendance of the full team or is selective. If set true on activity creation, the attendance records will automatically be created for appropriate team members.","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"address":{"type":["object"],"properties":{"country":{"type":["string"],"description":"Country"},"postcode":{"type":["string"],"maxLength":100,"description":"Postcode or ZIP code"},"region":{"type":["string"],"maxLength":100,"description":"Province, county or region"},"street":{"type":["string"],"maxLength":100,"description":"Number, street and house"},"town":{"type":["string"],"maxLength":100,"description":"City or town"}}},"location":{"type":["object"],"properties":{"latitude":{"type":["number"],"minimum":-90,"maximum":90,"description":"The latitude where this entity is located"},"longitude":{"type":["number"],"minimum":-180,"maximum":180,"description":"The longitude where this entity is located"}},"required":["latitude","longitude"]},"locationBookmarkId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"startsAt":{"description":"An ISO8601 datetime string","type":["string"],"format":"date-time"},"endsAt":{"description":"The activity's end date","type":["string"],"format":"date-time"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}},"required":["startsAt"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An exercise","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.306Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.306Z","updatedAt":"2026-07-03T06:46:51.306Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.306Z","endsAt":"2026-07-03T06:46:51.306Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.306Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Exercises"]}},"/v3/{context}/{contextId}/handler-group-memberships":{"get":{"summary":"Retrieve a list of handler group memberships","description":"Retrieve a list of handler group memberships

**Required modules:** groups","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"One or more team identifiers","in":"query","name":"team_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more team identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more group identifiers","in":"query","name":"group_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more group identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more handler identifiers","in":"query","name":"handler_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more handler identifiers","type":"array","items":{"type":"number"}}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of handler group memberships","content":{"application/json":{"example":{"results":[{"id":1,"owner":{"resourceType":"Team","id":1},"group":{"resourceType":"HandlerGroup","id":1},"handler":{"resourceType":"Handler","id":1},"resourceType":"HandlerGroupMembership","createdAt":"2026-07-03T06:46:50.695Z","updatedAt":"2026-07-03T06:46:50.695Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Group Memberships"]}},"/v3/{context}/{contextId}/handler-groups":{"get":{"summary":"Retrieve a list of handler groups","description":"Retrieve a list of handler groups

**Required modules:** groups","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"One or more team identifiers","in":"query","name":"team_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more team identifiers","type":"array","items":{"type":"number"}}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"description":"A simple text search term, compared against the title"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of handler Groups","content":{"application/json":{"example":{"results":[{"id":1,"title":"Handlers of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Handler","owner":{"resourceType":"Team","id":1},"resourceType":"HandlerGroup","createdAt":"2026-07-03T06:46:51.329Z","updatedAt":"2026-07-03T06:46:51.329Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Groups"]},"post":{"summary":"Create a handler group","description":"Create a handler group ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":50,"description":"The group's title"},"deprecatedBundle":{"type":["string"],"minLength":1,"maxLength":50,"description":"The group's bundle title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A handler group","content":{"application/json":{"example":{"id":1,"title":"Handlers of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Handler","owner":{"resourceType":"Team","id":1},"resourceType":"HandlerGroup","createdAt":"2026-07-03T06:46:51.329Z","updatedAt":"2026-07-03T06:46:51.329Z"}}}}},"tags":["Groups"]}},"/v3/{context}/{contextId}/handler-qualifications":{"get":{"summary":"Retrieve a list of handler qualifications","description":"Retrieve a list of handler qualifications ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"The title of a resource","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"The title of a resource"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of handler qualifications","content":{"application/json":{"example":{"page":0,"pageSize":1,"totalSize":1,"results":[{"id":8,"owner":{"id":2,"resourceType":"Team"},"title":"Cat Herding","description":"You don't want to take this course, trust me","cost":null,"expiredCost":null,"deprecatedBundle":"Discontinued courses","expiresMonthsDefault":null,"reminderDays":30,"createdAt":"2026-07-03T06:46:51.335Z","updatedAt":"2026-07-03T06:46:51.335Z","resourceType":"HandlerQualification"}]}}}}},"tags":["Qualifications"]}},"/v3/{context}/{contextId}/handlers":{"get":{"summary":"Retrieve a list of handlers","description":"Retrieve a list of handlers

**Required modules:** members,animals","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"Filter by member ID","in":"query","name":"member_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"Filter by member ID","type":"array","items":{"type":"number"}}},{"description":"Filter by animal ID","in":"query","name":"animal_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"Filter by animal ID","type":"array","items":{"type":"number"}}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","memberId","animalId"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of handlers","content":{"application/json":{"example":{"results":[{"id":1,"owner":{"id":1,"resourceType":"Team"},"member":{"id":1,"resourceType":"Member"},"animal":{"id":1,"resourceType":"Animal"},"resourceType":"Handler","createdAt":"2026-07-03T06:46:51.341Z","updatedAt":"2026-07-03T06:46:51.341Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Animals"]},"post":{"summary":"Create a handler","description":"Create a handler

**Required modules:** members,animals","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"memberId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The member's identifier"},"animalId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The animal's identifier"}},"required":["memberId","animalId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A handler","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"member":{"id":1,"resourceType":"Member"},"animal":{"id":1,"resourceType":"Animal"},"resourceType":"Handler","createdAt":"2026-07-03T06:46:51.341Z","updatedAt":"2026-07-03T06:46:51.341Z"}}}}},"tags":["Animals"]}},"/v3/{context}/{contextId}/health-safety-categories":{"get":{"summary":"Retrieve a list of Health & Safety Categories","description":"Retrieve a list of Health & Safety Categories

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Category"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Category"}}],"description":"A list of ids"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of Health & Safety Categories","content":{"application/json":{"example":{"results":[{"colour":"BLACK","createdAt":"2026-07-03T06:46:51.353Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"HealthSafetyCategory","title":"Category Alpha","updatedAt":"2026-07-03T06:46:51.353Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Health & Safety"]},"post":{"summary":"Create a Health & Safety Category","description":"Create a Health & Safety Category

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":50,"description":"The category title"},"colour":{"type":["string"],"enum":["BLACK","BLUE","CADET_BLUE","DARK_BLUE","DARK_GREEN","DARK_PURPLE","DARK_RED","GRAY","GREEN","LIGHT_GRAY","LIGHT_RED","ORANGE","PURPLE","RED"],"description":"The colour assigned to the category"}},"required":["title","colour"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A Health & Safety Category","content":{"application/json":{"example":{"colour":"BLACK","createdAt":"2026-07-03T06:46:51.353Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"HealthSafetyCategory","title":"Category Alpha","updatedAt":"2026-07-03T06:46:51.353Z"}}}}},"tags":["Health & Safety"]}},"/v3/{context}/{contextId}/health-safety-reports":{"get":{"summary":"Retrieve a list of Health & Safety Reports","description":"Retrieve a list of Health & Safety Reports

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"The ID of an associated resource","in":"query","name":"target_resource_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of an associated resource"}},{"description":"The approval state of the report","in":"query","name":"approved","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"The approval state of the report"}},{"description":"A Health & Safety Category ID","in":"query","name":"category_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A Health & Safety Category ID"}},{"description":"The date-time of this occurance","in":"query","name":"before","required":false,"schema":{"description":"The date-time of this occurance","type":["string","null"],"format":"date-time"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Report"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Report"}}],"description":"A list of ids"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"description":"A Health & Safety Severity ID","in":"query","name":"severity_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A Health & Safety Severity ID"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","startsAt","id","updatedAt"]}},{"description":"The date-time of this occurance","in":"query","name":"after","required":false,"schema":{"description":"The date-time of this occurance","type":["string","null"],"format":"date-time"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of Health & Safety Reports","content":{"application/json":{"example":{"results":[{"targetResource":{"id":1,"resourceType":"Incident"},"address":{"country":"","postcode":"","region":"","street":"","town":""},"approvedAt":"2026-07-03T06:46:43.215Z","category":{"id":1,"resourceType":"HealthSafetyCategory"},"cause":"Some cause","createdAt":"2026-07-03T06:46:43.215Z","startsAt":"2026-07-03T06:46:43.215Z","description":"","id":1,"location":{"type":"Point","coordinates":[0,0]},"measures":"","resourceType":"HealthSafetyReport","severity":{"id":1,"resourceType":"HealthSafetySeverity"},"owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:43.215Z","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Health & Safety"]}},"/v3/{context}/{contextId}/health-safety-severities":{"get":{"summary":"Retrieve a list of Health & Safety Severities","description":"Retrieve a list of Health & Safety Severities

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Severity"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Severity"}}],"description":"A list of ids"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","score","title"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of Health & Safety Severities","content":{"application/json":{"example":{"results":[{"createdAt":"2026-07-03T06:46:51.370Z","id":1,"resourceType":"HealthSafetySeverity","score":0,"owner":{"id":1,"resourceType":"Team"},"title":"Severity Alpha","updatedAt":"2026-07-03T06:46:51.370Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Health & Safety"]},"post":{"summary":"Create a Health & Safety Severity","description":"Create a Health & Safety Severity

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":20,"description":"The severity title"},"score":{"default":null,"type":["integer","null"],"minimum":-9007199254740991,"maximum":9007199254740991,"description":"The score assigned to this severity"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A Health & Safety Severity","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51.370Z","id":1,"resourceType":"HealthSafetySeverity","score":0,"owner":{"id":1,"resourceType":"Team"},"title":"Severity Beta","updatedAt":"2026-07-03T06:46:51.370Z"}}}}},"tags":["Health & Safety"]}},"/v3/{context}/{contextId}/incident-involved-injuries":{"get":{"summary":"Retrieve a list of person involved injuries","description":"Retrieve a list of person involved injuries

**Required modules:** persons_involved_medical","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of person involved injuries","content":{"application/json":{"example":{"results":[{"createdAt":"2026-07-03T06:46:50Z","id":1,"injury":{"id":30,"title":"Face","category":"HEAD"},"injuryType":{"id":12,"title":"Sprain","bundle":"MUSCULOSKELETAL","location":"ANY"},"owner":{"id":1,"resourceType":"Team"},"person":{"resourceType":"PersonInvolved","id":1},"resourceType":"PersonInvolvedInjury","updatedAt":"2026-07-03T06:46:50Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Incidents"]}},"/v3/{context}/{contextId}/incident-involved-metadata":{"get":{"summary":"Retrieves data for use with persons / vehicles involved in incidents","description":"Retrieves data for use with persons / vehicles involved in incidents

**Required modules:** persons_involved","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"Data for use with persons / vehicles involved in incidents","content":{"application/json":{"example":{"outcomes":[{"id":2,"involvementTypeId":1,"title":"Not Located","deprecatedBundle":"DEFAULT","ordering":3}],"involvementTypes":[{"id":15,"title":"Environmental Agency","deprecatedBundle":"HAZMAT","ordering":10}],"injuryLocations":[{"id":30,"title":"Face","category":"HEAD"}],"injuryTypes":[{"id":13,"title":"Foreign Body","location":"ANY","deprecatedBundle":"OTHER"}],"vehicleCategories":[{"id":10,"title":"Road Freight","deprecatedBundle":"DEFAULT"}],"vehicleSubCategories":[{"id":70,"title":"Truck Trailer","deprecatedBundle":"DEFAULT","vehicleCategoryId":10}]}}}}},"tags":["Incidents"]}},"/v3/{context}/{contextId}/incident-involved-persons":{"get":{"summary":"Retrieve a list of persons involved in incidents","description":"Retrieve a list of persons involved in incidents

**Required modules:** persons_involved","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"incident_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of persons involved in incidents","content":{"application/json":{"example":{"results":[{"incident":{"resourceType":"Incident","id":1},"age":21,"areaKnowledge":"UNFAMILIAR","cause":"UNDETERMINED","contact":"Joe Duffy, call this number 123456789 and talk to Joe","createdAt":"2026-07-03T06:46:50Z","dateOfBirth":"1990-01-01","handover":"HOSPITAL","id":1,"involvementNotes":"Some involvement notes","involvementType":{"id":1,"title":"Victim"},"injuries":[{"createdAt":"2026-07-03T06:46:50Z","id":1,"injury":{"id":30,"title":"Face","category":"HEAD"},"injuryType":{"id":12,"title":"Sprain","bundle":"MUSCULOSKELETAL","location":"ANY"},"owner":{"id":1,"resourceType":"Team"},"person":{"resourceType":"PersonInvolved","id":1},"resourceType":"PersonInvolvedInjury","updatedAt":"2026-07-03T06:46:50Z"}],"name":"John Doe","nationality":"US","assistance":"Medical assistance notes","owner":{"id":1,"resourceType":"Team"},"outcome":{"id":4,"title":"Life Saved"},"resourceType":"PersonInvolved","sex":"MALE","spinalInjury":"SUSPECTED","transfer":"HOSPITAL","updatedAt":"2026-07-03T06:46:50Z","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Incidents"]}},"/v3/{context}/{contextId}/incidents":{"get":{"summary":"Retrieve a list of incidents","description":"Retrieve a list of incidents

**Required modules:** activities","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A simple text search term, compared against the reference and reference description","in":"query","name":"reference","required":false,"schema":{"type":["string"],"description":"A simple text search term, compared against the reference and reference description"}},{"description":"Return only activities starting before this datetime","in":"query","name":"before","required":false,"schema":{"description":"Return only activities starting before this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities ending before this datetime","in":"query","name":"ends_before","required":false,"schema":{"description":"Return only activities ending before this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities created or updated after this datetime","in":"query","name":"updated_after","required":false,"schema":{"description":"Return only activities created or updated after this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities with this tag bundle id","in":"query","name":"tag_bundle_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this tag bundle id"}},{"description":"Return only activities with this tag id","in":"query","name":"tag_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this tag id"}},{"description":"Return only activities with this team id","in":"query","name":"team_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this team id"}},{"description":"Return only activities with this location bookmark id","in":"query","name":"location_bookmark_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Return only activities with this location bookmark id"}},{"description":"Return only activities ending after this datetime","in":"query","name":"after","required":false,"schema":{"description":"Return only activities ending after this datetime","type":["string"],"format":"date-time"}},{"description":"Return only activities starting after this datetime","in":"query","name":"starts_after","required":false,"schema":{"description":"Return only activities starting after this datetime","type":["string"],"format":"date-time"}},{"description":"Filter by activity resource type, Event | Exercise | Incident","in":"query","name":"resource_type","required":false,"schema":{"type":["string"],"enum":["Event","Exercise","Incident"],"description":"Filter by activity resource type, Event | Exercise | Incident"}},{"description":"Return only deleted activities","in":"query","name":"deleted","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Return only deleted activities"}},{"description":"Return only published activities","in":"query","name":"published","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Return only published activities"}},{"description":"When true, also include activities with no end date (ongoing) in addition to those matching the ends_before/after window","in":"query","name":"include_ongoing","required":false,"schema":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"When true, also include activities with no end date (ongoing) in addition to those matching the ends_before/after window"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","teamId","reference","startsAt","percAttendance"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of Incidents","content":{"application/json":{"example":{"results":[{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.407Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.407Z","updatedAt":"2026-07-03T06:46:51.407Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.407Z","endsAt":"2026-07-03T06:46:51.407Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.407Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Incidents"]},"post":{"summary":"Create an incident","description":"Create an incident

**Required modules:** activities","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"reference":{"type":["string"],"maxLength":30,"description":"Reference code for activity. Must be unique. Only allowed if team has activity auto-id enabled."},"referenceDescription":{"type":["string"],"maxLength":100,"description":"A text description for the reference / the activity's title"},"description":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's description. Supports HTML."},"plan":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's plan. Supports HTML."},"trackingNumber":{"type":["string","null"],"maxLength":50,"description":"The activity's tracking number"},"shared":{"description":"Whether the activity is shared across the organisation","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"fullTeam":{"description":"Whether the activity requires the attendance of the full team or is selective. If set true on activity creation, the attendance records will automatically be created for appropriate team members.","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"address":{"type":["object"],"properties":{"country":{"type":["string"],"description":"Country"},"postcode":{"type":["string"],"maxLength":100,"description":"Postcode or ZIP code"},"region":{"type":["string"],"maxLength":100,"description":"Province, county or region"},"street":{"type":["string"],"maxLength":100,"description":"Number, street and house"},"town":{"type":["string"],"maxLength":100,"description":"City or town"}}},"location":{"type":["object"],"properties":{"latitude":{"type":["number"],"minimum":-90,"maximum":90,"description":"The latitude where this entity is located"},"longitude":{"type":["number"],"minimum":-180,"maximum":180,"description":"The longitude where this entity is located"}},"required":["latitude","longitude"]},"locationBookmarkId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"startsAt":{"description":"An ISO8601 datetime string","type":["string"],"format":"date-time"},"endsAt":{"description":"The activity's end date","type":["string"],"format":"date-time"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}},"required":["startsAt"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An incident entity","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.407Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.407Z","updatedAt":"2026-07-03T06:46:51.407Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.407Z","endsAt":"2026-07-03T06:46:51.407Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.407Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Incidents"]}},"/v3/{context}/{contextId}/location-bookmarks":{"get":{"summary":"Retrieve a list of location bookmarks","description":"Retrieve a list of location bookmarks

**Required modules:** location","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of location bookmark resources","content":{"application/json":{"example":{"results":[{"id":1,"title":"Office","address":{"country":"United States","street":"742 Evergreen Terrace","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"parent":{"id":1,"resourceType":"LocationBookmark"},"createdAt":"2026-07-03T06:46:51.414Z","updatedAt":"2026-07-03T06:46:51.414Z","archivedAt":null,"resourceType":"LocationBookmark"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Location Bookmarks"]}},"/v3/{context}/{contextId}/member-custom-statuses":{"get":{"summary":"Retrieve a list of custom member statuses","description":"Retrieve a list of custom member statuses

**Required modules:** members","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"Status of member","in":"query","name":"status","required":false,"schema":{"type":["string"],"enum":["OPERATIONAL","NON_OPERATIONAL","RETIRED"],"description":"Status of member"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of custom member statuses","content":{"application/json":{"example":{"results":[{"id":8,"owner":{"id":2,"resourceType":"Team"},"title":"Mostly Operational","status":"OPERATIONAL","ordering":0,"createdAt":"2026-07-03T06:46:51.420Z","updatedAt":"2026-07-03T06:46:51.420Z","resourceType":"MemberCustomStatus"}],"page":1,"pageSize":2,"totalSize":1}}}}},"tags":["Members"]}},"/v3/{context}/{contextId}/member-group-memberships":{"get":{"summary":"Retrieve a list of group memberships","description":"Retrieve a list of group memberships

**Required modules:** groups","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"One or more team identifiers","in":"query","name":"team_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more team identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more group identifiers","in":"query","name":"group_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more group identifiers","type":"array","items":{"type":"number"}}},{"description":"One or more member identifiers","in":"query","name":"member_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more member identifiers","type":"array","items":{"type":"number"}}},{"in":"query","name":"member_status","required":false,"schema":{"default":["OPERATIONAL","NON_OPERATIONAL","OBSERVER","RETIRED","DELETED"],"oneOf":[{"type":["string"],"enum":["OPERATIONAL","NON_OPERATIONAL","OBSERVER","RETIRED","DELETED"],"description":"Status of member"},{"type":["array"],"items":{"type":["string"],"enum":["OPERATIONAL","NON_OPERATIONAL","OBSERVER","RETIRED","DELETED"],"description":"Status of member"},"minItems":1}]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of member group memberships","content":{"application/json":{"example":{"results":[{"id":1,"owner":{"resourceType":"Team","id":1},"group":{"resourceType":"MemberGroup","id":1},"member":{"resourceType":"Member","id":1},"resourceType":"MemberGroupMembership","createdAt":"2026-07-03T06:46:50.741Z","updatedAt":"2026-07-03T06:46:50.741Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Group Memberships"]}},"/v3/{context}/{contextId}/member-groups":{"get":{"summary":"Retrieve a list of member groups","description":"Retrieve a list of member groups

**Required modules:** groups","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"One or more team identifiers","in":"query","name":"team_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more team identifiers","type":"array","items":{"type":"number"}}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"description":"A simple text search term, compared against the title"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","title"]}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of member Groups","content":{"application/json":{"example":{"results":[{"id":1,"globalSyncId":"62a68dac60b511f09c4a325096b39f47","title":"Trappers of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Member","owner":{"resourceType":"Team","id":1},"required":0,"deprecatedShortcode":"ALPHA","resourceType":"MemberGroup","createdAt":"2026-07-03T06:46:51.437Z","updatedAt":"2026-07-03T06:46:51.437Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Groups"]},"post":{"summary":"Create a member group","description":"Create a member group ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":50,"description":"The group's title"},"deprecatedBundle":{"type":["string"],"minLength":1,"maxLength":50,"description":"The group's bundle title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A member group","content":{"application/json":{"example":{"id":1,"globalSyncId":"62a68dac60b511f09c4a325096b39f47","title":"Trappers of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Member","owner":{"resourceType":"Team","id":1},"required":0,"deprecatedShortcode":"ALPHA","resourceType":"MemberGroup","createdAt":"2026-07-03T06:46:51.437Z","updatedAt":"2026-07-03T06:46:51.437Z"}}}}},"tags":["Groups"]}},"/v3/{context}/{contextId}/member-qualification-awards":{"get":{"summary":"Retrieve a list of member qualification awards","description":"Retrieve a list of member qualification awards ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"The qualification's id","in":"query","name":"qualification_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The qualification's id"}},{"description":"Qualified member. Either an id or \"me\"","in":"query","name":"member_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["string"],"enum":["me"]}],"description":"Qualified member. Either an id or \"me\""}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of member qualification awards","content":{"application/json":{"example":{"results":[{"id":92,"member":{"id":80,"resourceType":"Member"},"qualification":{"id":1,"resourceType":"MemberQualification"},"startsAt":"2026-07-03T06:46:51.451Z","endsAt":"2026-07-03T06:46:51.451Z","owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:51.451Z","updatedAt":"2026-07-03T06:46:51.451Z","resourceType":"MemberQualificationAward"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Qualifications"]},"post":{"summary":"Create a member qualification award","description":"Create a member qualification award ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"memberId":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["string"],"enum":["me"]}],"description":"Qualified member. Either an id or \"me\""},"startsAt":{"description":"An ISO8601 datetime string","type":["string"],"format":"date-time"},"endsAt":{"description":"End of award validity period, or null for no expiration","type":["string","null"],"format":"date-time"},"qualificationId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The qualification's id"}},"required":["memberId","startsAt","qualificationId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A member qualification award","content":{"application/json":{"example":{"id":92,"member":{"id":80,"resourceType":"Member"},"qualification":{"id":1,"resourceType":"MemberQualification"},"startsAt":"2026-07-03T06:46:51.451Z","endsAt":"2026-07-03T06:46:51.451Z","owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:51.451Z","updatedAt":"2026-07-03T06:46:51.451Z","resourceType":"MemberQualificationAward"}}}}},"tags":["Qualifications"]}},"/v3/{context}/{contextId}/member-qualifications":{"get":{"summary":"Retrieve a list of member qualifications","description":"Retrieve a list of member qualifications ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"The title of a resource","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"The title of a resource"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of member qualifications","content":{"application/json":{"example":{"page":0,"pageSize":1,"totalSize":1,"results":[{"id":8,"owner":{"id":2,"resourceType":"Team"},"title":"Knot Qualification","description":"Nuts for knots","cost":null,"expiredCost":null,"deprecatedBundle":"Qualification-bundle","expiresMonthsDefault":null,"reminderDays":30,"createdAt":"2026-07-03T06:46:51.458Z","updatedAt":"2026-07-03T06:46:51.458Z","resourceType":"MemberQualification"}]}}}}},"tags":["Qualifications"]}},"/v3/{context}/{contextId}/member-retired-reasons":{"get":{"summary":"Retrieve a list of member retired reasons","description":"Retrieve a list of member retired reasons

**Required modules:** members","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of member retire reason identifiers","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}],"description":"A list of member retire reason identifiers"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of member retired reasons","content":{"application/json":{"example":{"results":[{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A member retired reason resource","createdAt":"2026-07-03T06:46:51.473Z","updatedAt":"2026-07-03T06:46:51.473Z","resourceType":"MemberRetiredReason"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Members"]}},"/v3/{context}/{contextId}/members":{"get":{"summary":"Retrieve a list of members","description":"Retrieve a list of members

**Required modules:** ","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"The numeric identifier for a resource","in":"query","name":"team_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},{"in":"query","name":"status_label_id","required":false,"schema":{"oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}],"type":["null"]}},{"description":"If true or omitted, exclude custom status labels when querying by status.","in":"query","name":"status_excludes_label_ids","required":false,"schema":{"default":true,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"If true or omitted, exclude custom status labels when querying by status."}},{"description":"RFID tag or barcode","in":"query","name":"id_tag","required":false,"schema":{"type":["string","null"],"minLength":1,"maxLength":80,"description":"RFID tag or barcode"}},{"description":"One or more member statuses. Some statuses require extra permissions.","in":"query","name":"status","required":false,"schema":{"description":"One or more member statuses. Some statuses require extra permissions.","oneOf":[{"type":["string"],"enum":["OPERATIONAL","NON_OPERATIONAL","OBSERVER","RETIRED"],"description":"Status of member"},{"type":["array"],"items":{"type":["string"],"enum":["OPERATIONAL","NON_OPERATIONAL","OBSERVER","RETIRED"],"description":"Status of member"},"minItems":1}]}},{"description":"Return only deleted members","in":"query","name":"deleted","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"Return only deleted members"}},{"description":"Text compared with the member's name","in":"query","name":"name","required":false,"schema":{"type":["string"],"minLength":3,"description":"Text compared with the member's name"}},{"description":"Text compared with the member's name and email","in":"query","name":"search","required":false,"schema":{"type":["string"],"minLength":3,"description":"Text compared with the member's name and email"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id","name","ref","percReportingEvent","percReportingExercise","percReportingIncident","percRollingEvent","percRollingExercise","percRollingIncident","countRollingHours","countReportingEvent","countReportingExercise","countReportingHours","countReportingIncident","countRollingHoursEvent","countRollingHoursExercise","countRollingHoursIncident"]}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of members","content":{"application/json":{"example":{"results":[{"alertActivityApproval":true,"alertAllQualifications":true,"alertGear":true,"alertQualifications":true,"chatAutosubscribe":true,"chatDailyDigest":true,"contactUpdateMail":true,"costPerHour":50,"costPerUse":10,"countReportingEvent":20,"countReportingExercise":10,"countReportingHours":40,"countReportingIncident":5,"countRollingHours":30,"countRollingHoursEvent":15,"countRollingHoursExercise":25,"countRollingHoursIncident":3,"createdAt":"2026-07-03T06:46:50Z","credits":100,"defaultDuty":"ON","defaultEquipmentLocation":{"id":2,"resourceType":"EquipmentLocation"},"deprecatedAddress":"456 Oak Ave, Springfield, London, SW1A 1AA, England","email":{"value":"john.doe@example.com","verified":true},"primaryEmergencyContact":{"name":"Emergency Contact 1","primaryPhone":"555-123-4567","secondaryPhone":"555-987-6543","relation":"Parent"},"secondaryEmergencyContact":{"name":"Emergency Contact 2","primaryPhone":"555-555-5555","secondaryPhone":"555-666-6666","relation":"Sibling"},"endsAt":"2026-07-03T06:46:50Z","globalSyncId":"62a68dac60b511f09c4a325096b39f47","home":{"phone":"555-789-0123","verified":true},"icalSecret":"icalSecret123","id":1,"idTag":"RFID123","startsAt":"2026-07-03T06:46:50Z","lastLogin":"2026-07-03T06:46:50Z","location":{"type":"Point","coordinates":[12.3456,-78.9101]},"locationBookmark":{"id":4,"resourceType":"LocationBookmark"},"mobile":{"phone":"555-222-3333","verified":true},"name":"John Doe","notes":"Some notes here","pager":{"phone":"555-444-5555","email":"pager.email@example.com"},"percReportingEvent":50,"percReportingExercise":70,"percReportingIncident":30,"percRollingEvent":60,"percRollingExercise":80,"percRollingIncident":40,"permission":1,"deprecatedPermission":"MEMBER","position":"Manager","ref":"ABC123","retiredReason":{"id":null,"resourceType":"RetiredReason"},"role":{"id":7,"resourceType":"Role"},"signedTandC":"2026-07-03T06:46:50Z","status":"OPERATIONAL","customStatus":{"id":8,"resourceType":"CustomMemberStatus"},"teamAgreementSigned":"Agreement123","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:50Z","weeklyDayOfWeek":1,"weeklyDayOfWeekUtc":2,"weeklyHourOfDay":2,"weeklyHourOfDayUtc":2,"weeklyMail":true,"work":{"phone":"555-777-8888"},"resourceType":"Member","deletedAt":null,"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Members"]}},"/v3/{context}/{contextId}/modules":{"get":{"summary":"Get a particular module status","description":"Get a particular module status ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Module keys","in":"query","name":"setting","required":true,"schema":{"type":["string"],"enum":["activities","activity_approval_states","activity_current_location","activity_sharing","address_book","allow_deleteunit","allow_organisationlink","analytics","animals","api_allow_pat_access","app_equipment_enterprise","availability","calendar","charts","chat","collaboration","communication_for_members","communication","costing","courses_matrix","courses_preferred","courses","dashboard","documents_revisions","documents","duty","equipment_checklists","equipment_funding","equipment_inspections","equipment_purge","equipment_repairs","equipment_shipping_reports","equipment_team_move","equipment","events","exercises","groups","hazmat","healthsafety","hide_qualifications","incidents","location_custom","location_elevation","location_map","location","lost_behaviour","mapsar","member_emergency_contacts","members","old_communication","persons_involved_demographics","persons_involved_id","persons_involved_medical","persons_involved","reports","resources_coordinator","resources_detail","resources","revision_audit","roles","tags","tasks","team_status","translation","vehicles_involved","vehicles","weather_airtemperature","weather_avalancherisk","weather_cloudbase","weather_conditions","weather_seastate","weather_seaswell","weather_snowconditions","weather_tide","weather_visibility","weather_watertemperature","weather_wind_mps","weather_wind","weather","whiteboard"],"description":"Module keys"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"Whether the module is active or not","content":{"application/json":{"example":true}}}},"tags":["Settings"]}},"/v3/{context}/{contextId}/repairs":{"get":{"summary":"Retrieve a list of repairs","description":"Retrieve a list of repairs

**Required modules:** equipment_repairs","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"Date after which repairs were completed","in":"query","name":"completed_after","required":false,"schema":{"description":"Date after which repairs were completed","type":["string"],"format":"date-time"}},{"description":"Date before which repairs were completed","in":"query","name":"completed_before","required":false,"schema":{"description":"Date before which repairs were completed","type":["string"],"format":"date-time"}},{"description":"Date after which repairs were created","in":"query","name":"created_after","required":false,"schema":{"description":"Date after which repairs were created","type":["string"],"format":"date-time"}},{"description":"Date before which repairs were created","in":"query","name":"created_before","required":false,"schema":{"description":"Date before which repairs were created","type":["string"],"format":"date-time"}},{"description":"Date after which repairs were due for completion","in":"query","name":"due_after","required":false,"schema":{"description":"Date after which repairs were due for completion","type":["string"],"format":"date-time"}},{"description":"Date before which repairs were due for completion","in":"query","name":"due_before","required":false,"schema":{"description":"Date before which repairs were due for completion","type":["string"],"format":"date-time"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A member id","in":"query","name":"assigned_member_id","required":false,"schema":{"type":["integer"],"description":"A member id"}},{"description":"ID of the originator","in":"query","name":"originator_resource_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"ID of the originator"}},{"description":"Resource types that can be associated with a repair as the originator of the repair","in":"query","name":"originator_resource_type","required":false,"schema":{"type":["string"],"enum":["EquipmentInspectionResult","EquipmentInspectionStepResult"],"description":"Resource types that can be associated with a repair as the originator of the repair"}},{"description":"ID of the resource the repair is assigned to","in":"query","name":"target_resource_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"ID of the resource the repair is assigned to"}},{"description":"Resource types that can be associated with a repair","in":"query","name":"target_resource_type","required":false,"schema":{"type":["string"],"enum":["Equipment"],"description":"Resource types that can be associated with a repair"}},{"description":"An equipment location, represented by either an id or enum. Only an id or 'NONE' are available in the organisation context.","in":"query","name":"location_id","required":false,"schema":{"oneOf":[{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}},{"type":["string"]}],"description":"An equipment location, represented by either an id or enum. Only an id or 'NONE' are available in the organisation context."}},{"description":"The numeric identifier for a resource","in":"query","name":"fund_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},{"in":"query","name":"sort","required":false,"schema":{"type":["string"],"enum":["createdAt","updatedAt","id","dueAt"]}},{"in":"query","name":"status","required":false,"schema":{"oneOf":[{"type":["string"],"enum":["NOT_STARTED","IN_PROGRESS","COMPLETED"],"description":"Status of task"},{"type":["array"],"items":{"type":["string"],"enum":["NOT_STARTED","IN_PROGRESS","COMPLETED"],"description":"Status of task"},"minItems":1}]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of repair tasks","content":{"application/json":{"example":{"results":[{"id":6,"ref":"Fuga consequatur voluptatibus nulla est. Eaque eveniet tenetur commodi non.","description":null,"assigned":{"resourceType":"Member","id":5},"assignments":[{"id":21,"assignee":{"resourceType":"Member","id":466},"completedAt":null,"createdAt":"2025-10-01T08:35:43.000Z","owner":{"resourceType":"Team","id":5},"resourceType":"TaskAssignment","status":"NOT_STARTED","task":{"resourceType":"Task","id":102},"updatedAt":"2025-10-01T08:35:43.000Z"}],"createdBy":{"resourceType":"Member","id":5},"targetResource":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"dueAt":"2022-04-18T03:17:33.000Z","completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"cause":"NATURAL_DETERIORATION","cost":0,"activity":{"resourceType":"Activity","id":2},"fund":{"resourceType":"EquipmentFund","id":2},"originator":{"resourceType":"EquipmentInspectionResult","id":1},"createdAt":"2021-10-08T18:33:20.000Z","updatedAt":"2022-04-19T01:17:33.000Z","resourceType":"Repair"}],"page":1,"pageSize":2,"totalSize":1}}}}},"tags":["Equipment Repairs"]},"post":{"summary":"Create a repair","description":"Create a repair

**Required modules:** equipment_repairs","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"targetResourceId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"ID of the resource the repair is assigned to"},"targetResourceType":{"default":"Equipment","type":["string"],"enum":["Equipment"],"description":"Resource types that can be associated with a repair"},"originatorResourceId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"ID of the originator"},"originatorResourceType":{"type":["string"],"enum":["EquipmentInspectionResult","EquipmentInspectionStepResult"],"description":"Resource types that can be associated with a repair as the originator of the repair"},"ref":{"type":["string"],"minLength":1,"maxLength":40,"description":"The repair resource ref"},"cause":{"default":"UNKNOWN","type":["string"],"enum":["UNKNOWN","NATURAL_DETERIORATION","USED_AS_INTENDED","INCORRECT_OPERATION","PLANNED_MAINTENANCE"],"description":"Reason for repair"},"status":{"default":"NOT_STARTED","type":["string"],"enum":["NOT_STARTED","IN_PROGRESS","COMPLETED"],"description":"Status of repair"},"assignedMemberId":{"type":["integer"],"minimum":1,"description":"ID of the member resource repair is assigned to. DEPRECATED - use task-assignments endpoint."},"cost":{"type":["number"],"description":"Cost in whole cents, or equivalent sub-unit of team's currency."},"dueAt":{"description":"Date repair resource is due","type":["string"],"format":"date-time"},"description":{"type":["string"],"description":"Description of repair resource"},"activityId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"ID of the event, exercise, or incident resource that caused the repair"}},"required":["targetResourceId","ref"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A repair","content":{"application/json":{"example":{"id":6,"ref":"Fuga consequatur voluptatibus nulla est. Eaque eveniet tenetur commodi non.","description":null,"assigned":{"resourceType":"Member","id":5},"assignments":[{"id":21,"assignee":{"resourceType":"Member","id":466},"completedAt":null,"createdAt":"2025-10-01T08:35:43.000Z","owner":{"resourceType":"Team","id":5},"resourceType":"TaskAssignment","status":"NOT_STARTED","task":{"resourceType":"Task","id":102},"updatedAt":"2025-10-01T08:35:43.000Z"}],"createdBy":{"resourceType":"Member","id":5},"targetResource":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"dueAt":"2022-04-18T03:17:33.000Z","completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"cause":"NATURAL_DETERIORATION","cost":0,"activity":{"resourceType":"Activity","id":2},"fund":{"resourceType":"EquipmentFund","id":2},"originator":{"resourceType":"EquipmentInspectionResult","id":1},"createdAt":"2021-10-08T18:33:20.000Z","updatedAt":"2022-04-19T01:17:33.000Z","resourceType":"Repair"}}}}},"tags":["Equipment Repairs"]}},"/v3/{context}/{contextId}/resource-bundles":{"get":{"summary":"Retrieve a list of resource bundles","description":"Retrieve a list of resource bundles ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A simple text search term, compared against the title","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":80,"description":"A simple text search term, compared against the title"}},{"description":"If true `title` will return partial matches rather than exact. Match is case-insensitive either way.","in":"query","name":"partial_match_title","required":false,"schema":{"default":true,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"If true `title` will return partial matches rather than exact. Match is case-insensitive either way."}},{"in":"query","name":"resource_type","required":false,"schema":{"type":["string"],"enum":["CustomField"]}},{"description":"A resource type that supports custom fields","in":"query","name":"sub_resource_type","required":false,"schema":{"type":["string"],"enum":["Event","Exercise","Incident","IncidentWeather","Equipment","HealthSafetyReport","Member","PersonInvolved","Team"],"description":"A resource type that supports custom fields"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of resource bundles","content":{"application/json":{"example":{"results":[{"id":93,"owner":{"resourceType":"Team","id":40},"target":{"resourceType":"CustomField","subResourceType":"Member"},"title":"Rem corporis doloribus et neque rerum.","createdAt":"2026-07-03T06:46:51.538Z","updatedAt":"2026-07-03T06:46:51.538Z","resourceType":"ResourceBundle","ordering":0}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Resource Bundles"]},"post":{"summary":"Create a resource bundle","description":"Create a resource bundle ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":80,"description":"The Resource Bundle title"},"targetResourceType":{"type":["string"],"enum":["CustomField"]},"targetSubResourceType":{"type":["string"],"enum":["Event","Exercise","Incident","IncidentWeather","Equipment","HealthSafetyReport","Member","PersonInvolved","Team"],"description":"A resource type that supports custom fields"},"ordering":{"type":["integer"],"minimum":0,"maximum":255,"description":"A user-specified order in which to present the resources"}},"required":["title","targetResourceType"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A resource bundle","content":{"application/json":{"example":{"id":93,"owner":{"resourceType":"Team","id":40},"target":{"resourceType":"CustomField","subResourceType":"Member"},"title":"Rem corporis doloribus et neque rerum.","createdAt":"2026-07-03T06:46:51.538Z","updatedAt":"2026-07-03T06:46:51.538Z","resourceType":"ResourceBundle","ordering":0}}}}},"tags":["Resource Bundles"]}},"/v3/{context}/{contextId}/roles":{"get":{"summary":"Retrieve a list of roles","description":"Retrieve a list of roles

**Required modules:** roles","parameters":[{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"One or more team identifiers","in":"query","name":"team_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"One or more team identifiers","type":"array","items":{"type":"number"}}},{"description":"The role's bundle","in":"query","name":"deprecatedBundle","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":50,"description":"The role's bundle"}},{"description":"The role's title","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"The role's title"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A list of Roles","content":{"application/json":{"example":{"results":[{"id":1,"title":"This role's title","deprecatedBundle":"This role's bundle","owner":{"resourceType":"Team","id":1},"order":0,"cost":{"hour":20,"use":100},"resourceType":"Role","createdAt":"2026-07-03T06:46:50.985Z","updatedAt":"2026-07-03T06:46:50.985Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Roles"]}},"/v3/{context}/{contextId}/search":{"get":{"summary":"Retrieve search results for a particular query, optionally filtered by resource type","description":"Retrieve search results for a particular query, optionally filtered by resource type

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"default":10,"type":["integer"],"minimum":1,"maximum":100,"description":"Items per page"}},{"description":"Query terms used against the search index. Individual complete words separated by spaces works best.","in":"query","name":"query","required":true,"schema":{"type":["string"],"minLength":3,"description":"Query terms used against the search index. Individual complete words separated by spaces works best."}},{"description":"A valid resource types array","in":"query","name":"resource_type","required":false,"schema":{"description":"A valid resource types array","oneOf":[{"type":["string"],"enum":["Account","Activity","ActivityAttendance","ActivityCost","Animal","AnimalGroupMembership","AnimalQualificationAward","Attachment","CustomerIdentifier","CustomField","Document","DocumentRevision","Duty","Equipment","EquipmentBrand","EquipmentCategory","EquipmentFund","EquipmentKind","EquipmentKindToTeam","EquipmentInspection","EquipmentInspectionResult","EquipmentInspectionStep","EquipmentInspectionStepResult","EquipmentLocation","EquipmentModel","EquipmentMove","EquipmentParent","EquipmentRetiredReason","EquipmentSupplier","EquipmentSupplierRef","EquipmentUsage","Event","Exercise","Folder","GroupTeam","Handler","HandlerGroupMembership","HandlerQualificationAward","HealthSafetyCategory","HealthSafetyReport","HealthSafetySeverity","Incident","IncidentWeather","LocationBookmark","Member","MemberCustomStatus","MemberQualificationAward","MemberGroupMembership","MemberRetiredReason","Officer","OfficerPermissionProfile","OfficerToPermissionProfile","Organisation","PermissionProfile","Repair","Resource","Role","ResourceBundle","Tag","Task","TaskAssignment","Team","PersonInvolved","PersonInvolvedInjury","Whiteboard","AnimalGroup","HandlerGroup","MemberGroup","AnimalQualification","HandlerQualification","MemberQualification","TestTable","TestRelatedTable","TestTable2TestRelatedTable"],"description":"A valid resource type"},{"type":["array"],"items":{"type":["string"],"enum":["Account","Activity","ActivityAttendance","ActivityCost","Animal","AnimalGroupMembership","AnimalQualificationAward","Attachment","CustomerIdentifier","CustomField","Document","DocumentRevision","Duty","Equipment","EquipmentBrand","EquipmentCategory","EquipmentFund","EquipmentKind","EquipmentKindToTeam","EquipmentInspection","EquipmentInspectionResult","EquipmentInspectionStep","EquipmentInspectionStepResult","EquipmentLocation","EquipmentModel","EquipmentMove","EquipmentParent","EquipmentRetiredReason","EquipmentSupplier","EquipmentSupplierRef","EquipmentUsage","Event","Exercise","Folder","GroupTeam","Handler","HandlerGroupMembership","HandlerQualificationAward","HealthSafetyCategory","HealthSafetyReport","HealthSafetySeverity","Incident","IncidentWeather","LocationBookmark","Member","MemberCustomStatus","MemberQualificationAward","MemberGroupMembership","MemberRetiredReason","Officer","OfficerPermissionProfile","OfficerToPermissionProfile","Organisation","PermissionProfile","Repair","Resource","Role","ResourceBundle","Tag","Task","TaskAssignment","Team","PersonInvolved","PersonInvolvedInjury","Whiteboard","AnimalGroup","HandlerGroup","MemberGroup","AnimalQualification","HandlerQualification","MemberQualification","TestTable","TestRelatedTable","TestTable2TestRelatedTable"],"description":"A valid resource type"}}],"type":"array","items":{"type":"string"}}},{"in":"query","name":"sort","required":false,"schema":{"default":"relevance","type":["string"],"enum":["title","relevance"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of search results","content":{"application/json":{"example":{"results":[{"id":1,"title":"Avalanche Rescue","meta":{"description":"Avalanche Rescue Equipment description","date":"2026-07-03T06:46:51.561Z"},"owner":{"id":1,"resourceType":"Team"},"resourceType":"Equipment"}],"page":0,"totalSize":1,"pageSize":1}}}}},"tags":[" API Utilities"]}},"/v3/{context}/{contextId}/tags":{"get":{"summary":"Retrieve a list of tags","description":"Retrieve a list of tags

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"The title of a resource","in":"query","name":"title","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":100,"description":"The title of a resource"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","id","updatedAt","title"]}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of tags","content":{"application/json":{"example":{"results":[{"createdAt":"2026-07-03T06:46:51.569Z","title":"Avalanche Rescue","id":1,"notes":"Some text about this tag","resourceType":"Tag","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:51.569Z"}],"page":0,"totalSize":1,"pageSize":1}}}}},"tags":["Tags"]},"post":{"summary":"Create a tag","description":"Create a tag

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":100,"description":"The title of a resource"},"notes":{"type":["string"],"minLength":1,"maxLength":65535,"description":"Some descriptive text for the resource"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A tag resource","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51.569Z","title":"Avalanche Rescue","id":1,"notes":"Some text about this tag","resourceType":"Tag","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:51.569Z"}}}}},"tags":["Tags"]}},"/v3/{context}/{contextId}/task-assignments":{"get":{"summary":"Retrieve a list of task assignments","description":"Retrieve a list of task assignments

**Required modules:** tasks","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"Filter by task assignment ID","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"Filter by task assignment ID","type":"array","items":{"type":"number"}}},{"description":"Filter by task ID","in":"query","name":"task_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"Filter by task ID","type":"array","items":{"type":"number"}}},{"description":"Filter by assignee ID","in":"query","name":"assignee_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Filter by assignee ID"}},{"description":"Date after which assignments were completed","in":"query","name":"completed_after","required":false,"schema":{"description":"Date after which assignments were completed","type":["string"],"format":"date-time"}},{"description":"Date before which assignments were completed","in":"query","name":"completed_before","required":false,"schema":{"description":"Date before which assignments were completed","type":["string"],"format":"date-time"}},{"in":"query","name":"status","required":false,"schema":{"oneOf":[{"type":["string"],"enum":["NOT_STARTED","IN_PROGRESS","COMPLETED"],"description":"Status of task"},{"type":["array"],"items":{"type":["string"],"enum":["NOT_STARTED","IN_PROGRESS","COMPLETED"],"description":"Status of task"},"minItems":1}]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of task assignments","content":{"application/json":{"example":{"results":[{"id":1,"task":{"resourceType":"Task","id":5},"assignee":{"resourceType":"Member","id":10},"completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"TaskAssignment"}],"page":1,"pageSize":2,"totalSize":1}}}}},"tags":["Tasks"]}},"/v3/{context}/{contextId}/tasks":{"get":{"summary":"Retrieve a list of tasks","description":"Retrieve a list of tasks

**Required modules:** tasks","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"Date after which tasks were completed","in":"query","name":"completed_after","required":false,"schema":{"description":"Date after which tasks were completed","type":["string"],"format":"date-time"}},{"description":"Date before which tasks were completed","in":"query","name":"completed_before","required":false,"schema":{"description":"Date before which tasks were completed","type":["string"],"format":"date-time"}},{"description":"Date after which tasks were created","in":"query","name":"created_after","required":false,"schema":{"description":"Date after which tasks were created","type":["string"],"format":"date-time"}},{"description":"Date before which tasks were created","in":"query","name":"created_before","required":false,"schema":{"description":"Date before which tasks were created","type":["string"],"format":"date-time"}},{"description":"Date after which tasks were due for completion","in":"query","name":"due_after","required":false,"schema":{"description":"Date after which tasks were due for completion","type":["string"],"format":"date-time"}},{"description":"Date before which tasks were due for completion","in":"query","name":"due_before","required":false,"schema":{"description":"Date before which tasks were due for completion","type":["string"],"format":"date-time"}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}},{"description":"A member id - returns tasks assigned directly to the member or to groups the member belongs to","in":"query","name":"assigned_member_id","required":false,"schema":{"type":["integer"],"description":"A member id - returns tasks assigned directly to the member or to groups the member belongs to"}},{"description":"When true and assigned_member_id is provided, also include tasks with no assignment","in":"query","name":"include_unassigned","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"When true and assigned_member_id is provided, also include tasks with no assignment"}},{"description":"ID of the resource the task is assigned to","in":"query","name":"target_resource_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"ID of the resource the task is assigned to"}},{"description":"Resource types that can be associated with a task","in":"query","name":"target_resource_type","required":false,"schema":{"type":["string"],"enum":["AnimalGroup","Equipment","EquipmentBrand","EquipmentCategory","EquipmentFund","EquipmentInspection","EquipmentKind","EquipmentLocation","EquipmentModel","EquipmentSupplier","EquipmentSupplierRef","Event","Exercise","Folder","HandlerGroup","HealthSafetyReport","Incident","Member","MemberGroup","MemberQualification","Resource","Tag"],"description":"Resource types that can be associated with a task"}},{"description":"Completion type of the task","in":"query","name":"completion_type","required":false,"schema":{"type":["string"],"enum":["ANY"],"description":"Completion type of the task"}},{"in":"query","name":"sort","required":false,"schema":{"type":["string"],"enum":["createdAt","updatedAt","id","dueAt","dateCompleted"]}},{"in":"query","name":"status","required":false,"schema":{"oneOf":[{"type":["string"],"enum":["NOT_STARTED","IN_PROGRESS","COMPLETED"],"description":"Status of task"},{"type":["array"],"items":{"type":["string"],"enum":["NOT_STARTED","IN_PROGRESS","COMPLETED"],"description":"Status of task"},"minItems":1}]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of tasks","content":{"application/json":{"example":{"results":[{"id":1,"ref":"TASK-001","description":"Example task description","completionType":"ANY","assigned":[{"id":1,"task":{"resourceType":"Task","id":1},"assignee":{"resourceType":"Member","id":5},"completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"TaskAssignment"}],"createdBy":{"resourceType":"Member","id":5},"targetResource":{"resourceType":"Event","id":15},"dueAt":"2023-12-31T23:59:59.000Z","completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"Task"}],"page":1,"pageSize":2,"totalSize":1}}}}},"tags":["Tasks"]}},"/v3/{context}/{contextId}/whiteboard":{"get":{"summary":"Retrieve a list of whiteboard notes","description":"Retrieve a list of whiteboard notes

**Required modules:** whiteboard","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Whiteboard note"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Whiteboard note"}}],"description":"A list of ids"}},{"description":"A datetime which a note's archivedAt is before","in":"query","name":"archived_at_before","required":false,"schema":{"description":"A datetime which a note's archivedAt is before","type":["string"],"format":"date-time"}},{"description":"A datetime which a note's archivedAt is after","in":"query","name":"archived_at_after","required":false,"schema":{"description":"A datetime which a note's archivedAt is after","type":["string"],"format":"date-time"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","archivedAt","id","text"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A list of whiteboard notes","content":{"application/json":{"example":{"results":[{"createdAt":"2026-07-03T06:46:51.599Z","archivedAt":"2026-07-03T06:46:51.599Z","id":1,"author":{"resourceType":"Member","id":1},"text":"","resourceType":"Whiteboard","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:51.599Z","important":false,"url":"http://d4h.com"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Whiteboard"]},"post":{"summary":"Create a whiteboard note","description":"Create a whiteboard note

**Required modules:** whiteboard","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"archivedAt":{"default":"2026-07-03T06:46:51.599Z","description":"The date-time at which the note is archived","type":["string"],"format":"date-time"},"important":{"description":"Set to true to mark the note as important","default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}]},"text":{"type":["string"],"minLength":3,"maxLength":140,"description":"The contents of the note. Supports plain text or HTML."},"url":{"type":["string"],"format":"uri","minLength":1,"maxLength":2083,"description":"A http/https RFC-3986 URI to be associate with the note"}},"required":["text"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A whiteboard note","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51.599Z","archivedAt":"2026-07-03T06:46:51.599Z","id":1,"author":{"resourceType":"Member","id":1},"text":"","resourceType":"Whiteboard","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:51.599Z","important":false,"url":"http://d4h.com"}}}}},"tags":["Whiteboard"]}},"/v3/{context}/{contextId}/whoami":{"get":{"summary":"Retrieve credential access for a specific context","description":"Retrieve credential access for a specific context ","parameters":[],"security":[{"Unified":[]}],"responses":{"200":{"description":"Access details of credentials for a specific context","content":{"application/json":{"example":{"account":{"id":1,"resourceType":"Account"},"context":{"id":1,"owner":{"resourceType":"Team","id":1,"title":"Team Y","owner":{"id":4,"resourceType":"Organisation"}},"name":"Member X","hasAccess":true,"resourceType":"Member","permissions":{"Animal":{"READ":false,"CREATE":false,"DELETE":false,"EXPORT":false,"UPDATE":false},"Handler":{"READ":false,"CREATE":false,"DELETE":false,"EXPORT":false,"UPDATE":false},"AnimalGroup":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true,"EXPORT":false},"AnimalQualification":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"AnimalQualificationAward":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"ActivityAttendance":{"CREATE":false,"DELETE":false,"READ":false,"UPDATE":false,"UPDATEOWN":true},"Audit":{"CREATE":false,"DELETE":false,"READ":false},"BillingUnit":{"DELETE":false,"READ":false,"CREATE":false,"UPDATE":false,"EXPORT":false},"CustomerIdentifier":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Division":{"CREATE":true,"DEFAULT_ACCESS":true,"DELETE":true,"READ":true},"Document":{"CREATE_SECURE":false,"CREATE":false,"DELETE_SECURE":false,"DELETE":false,"DOWNLOAD_SECURE":false,"DOWNLOAD":false,"EXPORT_SECURE":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE_SECURE":false,"UPDATE":false},"Duty":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"EntityToCustomField":{"UPDATE":false},"Equipment":{"CREATE_CUSTOM_FIELDS":false,"CREATE":true,"DELETE_CUSTOM_FIELDS":false,"DELETE":true,"EXPORT":true,"READ_SECURE":false,"READ":true,"RETIRE":true,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_COSTING":false,"UPDATE_SECURE":false,"UPDATE":true,"UPDATE_STATUS":true},"EquipmentInspection":{"CREATE":true,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"EquipmentInspectionResult":{"CREATE":true,"DELETE":true,"DELETE_LIMITED":true,"EXPORT":true,"READ":true,"UPDATE":true,"UPDATE_RESULT":true},"EquipmentLocation":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Event":{"ARCHIVED":false,"CREATE":false,"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"DRAFT":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"Exercise":{"ARCHIVED":false,"CREATE":false,"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"DRAFT":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"HandlerGroup":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true,"EXPORT":false},"HandlerQualification":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"HandlerQualificationAward":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"HealthSafetyCategory":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"HealthSafetyReport":{"APPROVE":false,"CREATE_SECURE":false,"CREATE":false,"DELETE":false,"EXPORT":false,"READ_SECURE":false,"READ":false,"UPDATE_SECURE":false,"UPDATE":false},"HealthSafetySeverity":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Incident":{"ARCHIVED":false,"CREATE":false,"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"DRAFT":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"LocationBookmark":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Member":{"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"CREATE":false,"DELETE_CUSTOM_FIELDS":false,"DELETE":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"RETIRE":true,"UPDATE_COSTING":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false,"UPDATE":false,"UPDATEOWN":false},"MemberCustomStatus":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true},"MemberGroup":{"DELETE":true,"READ":true,"CREATE":true,"UPDATE":true,"EXPORT":false},"MemberQualification":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"MemberQualificationAward":{"ARCHIVED":false,"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"OfficerPermissionProfile":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"PermissionProfile":{"CREATE":false,"DELETE":true,"EXPORT":true,"READ":true,"UPDATE":true},"PersonInvolved":{"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"CREATE":false,"DELETE_CUSTOM_FIELDS":false,"DELETE":false,"EXPORT":false,"READ_SECURE":false,"READ":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false,"UPDATE":false},"Repair":{"ASSIGN_UNASSIGNED":false,"CREATE":true,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true,"UPDATEOWN":false},"Resource":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Role":{"CREATE":false,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true},"Setting":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":true,"UPDATE":true},"Tag":{"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false},"Task":{"CREATE":true,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true},"TaskAssignment":{"CREATE":true,"DELETE":true,"EXPORT":false,"READ":true,"UPDATE":true},"Team":{"CREATE_CUSTOM_FIELDS":false,"CREATE_SECURE":false,"DELETE":false,"DELETE_CUSTOM_FIELDS":false,"EXPORT":false,"READ_SECURE":false,"READ":true,"UPDATE":false,"UPDATE_CUSTOM_FIELDS":false,"UPDATE_SECURE":false},"Whiteboard":{"ARCHIVED":false,"CREATE":false,"DELETE":false,"EXPORT":false,"READ":false,"UPDATE":false,"UPDATEOWN":false}}}}}}}},"tags":["Accounts / Credentials"]}},"/v3/team/{teamId}/duties/add-duty-period":{"post":{"summary":"Add a duty period","description":"Add a duty period

**Required modules:** duty","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"type":{"type":["string"],"enum":["OFF","ON"],"description":"The type of duty period"},"memberId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"startsAt":{"description":"An ISO8601 datetime string","type":["string"],"format":"date-time"},"endsAt":{"description":"An ISO8601 datetime string","type":["string"],"format":"date-time"},"roleId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"notes":{"type":["string","null"],"maxLength":65535}},"required":["type","memberId","startsAt","endsAt"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A duty","content":{"application/json":{"example":{"id":1,"notes":"A note about this duty","startsAt":"2026-07-03T06:46:50.987Z","endsAt":"2026-07-03T06:46:50.987Z","type":"OFF","role":{"id":1,"title":"This role's title","deprecatedBundle":"This role's bundle","owner":{"resourceType":"Team","id":1},"order":0,"cost":{"hour":20,"use":100},"resourceType":"Role","createdAt":"2026-07-03T06:46:50.985Z","updatedAt":"2026-07-03T06:46:50.985Z"},"parent":{"resourceType":"Duty","id":1},"member":{"alertActivityApproval":true,"alertAllQualifications":true,"alertGear":true,"alertQualifications":true,"chatAutosubscribe":true,"chatDailyDigest":true,"contactUpdateMail":true,"costPerHour":50,"costPerUse":10,"countReportingEvent":20,"countReportingExercise":10,"countReportingHours":40,"countReportingIncident":5,"countRollingHours":30,"countRollingHoursEvent":15,"countRollingHoursExercise":25,"countRollingHoursIncident":3,"createdAt":"2026-07-03T06:46:50Z","credits":100,"defaultDuty":"ON","defaultEquipmentLocation":{"id":2,"resourceType":"EquipmentLocation"},"deprecatedAddress":"456 Oak Ave, Springfield, London, SW1A 1AA, England","email":{"value":"john.doe@example.com","verified":true},"primaryEmergencyContact":{"name":"Emergency Contact 1","primaryPhone":"555-123-4567","secondaryPhone":"555-987-6543","relation":"Parent"},"secondaryEmergencyContact":{"name":"Emergency Contact 2","primaryPhone":"555-555-5555","secondaryPhone":"555-666-6666","relation":"Sibling"},"endsAt":"2026-07-03T06:46:50Z","globalSyncId":"62a68dac60b511f09c4a325096b39f47","home":{"phone":"555-789-0123","verified":true},"icalSecret":"icalSecret123","id":1,"idTag":"RFID123","startsAt":"2026-07-03T06:46:50Z","lastLogin":"2026-07-03T06:46:50Z","location":{"type":"Point","coordinates":[12.3456,-78.9101]},"locationBookmark":{"id":4,"resourceType":"LocationBookmark"},"mobile":{"phone":"555-222-3333","verified":true},"name":"John Doe","notes":"Some notes here","pager":{"phone":"555-444-5555","email":"pager.email@example.com"},"percReportingEvent":50,"percReportingExercise":70,"percReportingIncident":30,"percRollingEvent":60,"percRollingExercise":80,"percRollingIncident":40,"permission":1,"deprecatedPermission":"MEMBER","position":"Manager","ref":"ABC123","retiredReason":{"id":null,"resourceType":"RetiredReason"},"role":{"id":7,"resourceType":"Role"},"signedTandC":"2026-07-03T06:46:50Z","status":"OPERATIONAL","customStatus":{"id":8,"resourceType":"CustomMemberStatus"},"teamAgreementSigned":"Agreement123","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:50Z","weeklyDayOfWeek":1,"weeklyDayOfWeekUtc":2,"weeklyHourOfDay":2,"weeklyHourOfDayUtc":2,"weeklyMail":true,"work":{"phone":"555-777-8888"},"resourceType":"Member","deletedAt":null,"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"owner":{"resourceType":"Team","id":1},"repeat":{"every":{"interval":"WEEK","period":1},"until":"2026-07-03T06:46:50.987Z"},"resourceType":"Duty","createdAt":"2026-07-03T06:46:50.987Z","updatedAt":"2026-07-03T06:46:50.987Z"}}}}},"tags":["Duties"]}},"/v3/{context}/{contextId}/documents/metadata":{"get":{"summary":"Retrieve the context's documents metadata","description":"Retrieve the context's documents metadata

**Required modules:** documents","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"Documents metadata","content":{"application/json":{"example":{"documentStorageUsed":1}}}}},"tags":["Documents"]}},"/v3/{context}/{contextId}/duties/on-call-now":{"get":{"summary":"Retrieve list of members on-call right now","description":"Retrieve list of members on-call right now

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A team resource id. Ignored in team context.","in":"query","name":"team_id","required":false,"schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A team resource id. Ignored in team context."}},{"description":"A list of numeric identifiers representing resources","in":"query","name":"member_id","required":false,"schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"description":"A list of numeric identifiers representing resources","type":"array","items":{"type":"number"}}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"Member on-call data","content":{"application/json":{"example":{"results":[{"member":{"id":1,"name":"Join Boing Jovni","resourceType":"Member","owner":{"id":1,"resourceType":"Team"}},"currentPeriod":{"startsAt":"2026-07-03T06:46:51.733Z","endsAt":"2026-07-03T06:46:51.733Z","notes":"Some notes about the duty"},"groups":[{"id":1,"title":"A member group","resourceType":"MemberGroup","owner":{"id":1,"resourceType":"Team"}}]}],"page":0,"pageSize":1}}}}},"tags":["Duties"]}},"/v3/{context}/{contextId}/equipment-brands/merge":{"post":{"summary":"Merge one equipment brand into another","description":"Merge one equipment brand into another

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"originId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The origin ID of the equipment brand that will be merged"},"destinationId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The destination ID of the equipment brand that will be merged"}},"required":["originId","destinationId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment brand","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Brands"]}},"/v3/{context}/{contextId}/equipment-categories/merge":{"post":{"summary":"Merge one equipment category into another","description":"Merge one equipment category into another

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"originId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The origin ID of the equipment category that will be merged"},"destinationId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The destination ID of the equipment category that will be merged"}},"required":["originId","destinationId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment category","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Categories"]}},"/v3/{context}/{contextId}/equipment-kinds/merge":{"post":{"summary":"Merge one equipment kind into another","description":"Merge one equipment kind into another

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"originId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The origin ID of the equipment kind that will be merged"},"destinationId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The destination ID of the equipment kind that will be merged"}},"required":["originId","destinationId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment kind","content":{"application/json":{"example":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"}}}}},"tags":["Equipment Kinds"]}},"/v3/{context}/{contextId}/equipment-models/merge":{"post":{"summary":"Merge one equipment model into another","description":"Merge one equipment model into another

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"originId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The origin ID of the equipment model that will be merged"},"destinationId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The destination ID of the equipment model that will be merged"}},"required":["originId","destinationId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment model","content":{"application/json":{"example":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Models"]}},"/v3/{context}/{contextId}/equipment-supplier-refs/merge":{"post":{"summary":"Merge one equipment supplier reference into another","description":"Merge one equipment supplier reference into another

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"originId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The origin ID of the equipment supplier reference that will be merged"},"destinationId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The destination ID of the equipment supplier reference that will be merged"}},"required":["originId","destinationId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment supplier reference","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A supplier reference","supplier":{"id":1,"resourceType":"EquipmentSupplier"},"createdAt":"2026-07-03T06:46:51.787Z","updatedAt":"2026-07-03T06:46:51.787Z","resourceType":"EquipmentSupplierRef"}}}}},"tags":["Equipment Supplier References"]}},"/v3/{context}/{contextId}/equipment-suppliers/merge":{"post":{"summary":"Merge one equipment supplier into another","description":"Merge one equipment supplier into another

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"originId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The origin ID of the equipment supplier that will be merged"},"destinationId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The destination ID of the equipment supplier that will be merged"}},"required":["originId","destinationId"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment supplier","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A supplier","createdAt":"2026-07-03T06:46:51.793Z","updatedAt":"2026-07-03T06:46:51.793Z","resourceType":"EquipmentSupplier"}}}}},"tags":["Equipment Suppliers"]}},"/v3/team/{teamId}/animal-group-memberships/{animalGroupMembershipId}":{"delete":{"summary":"Delete an animal group membership","description":"Delete an animal group membership

**Required modules:** ","parameters":[{"description":"Team's id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Team's id"}},{"description":"An animal's group membership identifier","in":"path","required":true,"name":"animalGroupMembershipId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An animal's group membership identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"AnimalGroupMembership","message":"An optional message"}}}}},"tags":["Group Memberships"]}},"/v3/team/{teamId}/attendance/{attendanceId}":{"patch":{"summary":"Update an activity attendance","description":"Update an activity attendance

**Required modules:** activities,members","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"oneOf":[{"type":["integer"],"minimum":1},{"type":["string"],"minLength":32,"maxLength":32,"pattern":"^[0-9a-f]{32}$","description":"A global resource identifier for cross-product sync"}],"description":"A team id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"attendanceId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"status":{"type":["string"],"enum":["ABSENT","ATTENDING","REQUESTED"],"description":"The status of the attendance resource"},"roleId":{"oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"]},"startsAt":{"description":"Start of the attendance period","type":["string"],"format":"date-time"},"endsAt":{"description":"End of the attendance period","type":["string"],"format":"date-time"}}}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An activity attendance","content":{"application/json":{"example":{"activity":{"resourceType":"Incident","id":1},"createdAt":"2026-07-03T06:46:50.671Z","duration":1,"endsAt":"2026-07-03T06:46:50.671Z","id":1,"member":{"resourceType":"Member","id":1},"owner":{"resourceType":"Team","id":1},"startsAt":"2026-07-03T06:46:50.671Z","status":"ABSENT","resourceType":"ActivityAttendance","role":{"id":1,"resourceType":"Role"},"updatedAt":"2026-07-03T06:46:50.671Z"}}}}},"tags":["Activity Attendance"]},"delete":{"summary":"Delete an activity attendance","description":"Delete an activity attendance

**Required modules:** activities,members","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"oneOf":[{"type":["integer"],"minimum":1},{"type":["string"],"minLength":32,"maxLength":32,"pattern":"^[0-9a-f]{32}$","description":"A global resource identifier for cross-product sync"}],"description":"A team id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"attendanceId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"ActivityAttendance","message":"An optional message"}}}}},"tags":["Activity Attendance"]}},"/v3/team/{teamId}/duties/{dutyId}":{"delete":{"summary":"Delete a duty period","description":"Delete a duty period

**Required modules:** duty","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"dutyId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},{"description":"If true, all repetitions of the duty later than the target will also be deleted","in":"query","name":"all_following","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean","description":"If true, all repetitions of the duty later than the target will also be deleted"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"Duty","message":"An optional message"}}}}},"tags":["Duties"]}},"/v3/team/{teamId}/equipment-locations/{equipmentLocationId}":{"patch":{"summary":"Update an equipment location","description":"Update an equipment location

**Required modules:** equipment","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"An equipment location`s id","in":"path","required":true,"name":"equipmentLocationId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An equipment location`s id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1},"deprecatedBundle":{"type":["string"],"minLength":1,"maxLength":50,"description":"The bundle of a resource"},"description":{"type":["string"],"description":"The description of a resource"},"address":{"type":["object"],"properties":{"country":{"type":["string"],"description":"Country"},"postcode":{"type":["string"],"maxLength":100,"description":"Postcode or ZIP code"},"region":{"type":["string"],"maxLength":100,"description":"Province, county or region"},"street":{"type":["string"],"maxLength":100,"description":"Number, street and house"},"town":{"type":["string"],"maxLength":100,"description":"City or town"}}},"location":{"type":["object","null"],"properties":{"latitude":{"type":["number"],"minimum":-90,"maximum":90,"description":"The latitude where this entity is located"},"longitude":{"type":["number"],"minimum":-180,"maximum":180,"description":"The longitude where this entity is located"}},"required":["latitude","longitude"]}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"The updated equipment location","content":{"application/json":{"example":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"}}}}},"tags":["Equipment Locations"]},"delete":{"summary":"Delete an equipment location","description":"Delete an equipment location

**Required modules:** equipment","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"An equipment location`s id","in":"path","required":true,"name":"equipmentLocationId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An equipment location`s id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"Equipment location deleted successfully","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentLocation","message":"An optional message"}}}}},"tags":["Equipment Locations"]}},"/v3/team/{teamId}/handler-group-memberships/{handlerGroupMembershipId}":{"delete":{"summary":"Delete a handler group membership`","description":"Delete a handler group membership`

**Required modules:** ","parameters":[{"description":"Team's id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Team's id"}},{"description":"A handler's group membership identifier","in":"path","required":true,"name":"handlerGroupMembershipId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A handler's group membership identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"HandlerGroupMembership","message":"An optional message"}}}}},"tags":["Group Memberships"]}},"/v3/team/{teamId}/health-safety-reports/{resourceId}":{"patch":{"summary":"Update a Health & Safety Report","description":"Update a Health & Safety Report

**Required modules:** healthsafety","parameters":[{"description":"Team's id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Team's id"}},{"description":"The ID of the Health & Safety Report","in":"path","required":true,"name":"resourceId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Report"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"targetResourceId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of an associated resource"},"targetResourceType":{"type":["string"],"enum":["Incident","Event","Exercise"],"description":"The resource-type associated with the report"},"address":{"type":["object"],"properties":{"country":{"type":["string"],"maxLength":100,"description":"The country where this occurance took place"},"postcode":{"type":["string"],"maxLength":100,"description":"The postcode where this occurance took place"},"region":{"type":["string"],"maxLength":100,"description":"The region where this occurance took place"},"street":{"type":["string"],"maxLength":100,"description":"The street where this occurance took place"},"town":{"type":["string"],"maxLength":100,"description":"The town where this occurance took place"}}},"categoryId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A Health & Safety Category ID"},"cause":{"type":["string","null"],"description":"The cause of this occurance"},"startsAt":{"description":"The date-time of this occurance","type":["string","null"],"format":"date-time"},"description":{"type":["string","null"],"description":"The description of this occurance"},"location":{"type":["object"],"properties":{"lat":{"type":["number","null"],"minimum":-90,"maximum":90,"description":"The latitude where this occurance took place"},"lng":{"type":["number","null"],"minimum":-180,"maximum":180,"description":"The longtitude where this occurance took place"}},"required":["lat","lng"]},"measures":{"type":["string","null"],"description":"The measures taken because of this occurance"},"severityId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A Health & Safety Severity ID"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A Health & Safety Report","content":{"application/json":{"example":{"targetResource":{"id":1,"resourceType":"Incident"},"address":{"country":"","postcode":"","region":"","street":"","town":""},"approvedAt":"2026-07-03T06:46:43.215Z","category":{"id":1,"resourceType":"HealthSafetyCategory"},"cause":"Some cause","createdAt":"2026-07-03T06:46:43.215Z","startsAt":"2026-07-03T06:46:43.215Z","description":"","id":1,"location":{"type":"Point","coordinates":[0,0]},"measures":"","resourceType":"HealthSafetyReport","severity":{"id":1,"resourceType":"HealthSafetySeverity"},"owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:43.215Z","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Health & Safety"]},"delete":{"summary":"Delete a Health & Safety Report","description":"Delete a Health & Safety Report

**Required modules:** healthsafety","parameters":[{"description":"Team's id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Team's id"}},{"description":"The ID of the Health & Safety Report","in":"path","required":true,"name":"resourceId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Report"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"HealthSafetyReport","message":"An optional message"}}}}},"tags":["Health & Safety"]}},"/v3/team/{teamId}/incident-involved-injuries/{involvedInjuryId}":{"patch":{"summary":"Update a record of a person involved injury","description":"Update a record of a person involved injury

**Required modules:** persons_involved_medical","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"involvedInjuryId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"injuryLocationId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Injury location id (see enum endpoint)"},"injuryTypeId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Injury type id (see enum endpoint)"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A person involved injury","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:50Z","id":1,"injury":{"id":30,"title":"Face","category":"HEAD"},"injuryType":{"id":12,"title":"Sprain","bundle":"MUSCULOSKELETAL","location":"ANY"},"owner":{"id":1,"resourceType":"Team"},"person":{"resourceType":"PersonInvolved","id":1},"resourceType":"PersonInvolvedInjury","updatedAt":"2026-07-03T06:46:50Z"}}}}},"tags":["Incidents"]},"delete":{"summary":"Delete a person involved injury","description":"Delete a person involved injury

**Required modules:** persons_involved_medical","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"involvedInjuryId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"PersonInvolvedInjury","message":"An optional message"}}}}},"tags":["Incidents"]}},"/v3/team/{teamId}/incident-involved-persons/{involvedPersonId}":{"patch":{"summary":"Update a record of a person involved in an incident","description":"Update a record of a person involved in an incident

**Required modules:** persons_involved","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"Involved person's id","in":"path","required":true,"name":"involvedPersonId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Involved person's id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"age":{"type":["integer"],"exclusiveMinimum":0,"maximum":666,"description":"Person age"},"areaKnowledge":{"type":["string"],"enum":["UNFAMILIAR","FAMILIAR"],"description":"Is person familiar with the locality"},"assistance":{"type":["string"],"maxLength":65535,"description":"Notes on medical assistance"},"cause":{"type":["string"],"enum":["NO_DATA","ACCIDENTAL","INTENTIONAL_SELF","INTENTIONAL_OTHER","UNDETERMINED"],"description":"Cause information"},"contact":{"type":["string"],"maxLength":65535,"description":"Contact information"},"dateOfBirth":{"type":["string"],"description":"Date of birth"},"handover":{"type":["string"],"enum":["NO_FURTHER_ASSISTANCE","HOSPITAL","ONSITE_FACILITY"],"description":"Handover information"},"involvementNotes":{"type":["string"],"maxLength":65535,"description":"Involvement notes"},"involvementTypeId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Person involved involvement type id. Some involvement types also require an outcomeId. See enum endpoint for details."},"name":{"type":["string"],"maxLength":100,"description":"Person's name"},"nationality":{"type":["string"],"enum":["AF","AL","DZ","AD","AO","AG","AR","AM","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BT","BO","BA","BW","BR","BN","BG","BF","BI","KH","CM","CA","CV","CF","TD","CL","CN","CO","KM","CG","CD","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FJ","FI","FR","GA","GM","GE","DE","GH","GR","GD","GT","GN","GW","GY","HT","VA","HN","HU","IS","IN","ID","IR","IQ","IE","IL","IT","JM","JP","JO","KZ","KE","KI","KR","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MK","MG","MW","MY","MV","ML","MT","MH","MR","MU","MX","FM","MD","MC","MN","MA","MZ","MM","NA","NR","NP","NL","NZ","NI","NE","NG","NO","OM","PK","PW","PA","PG","PY","PE","PH","PL","PT","QA","RO","RU","RW","KN","LC","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","ES","LK","SD","SR","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TO","TT","TN","TR","TM","TV","UG","UA","AE","GB","US","UY","UZ","VU","VE","VN","VG","YE","ZM","ZW","XK"],"description":"Country code representing person's nationality"},"outcomeId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Person involved outcome id. Only applicable to certain involvement types. See enum endpoint for details."},"sex":{"type":["string"],"enum":["MALE","FEMALE","OTHER"],"description":"The person's sex"},"spinalInjury":{"type":["string"],"enum":["SUSPECTED","CLEARED","NOT_INDICATED","UNDETERMINED"],"description":"Spinal injury status"},"transfer":{"type":["string"],"enum":["SELF","HOSPITAL"],"description":"How they were transferred to hospital"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A person involved in an incident","content":{"application/json":{"example":{"incident":{"resourceType":"Incident","id":1},"age":21,"areaKnowledge":"UNFAMILIAR","cause":"UNDETERMINED","contact":"Joe Duffy, call this number 123456789 and talk to Joe","createdAt":"2026-07-03T06:46:50Z","dateOfBirth":"1990-01-01","handover":"HOSPITAL","id":1,"involvementNotes":"Some involvement notes","involvementType":{"id":1,"title":"Victim"},"injuries":[{"createdAt":"2026-07-03T06:46:50Z","id":1,"injury":{"id":30,"title":"Face","category":"HEAD"},"injuryType":{"id":12,"title":"Sprain","bundle":"MUSCULOSKELETAL","location":"ANY"},"owner":{"id":1,"resourceType":"Team"},"person":{"resourceType":"PersonInvolved","id":1},"resourceType":"PersonInvolvedInjury","updatedAt":"2026-07-03T06:46:50Z"}],"name":"John Doe","nationality":"US","assistance":"Medical assistance notes","owner":{"id":1,"resourceType":"Team"},"outcome":{"id":4,"title":"Life Saved"},"resourceType":"PersonInvolved","sex":"MALE","spinalInjury":"SUSPECTED","transfer":"HOSPITAL","updatedAt":"2026-07-03T06:46:50Z","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Incidents"]},"delete":{"summary":"Delete a person involved in an incident","description":"Delete a person involved in an incident

**Required modules:** persons_involved","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"Involved person's id","in":"path","required":true,"name":"involvedPersonId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Involved person's id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"PersonInvolved","message":"An optional message"}}}}},"tags":["Incidents"]}},"/v3/team/{teamId}/member-group-memberships/{memberGroupMembershipId}":{"delete":{"summary":"Delete a member group membership","description":"Delete a member group membership

**Required modules:** ","parameters":[{"description":"Team's id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Team's id"}},{"description":"A member's group membership identifier","in":"path","required":true,"name":"memberGroupMembershipId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A member's group membership identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"MemberGroupMembership","message":"An optional message"}}}}},"tags":["Group Memberships"]}},"/v3/team/{teamId}/task-assignments/{assignmentId}":{"patch":{"summary":"Update a task assignment","description":"Update a task assignment

**Required modules:** tasks","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"assignmentId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A task assignment resource","content":{"application/json":{"example":{"id":1,"task":{"resourceType":"Task","id":5},"assignee":{"resourceType":"Member","id":10},"completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"TaskAssignment"}}}}},"tags":["Tasks"]},"delete":{"summary":"Delete a task assignment","description":"Delete a task assignment

**Required modules:** tasks","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"assignmentId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"TaskAssignment","message":"An optional message"}}}}},"tags":["Tasks"]}},"/v3/team/{teamId}/tasks/{taskId}":{"patch":{"summary":"Update a task","description":"Update a task

**Required modules:** ","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"taskId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"ref":{"type":["string"],"maxLength":80,"description":"The task resource ref"},"completedAt":{"description":"Date task was completed. Status must be COMPLETED. Defaults to time of request.","type":["string","null"],"format":"date-time"},"dueAt":{"description":"Date task resource is due","type":["string","null"],"format":"date-time"},"description":{"type":["string"],"description":"The description of a resource"},"status":{"type":["string"],"enum":["NOT_STARTED","IN_PROGRESS","COMPLETED"],"description":"Status of task"},"targetResourceId":{"description":"ID of the resource the task is assigned to","oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"]},"targetResourceType":{"type":["string","null"],"enum":["AnimalGroup","Equipment","EquipmentBrand","EquipmentCategory","EquipmentFund","EquipmentInspection","EquipmentKind","EquipmentLocation","EquipmentModel","EquipmentSupplier","EquipmentSupplierRef","Event","Exercise","Folder","HandlerGroup","HealthSafetyReport","Incident","Member","MemberGroup","MemberQualification","Resource","Tag"],"description":"Resource types that can be associated with a task"},"completionType":{"type":["string"],"enum":["ANY"],"description":"Completion type of the task"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A task resource","content":{"application/json":{"example":{"id":1,"ref":"TASK-001","description":"Example task description","completionType":"ANY","assigned":[{"id":1,"task":{"resourceType":"Task","id":1},"assignee":{"resourceType":"Member","id":5},"completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"TaskAssignment"}],"createdBy":{"resourceType":"Member","id":5},"targetResource":{"resourceType":"Event","id":15},"dueAt":"2023-12-31T23:59:59.000Z","completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"Task"}}}}},"tags":["Tasks"]},"delete":{"summary":"Delete a task","description":"Delete a task

**Required modules:** ","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"taskId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"Task","message":"An optional message"}}}}},"tags":["Tasks"]}},"/v3/{context}/{contextId}/animal-group-memberships/{animalGroupMembershipId}":{"get":{"summary":"Retrieve an animal group membership","description":"Retrieve an animal group membership

**Required modules:** groups","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An animal's group membership identifier","in":"path","required":true,"name":"animalGroupMembershipId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An animal's group membership identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An animal group membership","content":{"application/json":{"example":{"id":1,"owner":{"resourceType":"Team","id":1},"group":{"resourceType":"AnimalGroup","id":1},"animal":{"resourceType":"Animal","id":1},"resourceType":"AnimalGroupMembership","createdAt":"2026-07-03T06:46:50.654Z","updatedAt":"2026-07-03T06:46:50.654Z"}}}}},"tags":["Group Memberships"]}},"/v3/{context}/{contextId}/animal-groups/{groupId}":{"get":{"summary":"Retrieve an animal group","description":"Retrieve an animal group

**Required modules:** groups","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A group identifier","in":"path","required":true,"name":"groupId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A group identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An animal group","content":{"application/json":{"example":{"id":1,"title":"Hundreds of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Animal","owner":{"resourceType":"Team","id":1},"resourceType":"AnimalGroup","createdAt":"2026-07-03T06:46:50.795Z","updatedAt":"2026-07-03T06:46:50.795Z"}}}}},"tags":["Groups"]},"patch":{"summary":"Update an animal group","description":"Update an animal group

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The group's identifier","in":"path","required":true,"name":"groupId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The group's identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":50,"description":"The groups's title"},"deprecatedBundle":{"type":["string"],"minLength":0,"maxLength":50,"description":"The group's bundle title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An animal Group","content":{"application/json":{"example":{"id":1,"title":"Hundreds of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Animal","owner":{"resourceType":"Team","id":1},"resourceType":"AnimalGroup","createdAt":"2026-07-03T06:46:50.795Z","updatedAt":"2026-07-03T06:46:50.795Z"}}}}},"tags":["Groups"]},"delete":{"summary":"Delete an animal group","description":"Delete an animal group

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The group's identifier","in":"path","required":true,"name":"groupId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The group's identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"AnimalGroup","message":"An optional message"}}}}},"tags":["Groups"]}},"/v3/{context}/{contextId}/animal-qualifications/{qualificationId}":{"get":{"summary":"Retrieve an animal qualification","description":"Retrieve an animal qualification ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The qualification's id","in":"path","required":true,"name":"qualificationId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The qualification's id"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An animal qualification","content":{"application/json":{"example":{"id":8,"owner":{"id":2,"resourceType":"Team"},"title":"Hat Wearing","description":"Dogs need help with hats","cost":123,"expiredCost":null,"deprecatedBundle":"Some bundle","expiresMonthsDefault":null,"reminderDays":30,"createdAt":"2026-07-03T06:46:50.801Z","updatedAt":"2026-07-03T06:46:50.801Z","resourceType":"AnimalQualification"}}}}},"tags":["Qualifications"]}},"/v3/{context}/{contextId}/animals/{animalId}":{"get":{"summary":"Retrieve an animal","description":"Retrieve an animal

**Required modules:** animals","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An animal id","in":"path","required":true,"name":"animalId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An animal id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An animal item","content":{"application/json":{"example":{"id":1,"name":"Bessie","breed":"Lab","type":"DOG","countRollingHours":12,"owner":{"resourceType":"Team","id":1},"ref":"0000123","notes":"None","status":"OPERATIONAL","resourceType":"Animal","bornAt":"2026-07-03T06:46:50.810Z","joinedAt":"2026-07-03T06:46:50.810Z","leftAt":null,"createdAt":"2026-07-03T06:46:50.810Z","updatedAt":"2026-07-03T06:46:50.810Z"}}}}},"tags":["Animals"]}},"/v3/{context}/{contextId}/attendance/{attendanceId}":{"get":{"summary":"Retrieve an activity attendance","description":"Retrieve an activity attendance

**Required modules:** activities,members","parameters":[],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An activity attendance","content":{"application/json":{"example":{"activity":{"resourceType":"Incident","id":1},"createdAt":"2026-07-03T06:46:50.671Z","duration":1,"endsAt":"2026-07-03T06:46:50.671Z","id":1,"member":{"resourceType":"Member","id":1},"owner":{"resourceType":"Team","id":1},"startsAt":"2026-07-03T06:46:50.671Z","status":"ABSENT","resourceType":"ActivityAttendance","role":{"id":1,"resourceType":"Role"},"updatedAt":"2026-07-03T06:46:50.671Z"}}}}},"tags":["Activity Attendance"]}},"/v3/{context}/{contextId}/custom-field-options/{customFieldOptionId}":{"patch":{"summary":"Update a custom field option for a CHOICE type field","description":"Update a custom field option for a CHOICE type field ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A custom field option id","in":"path","required":true,"name":"customFieldOptionId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A custom field option id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"label":{"type":["string"],"maxLength":150},"archived":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether this option is available or not"},"ordering":{"type":["integer"],"maximum":4294967295,"minimum":0}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A custom field option","content":{"application/json":{"example":{"id":43,"ordering":0,"customField":{"id":2,"resourceType":"CustomField"},"label":"Eius.","archivedAt":null,"owner":{"id":2,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:43.199Z","updatedAt":"2026-07-03T06:46:43.199Z"}}}}},"tags":["Custom Fields"]}},"/v3/{context}/{contextId}/custom-fields/{customFieldId}":{"get":{"summary":"Retrieve a custom field","description":"Retrieve a custom field ","parameters":[],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A custom field","content":{"application/json":{"example":{"id":93,"owner":{"id":1,"resourceType":"Team"},"targetResourceType":"Equipment","ordering":255,"title":"Rem corporis doloribus et neque rerum.","type":"TEXT","restricted":"UNRESTRICTED","memberPrivacy":"VIEWABLE","hint":null,"bundle":{"id":5,"resourceType":"ResourceBundle"},"searchable":false,"mandatory":false,"frozen":false,"archivedAt":null,"createdAt":"2026-07-03T06:46:43.200Z","updatedAt":"2026-07-03T06:46:43.200Z","options":[{"id":43,"ordering":0,"customField":{"id":2,"resourceType":"CustomField"},"label":"Eius.","archivedAt":null,"owner":{"id":2,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:43.199Z","updatedAt":"2026-07-03T06:46:43.199Z"}],"resourceType":"CustomField","valueUnits":null}}}}},"tags":["Custom Fields"]},"delete":{"summary":"Delete a custom field","description":"Delete a custom field ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A custom field id","in":"path","required":true,"name":"customFieldId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A custom field id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"CustomField","message":"An optional message"}}}}},"tags":["Custom Fields"]},"patch":{"summary":"Update a custom field","description":"Update a custom field ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"customFieldId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"ordering":{"type":["integer"],"minimum":0,"maximum":4294967295,"description":"A user-specified order in which to present the resources"},"title":{"type":["string"],"minLength":1,"maxLength":150,"pattern":"^(?!.*\\|).+$","description":"The title of a resource"},"restricted":{"type":["string"],"enum":["UNRESTRICTED","RESTRICTED"],"description":"- `UNRESTRICTED`: No extra permissions required\n- `RESTRICTED`: Extra permissions required"},"memberPrivacy":{"type":["string"],"enum":["HIDDEN","EDITABLE","VIEWABLE"],"description":"- `HIDDEN`: Member cannot view own data\n- `EDITABLE`: Member can edit own data\n- `VIEWABLE`: Member can view own data"},"hint":{"type":["string"],"maxLength":65535,"description":"A hint to show users of the field"},"resourceBundleId":{"type":["integer","null"],"minimum":1,"maximum":2147483647,"description":"A resource bundle id"},"searchable":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether the field should be included in its parent's (targetResourceType) entity search index or not. Field must also be `UNRESTRICTED`."},"mandatory":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether this field will be required in order to create/approve the attached entity or not"},"archived":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether this field is enabled or not for the target entities"},"valueUnits":{"description":"Text description of what a numerical value represents. Can only be used with type `NUMBER`","type":["string"],"minLength":1,"maxLength":10}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A custom field","content":{"application/json":{"example":{"id":93,"owner":{"id":1,"resourceType":"Team"},"targetResourceType":"Equipment","ordering":255,"title":"Rem corporis doloribus et neque rerum.","type":"TEXT","restricted":"UNRESTRICTED","memberPrivacy":"VIEWABLE","hint":null,"bundle":{"id":5,"resourceType":"ResourceBundle"},"searchable":false,"mandatory":false,"frozen":false,"archivedAt":null,"createdAt":"2026-07-03T06:46:43.200Z","updatedAt":"2026-07-03T06:46:43.200Z","options":[{"id":43,"ordering":0,"customField":{"id":2,"resourceType":"CustomField"},"label":"Eius.","archivedAt":null,"owner":{"id":2,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:43.199Z","updatedAt":"2026-07-03T06:46:43.199Z"}],"resourceType":"CustomField","valueUnits":null}}}}},"tags":["Custom Fields"]}},"/v3/{context}/{contextId}/documents/{documentId}":{"get":{"summary":"Retrieve a single document's details","description":"Retrieve a single document's details

**Required modules:** ","parameters":[],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A document detail","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A document","createdAt":"2026-07-03T06:46:50.937Z","updatedAt":"2026-07-03T06:46:50.937Z","description":"","targetResource":{"id":1,"resourceType":"Equipment","deleted":false},"restricted":"UNRESTRICTED","profile":1,"downloads":1,"avScanStatus":"SAFE","availableSizes":["ORIGINAL","PREVIEW","THUMBNAIL"],"fileExt":"txt","fileType":"text/txt","fileSize":100,"revision":1,"createdBy":{"id":1,"resourceType":"Member"},"resourceType":"Document"}}}}},"tags":["Documents"]},"patch":{"summary":"Update a document","description":"Update a document

**Required modules:** ","parameters":[],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":256,"description":"The document's name"},"description":{"default":"","type":["string"],"minLength":0,"maxLength":65535,"description":"The desired description of the document"},"revision":{"type":["object"],"properties":{"description":{"default":"","type":["string"],"minLength":0,"maxLength":65535,"description":"The desired revision name"}}},"file":{"type":"string","format":"binary"}}}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A Document","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A document","createdAt":"2026-07-03T06:46:50.937Z","updatedAt":"2026-07-03T06:46:50.937Z","description":"","targetResource":{"id":1,"resourceType":"Equipment","deleted":false},"restricted":"UNRESTRICTED","profile":1,"downloads":1,"avScanStatus":"SAFE","availableSizes":["ORIGINAL","PREVIEW","THUMBNAIL"],"fileExt":"txt","fileType":"text/txt","fileSize":100,"revision":1,"createdBy":{"id":1,"resourceType":"Member"},"resourceType":"Document"}}}}},"tags":["Documents"]},"put":{"summary":"Update a document","description":"Update a document

**Required modules:** ","parameters":[],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":256,"description":"The document's name"},"description":{"default":"","type":["string"],"minLength":0,"maxLength":65535,"description":"The desired description of the document"},"revision":{"type":["object"],"properties":{"description":{"default":"","type":["string"],"minLength":0,"maxLength":65535,"description":"The desired revision name"}}},"file":{"type":"string","format":"binary"}}}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A Document","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A document","createdAt":"2026-07-03T06:46:50.937Z","updatedAt":"2026-07-03T06:46:50.937Z","description":"","targetResource":{"id":1,"resourceType":"Equipment","deleted":false},"restricted":"UNRESTRICTED","profile":1,"downloads":1,"avScanStatus":"SAFE","availableSizes":["ORIGINAL","PREVIEW","THUMBNAIL"],"fileExt":"txt","fileType":"text/txt","fileSize":100,"revision":1,"createdBy":{"id":1,"resourceType":"Member"},"resourceType":"Document"}}}}},"tags":["Documents"]},"delete":{"summary":"Delete a document","description":"Delete a document

**Required modules:** ","parameters":[],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"Document","message":"An optional message"}}}}},"tags":["Documents"]}},"/v3/{context}/{contextId}/duties/{dutyId}":{"get":{"summary":"Retrieve a duty","description":"Retrieve a duty

**Required modules:** duty","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A duty id","in":"path","required":true,"name":"dutyId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A duty id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A duty","content":{"application/json":{"example":{"id":1,"notes":"A note about this duty","startsAt":"2026-07-03T06:46:50.987Z","endsAt":"2026-07-03T06:46:50.987Z","type":"OFF","role":{"id":1,"title":"This role's title","deprecatedBundle":"This role's bundle","owner":{"resourceType":"Team","id":1},"order":0,"cost":{"hour":20,"use":100},"resourceType":"Role","createdAt":"2026-07-03T06:46:50.985Z","updatedAt":"2026-07-03T06:46:50.985Z"},"parent":{"resourceType":"Duty","id":1},"member":{"alertActivityApproval":true,"alertAllQualifications":true,"alertGear":true,"alertQualifications":true,"chatAutosubscribe":true,"chatDailyDigest":true,"contactUpdateMail":true,"costPerHour":50,"costPerUse":10,"countReportingEvent":20,"countReportingExercise":10,"countReportingHours":40,"countReportingIncident":5,"countRollingHours":30,"countRollingHoursEvent":15,"countRollingHoursExercise":25,"countRollingHoursIncident":3,"createdAt":"2026-07-03T06:46:50Z","credits":100,"defaultDuty":"ON","defaultEquipmentLocation":{"id":2,"resourceType":"EquipmentLocation"},"deprecatedAddress":"456 Oak Ave, Springfield, London, SW1A 1AA, England","email":{"value":"john.doe@example.com","verified":true},"primaryEmergencyContact":{"name":"Emergency Contact 1","primaryPhone":"555-123-4567","secondaryPhone":"555-987-6543","relation":"Parent"},"secondaryEmergencyContact":{"name":"Emergency Contact 2","primaryPhone":"555-555-5555","secondaryPhone":"555-666-6666","relation":"Sibling"},"endsAt":"2026-07-03T06:46:50Z","globalSyncId":"62a68dac60b511f09c4a325096b39f47","home":{"phone":"555-789-0123","verified":true},"icalSecret":"icalSecret123","id":1,"idTag":"RFID123","startsAt":"2026-07-03T06:46:50Z","lastLogin":"2026-07-03T06:46:50Z","location":{"type":"Point","coordinates":[12.3456,-78.9101]},"locationBookmark":{"id":4,"resourceType":"LocationBookmark"},"mobile":{"phone":"555-222-3333","verified":true},"name":"John Doe","notes":"Some notes here","pager":{"phone":"555-444-5555","email":"pager.email@example.com"},"percReportingEvent":50,"percReportingExercise":70,"percReportingIncident":30,"percRollingEvent":60,"percRollingExercise":80,"percRollingIncident":40,"permission":1,"deprecatedPermission":"MEMBER","position":"Manager","ref":"ABC123","retiredReason":{"id":null,"resourceType":"RetiredReason"},"role":{"id":7,"resourceType":"Role"},"signedTandC":"2026-07-03T06:46:50Z","status":"OPERATIONAL","customStatus":{"id":8,"resourceType":"CustomMemberStatus"},"teamAgreementSigned":"Agreement123","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:50Z","weeklyDayOfWeek":1,"weeklyDayOfWeekUtc":2,"weeklyHourOfDay":2,"weeklyHourOfDayUtc":2,"weeklyMail":true,"work":{"phone":"555-777-8888"},"resourceType":"Member","deletedAt":null,"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"owner":{"resourceType":"Team","id":1},"repeat":{"every":{"interval":"WEEK","period":1},"until":"2026-07-03T06:46:50.987Z"},"resourceType":"Duty","createdAt":"2026-07-03T06:46:50.987Z","updatedAt":"2026-07-03T06:46:50.987Z"}}}}},"tags":["Duties"]}},"/v3/{context}/{contextId}/equipment-brands/{brandId}":{"get":{"summary":"Retrieve an equipment brand","description":"Retrieve an equipment brand

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment brand","in":"path","required":true,"name":"brandId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment brand"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment brand","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Brands"]},"patch":{"summary":"Update an equipment brand","description":"Update an equipment brand

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment brand","in":"path","required":true,"name":"brandId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment brand"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The brands's title"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment brand","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Brands"]},"delete":{"summary":"Delete an equipment brand","description":"Delete an equipment brand

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment brand","in":"path","required":true,"name":"brandId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment brand"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentBrand","message":"An optional message"}}}}},"tags":["Equipment Brands"]}},"/v3/{context}/{contextId}/equipment-categories/{categoryId}":{"get":{"summary":"Retrieve an equipment category","description":"Retrieve an equipment category

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment category","in":"path","required":true,"name":"categoryId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment category"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment category","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Categories"]},"patch":{"summary":"Update an equipment category","description":"Update an equipment category

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment category","in":"path","required":true,"name":"categoryId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment category"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The category's title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment category","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Categories"]},"delete":{"summary":"Delete an equipment category","description":"Delete an equipment category

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment category","in":"path","required":true,"name":"categoryId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment category"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentCategory","message":"An optional message"}}}}},"tags":["Equipment Categories"]}},"/v3/{context}/{contextId}/equipment-funds/{fundId}":{"get":{"summary":"Retrieve an equipment fund","description":"Retrieve an equipment fund

**Required modules:** equipment_funding","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment fund","in":"path","required":true,"name":"fundId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment fund"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment fund","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A funding source","createdAt":"2026-07-03T06:46:51.033Z","updatedAt":"2026-07-03T06:46:51.033Z","value":10000,"spentTotal":20,"equipTotal":5,"resourceType":"EquipmentFund"}}}}},"tags":["Equipment Funds"]},"patch":{"summary":"Update an equipment fund","description":"Update an equipment fund

**Required modules:** equipment_funding","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment fund","in":"path","required":true,"name":"fundId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment fund"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":60,"description":"The title of a resource"},"value":{"type":["integer"],"minimum":0,"maximum":2147483647,"description":"The funding source value"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment fund","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A funding source","createdAt":"2026-07-03T06:46:51.033Z","updatedAt":"2026-07-03T06:46:51.033Z","value":10000,"spentTotal":20,"equipTotal":5,"resourceType":"EquipmentFund"}}}}},"tags":["Equipment Funds"]},"delete":{"summary":"Delete an equipment fund","description":"Delete an equipment fund

**Required modules:** equipment_funding","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment fund","in":"path","required":true,"name":"fundId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment fund"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentFund","message":"An optional message"}}}}},"tags":["Equipment Funds"]}},"/v3/{context}/{contextId}/equipment-inspection-results/{inspectionResultId}":{"get":{"summary":"Retrieve an equipment inspection result","description":"Retrieve an equipment inspection result

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An inspection id","in":"path","required":true,"name":"inspectionResultId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An inspection result item","content":{"application/json":{"example":{"id":1,"dateDue":"2026-07-03T06:46:51.043Z","description":"A description","equipmentInspection":{"resourceType":"EquipmentInspection","id":1},"equipment":{"resourceType":"Equipment","id":1},"member":{"resourceType":"Member","id":1},"owner":{"resourceType":"Team","id":1},"repair":{"resourceType":"Repair","id":1},"resourceType":"EquipmentInspectionResult","reminderDate":"2026-07-03T06:46:51.043Z","lastModified":"2026-07-03T06:46:51.043Z","completedAt":"2026-07-03T06:46:51.043Z","outcome":"PASS","createdAt":"2026-07-03T06:46:51.043Z","updatedAt":"2026-07-03T06:46:51.043Z"}}}}},"tags":["Equipment Inspections"]},"patch":{"summary":"Update an equipment inspection result","description":"Update an equipment inspection result

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An inspection result id","in":"path","required":true,"name":"inspectionResultId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection result id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"description":{"type":["string","null"],"description":"The inspection result description"},"outcome":{"type":["string"],"enum":["PASS","FAIL"],"description":"The outcome of the inspection"},"repairId":{"type":["integer","null"],"minimum":1,"maximum":2147483647,"description":"The repair id"},"completedAt":{"description":"The inspection result completion date","type":["string","null"],"format":"date-time"},"status":{"type":["string"],"enum":["INCOMPLETE","OPERATIONAL","TO_MONITOR","REPAIR_REQUIRED","RETIRED","LOST","UNSERVICEABLE",0,1,2,3,4,5,6],"description":"The inspection result status. Deprecated."}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An inspection result item","content":{"application/json":{"example":{"id":1,"dateDue":"2026-07-03T06:46:51.043Z","description":"A description","equipmentInspection":{"resourceType":"EquipmentInspection","id":1},"equipment":{"resourceType":"Equipment","id":1},"member":{"resourceType":"Member","id":1},"owner":{"resourceType":"Team","id":1},"repair":{"resourceType":"Repair","id":1},"resourceType":"EquipmentInspectionResult","reminderDate":"2026-07-03T06:46:51.043Z","lastModified":"2026-07-03T06:46:51.043Z","completedAt":"2026-07-03T06:46:51.043Z","outcome":"PASS","createdAt":"2026-07-03T06:46:51.043Z","updatedAt":"2026-07-03T06:46:51.043Z"}}}}},"tags":["Equipment Inspections"]},"delete":{"summary":"Delete a completed inspection result","description":"Delete a completed inspection result

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the inspection result. Must be a completed one.","in":"path","required":true,"name":"inspectionResultId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the inspection result. Must be a completed one."}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentInspectionResult","message":"An optional message"}}}}},"tags":["Equipment Inspections"]}},"/v3/{context}/{contextId}/equipment-inspection-step-results/{inspectionResultStepId}":{"get":{"summary":"Retrieve an equipment inspection result step","description":"Retrieve an equipment inspection result step

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An inspection result step id","in":"path","required":true,"name":"inspectionResultStepId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection result step id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An inspection result step item","content":{"application/json":{"example":{"id":1,"notes":"A note on how the step went","outcome":"PASS","stepText":"Check seatbelts","equipmentInspectionResult":{"resourceType":"EquipmentInspectionResult","id":1},"owner":{"resourceType":"Team","id":40},"resourceType":"EquipmentInspectionStepResult","createdAt":"2026-07-03T06:46:51.054Z","updatedAt":"2026-07-03T06:46:51.054Z"}}}}},"tags":["Equipment Inspections"]},"patch":{"summary":"Update an equipment inspection result step","description":"Update an equipment inspection result step

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An inspection result step id","in":"path","required":true,"name":"inspectionResultStepId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection result step id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"notes":{"type":["string"],"description":"The inspection result step notes"},"outcome":{"type":["string","null"],"enum":["PASS","FAIL","NA"],"description":"The outcome of the inspection step"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An inspection result step item","content":{"application/json":{"example":{"id":1,"notes":"A note on how the step went","outcome":"PASS","stepText":"Check seatbelts","equipmentInspectionResult":{"resourceType":"EquipmentInspectionResult","id":1},"owner":{"resourceType":"Team","id":40},"resourceType":"EquipmentInspectionStepResult","createdAt":"2026-07-03T06:46:51.054Z","updatedAt":"2026-07-03T06:46:51.054Z"}}}}},"tags":["Equipment Inspections"]},"delete":{"summary":"Delete an equipment inspection result step","description":"Delete an equipment inspection result step

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An inspection result step id","in":"path","required":true,"name":"inspectionResultStepId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection result step id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentInspectionStepResult","message":"An optional message"}}}}},"tags":["Equipment Inspections"]}},"/v3/{context}/{contextId}/equipment-inspection-steps/{inspectionStepId}":{"get":{"summary":"Retrieve an equipment inspection step","description":"Retrieve an equipment inspection step

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An inspection step id","in":"path","required":true,"name":"inspectionStepId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection step id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An inspection step item","content":{"application/json":{"example":{"id":1,"text":"A title","equipmentInspection":{"resourceType":"EquipmentInspection","id":1},"owner":{"resourceType":"Team","id":40},"ordering":1,"resourceType":"EquipmentInspectionStep","createdAt":"2026-07-03T06:46:51.064Z","updatedAt":"2026-07-03T06:46:51.064Z"}}}}},"tags":["Equipment Inspections"]},"patch":{"summary":"Update an equipment inspection step","description":"Update an equipment inspection step

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An inspection step id","in":"path","required":true,"name":"inspectionStepId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection step id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"text":{"type":["string"],"minLength":1,"maxLength":100,"description":"The inspection step text"},"ordering":{"type":["integer"],"minimum":0,"maximum":4294967295,"description":"The numeric order of this step during the inspection"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An inspection item step","content":{"application/json":{"example":{"id":1,"text":"A title","equipmentInspection":{"resourceType":"EquipmentInspection","id":1},"owner":{"resourceType":"Team","id":40},"ordering":1,"resourceType":"EquipmentInspectionStep","createdAt":"2026-07-03T06:46:51.064Z","updatedAt":"2026-07-03T06:46:51.064Z"}}}}},"tags":["Equipment Inspections"]},"delete":{"summary":"Delete an equipment inspection step","description":"Delete an equipment inspection step

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An inspection step id","in":"path","required":true,"name":"inspectionStepId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection step id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentInspectionStep","message":"An optional message"}}}}},"tags":["Equipment Inspections"]}},"/v3/{context}/{contextId}/equipment-inspections/{inspectionId}":{"get":{"summary":"Retrieve an equipment inspection","description":"Retrieve an equipment inspection

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An inspection id","in":"path","required":true,"name":"inspectionId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An inspection item","content":{"application/json":{"example":{"id":1,"archivedAt":null,"allKinds":false,"deprecatedBundle":"aBundle","dateLast":"2026-07-03T06:46:51.075Z","dateNext":"2026-07-03T06:46:51.075Z","description":"A description","equipmentParent":{"resourceType":"Equipment","id":1},"intervalUnit":"DAY","intervalValue":2,"isAutoUnserviceable":true,"location":{"resourceType":"EquipmentLocation","id":1},"member":{"resourceType":"Member","id":1},"reminderUnit":"WEEK","reminderValue":2,"title":"A title","owner":{"resourceType":"Team","id":40},"resourceType":"EquipmentInspection","createdAt":"2026-07-03T06:46:51.075Z","updatedAt":"2026-07-03T06:46:51.075Z"}}}}},"tags":["Equipment Inspections"]}},"/v3/{context}/{contextId}/equipment-kinds/{kindId}":{"get":{"summary":"Retrieve an equipment kind","description":"Retrieve an equipment kind

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment kind","in":"path","required":true,"name":"kindId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment kind"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment kind","content":{"application/json":{"example":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"}}}}},"tags":["Equipment Kinds"]},"patch":{"summary":"Update an equipment kind","description":"Update an equipment kind

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment kind","in":"path","required":true,"name":"kindId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment kind"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The kind's title"},"categoryId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"This kind's parent category id"},"type":{"type":["string"],"enum":["VEHICLE","SUPPLY","EQUIPMENT"],"description":"- `VEHICLE`: A vehicle of some kind\n- `SUPPLY`: A supply of disposable items\n- `EQUIPMENT`: A re-usable piece of equipment"},"costPerUse":{"type":["integer"],"minimum":0,"description":"The cost incurred per use"},"costPerHour":{"type":["integer"],"minimum":0,"description":"The cost incurred per hour of use"},"costPerDistance":{"type":["integer"],"minimum":0,"description":"The cost incurred per distance of use"},"required":{"type":["integer"],"minimum":0,"description":"The required amount if this is a supply item"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment kind","content":{"application/json":{"example":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"}}}}},"tags":["Equipment Kinds"]},"delete":{"summary":"Delete an equipment kind","description":"Delete an equipment kind

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment kind","in":"path","required":true,"name":"kindId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment kind"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentKind","message":"An optional message"}}}}},"tags":["Equipment Kinds"]}},"/v3/{context}/{contextId}/equipment-locations/{equipmentLocationId}":{"get":{"summary":"Retrieve an equipment location","description":"Retrieve an equipment location ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An equipment location`s id","in":"path","required":true,"name":"equipmentLocationId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An equipment location`s id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment location","content":{"application/json":{"example":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"}}}}},"tags":["Equipment Locations"]}},"/v3/{context}/{contextId}/equipment-models/{modelId}":{"get":{"summary":"Retrieve an equipment model","description":"Retrieve an equipment model

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment model","in":"path","required":true,"name":"modelId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment model"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment model","content":{"application/json":{"example":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Models"]},"patch":{"summary":"Update an equipment model","description":"Update an equipment model

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment model","in":"path","required":true,"name":"modelId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment model"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The model's title"},"brandId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The brand id this model belongs to"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment model","content":{"application/json":{"example":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"}}}}},"tags":["Equipment Models"]},"delete":{"summary":"Delete an equipment model","description":"Delete an equipment model

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment model","in":"path","required":true,"name":"modelId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment model"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The deleted id(s)","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentModel","message":"An optional message"}}}}},"tags":["Equipment Models"]}},"/v3/{context}/{contextId}/equipment-retired-reasons/{reasonId}":{"get":{"summary":"Retrieve an equipment retired reason","description":"Retrieve an equipment retired reason

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment retired reason","in":"path","required":true,"name":"reasonId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment retired reason"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment retired reason","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A retired reason","createdAt":"2026-07-03T06:46:52.157Z","updatedAt":"2026-07-03T06:46:52.157Z","resourceType":"EquipmentRetiredReason"}}}}},"tags":["Equipment Retirement Reasons"]},"patch":{"summary":"Update an equipment retired reason","description":"Update an equipment retired reason

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment retired reason","in":"path","required":true,"name":"reasonId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment retired reason"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":20,"description":"The title of a resource"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment retired reason","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A retired reason","createdAt":"2026-07-03T06:46:52.157Z","updatedAt":"2026-07-03T06:46:52.157Z","resourceType":"EquipmentRetiredReason"}}}}},"tags":["Equipment Retirement Reasons"]},"delete":{"summary":"Delete an equipment retired reason resource","description":"Delete an equipment retired reason resource

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment retired reason","in":"path","required":true,"name":"reasonId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment retired reason"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The deleted id(s)","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentRetiredReason","message":"An optional message"}}}}},"tags":["Equipment Retirement Reasons"]}},"/v3/{context}/{contextId}/equipment-supplier-refs/{refId}":{"get":{"summary":"Retrieve an equipment supplier reference","description":"Retrieve an equipment supplier reference

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment supplier reference","in":"path","required":true,"name":"refId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment supplier reference"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment supplier reference","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A supplier reference","supplier":{"id":1,"resourceType":"EquipmentSupplier"},"createdAt":"2026-07-03T06:46:52.172Z","updatedAt":"2026-07-03T06:46:52.172Z","resourceType":"EquipmentSupplierRef"}}}}},"tags":["Equipment Supplier References"]},"patch":{"summary":"Update an equipment supplier reference","description":"Update an equipment supplier reference

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment supplier reference","in":"path","required":true,"name":"refId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment supplier reference"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The supplier ref's title"},"supplierId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The supplier id this supplier reference belongs to"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment supplier reference","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A supplier reference","supplier":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:52.172Z","updatedAt":"2026-07-03T06:46:52.172Z","resourceType":"EquipmentSupplierRef"}}}}},"tags":["Equipment Supplier References"]},"delete":{"summary":"Delete an equipment supplier reference","description":"Delete an equipment supplier reference

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment supplier reference","in":"path","required":true,"name":"refId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment supplier reference"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The deleted response","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentSupplierRef","message":"An optional message"}}}}},"tags":["Equipment Supplier References"]}},"/v3/{context}/{contextId}/equipment-suppliers/{supplierId}":{"get":{"summary":"Retrieve an equipment supplier","description":"Retrieve an equipment supplier

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment supplier","in":"path","required":true,"name":"supplierId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment supplier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment supplier","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A supplier","createdAt":"2026-07-03T06:46:52.179Z","updatedAt":"2026-07-03T06:46:52.179Z","resourceType":"EquipmentSupplier"}}}}},"tags":["Equipment Suppliers"]},"patch":{"summary":"Update an equipment supplier","description":"Update an equipment supplier

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment supplier","in":"path","required":true,"name":"supplierId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment supplier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":3,"maxLength":80,"description":"The supplier's title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment supplier","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A supplier","createdAt":"2026-07-03T06:46:52.179Z","updatedAt":"2026-07-03T06:46:52.179Z","resourceType":"EquipmentSupplier"}}}}},"tags":["Equipment Suppliers"]},"delete":{"summary":"Delete an equipment supplier","description":"Delete an equipment supplier

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment supplier","in":"path","required":true,"name":"supplierId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment supplier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentSupplier","message":"An optional message"}}}}},"tags":["Equipment Suppliers"]}},"/v3/{context}/{contextId}/equipment-usages/{usageId}":{"get":{"summary":"Retrieve an equipment usage","description":"Retrieve an equipment usage

**Required modules:** activities,equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment usage","in":"path","required":true,"name":"usageId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment usage"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment usage","content":{"application/json":{"example":{"id":1,"used":20,"distance":null,"duration":0,"equipment":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"activity":{"resourceType":"Incident","id":1},"owner":{"resourceType":"Team","id":1},"resourceType":"EquipmentUsage","createdAt":"2026-07-03T06:46:51.166Z","updatedAt":"2026-07-03T06:46:51.166Z"}}}}},"tags":["Activity Equipment Usage"]},"patch":{"summary":"Update an equipment activity usage","description":"Update an equipment activity usage

**Required modules:** activities,equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The equipment usage identifier","in":"path","required":true,"name":"usageId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The equipment usage identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"duration":{"type":["integer"],"maximum":4294967295,"minimum":0,"description":"The minutes the equipment was used. Only if the Equipment item's type is \"Equipment\""},"distance":{"type":["integer"],"maximum":4294967295,"minimum":0,"description":"The distance the equipment was used in the km / miles. Only if the Equipment item's type is \"Vehicle\""},"used":{"type":["integer"],"maximum":4294967295,"minimum":0,"description":"The quantity that was used. Only if the Equipment item's type is \"Supply\""}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment activity usage","content":{"application/json":{"example":{"id":1,"used":20,"distance":null,"duration":0,"equipment":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"activity":{"resourceType":"Incident","id":1},"owner":{"resourceType":"Team","id":1},"resourceType":"EquipmentUsage","createdAt":"2026-07-03T06:46:51.166Z","updatedAt":"2026-07-03T06:46:51.166Z"}}}}},"tags":["Equipment Funds"]},"delete":{"summary":"Delete an equipment activity usage","description":"Delete an equipment activity usage

**Required modules:** activities,equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The equipment usage identifier","in":"path","required":true,"name":"usageId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The equipment usage identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The equipment activity usage delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"EquipmentUsage","message":"An optional message"}}}}},"tags":["Activity Equipment Usage"]}},"/v3/{context}/{contextId}/equipment/{itemId}":{"get":{"summary":"Retrieve an equipment item","description":"Retrieve an equipment item

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The id of the equipment","in":"path","required":true,"name":"itemId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The id of the equipment"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment item","content":{"application/json":{"example":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Equipment Items"]},"patch":{"summary":"Update an equipment item","description":"Update an equipment item

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment","in":"path","required":true,"name":"itemId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"status":{"type":["string"],"enum":["OPERATIONAL","UNSERVICEABLE","LOST","WISHLIST","INACTIVE"],"description":"The status of the equipment"},"isCritical":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Items flagged as critical"},"isMonitor":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Items flagged as to be monitored"},"barcode":{"type":["string","null"],"minLength":1,"maxLength":80,"description":"This item's barcode"},"updateNotes":{"type":["string"],"minLength":1,"maxLength":100,"description":"Notes about the change"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An equipment item","content":{"application/json":{"example":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Equipment Items"]},"delete":{"summary":"Delete an equipment item","description":"Delete an equipment item

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the equipment item","in":"path","required":true,"name":"itemId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the equipment item"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"Equipment","message":"An optional message"}}}}},"tags":["Equipment Items"]}},"/v3/{context}/{contextId}/events/{activityId}":{"get":{"summary":"Retrieve an event","description":"Retrieve an event

**Required modules:** activities","parameters":[],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An Event","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.295Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.295Z","updatedAt":"2026-07-03T06:46:51.295Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.295Z","endsAt":"2026-07-03T06:46:51.295Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.295Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Events"]},"patch":{"summary":"Update an event","description":"Update an event

**Required modules:** ","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"reference":{"type":["string"],"maxLength":30,"description":"Reference code for activity. Must be unique. Only allowed if team has activity auto-id enabled."},"referenceDescription":{"type":["string"],"maxLength":100,"description":"A text description for the reference / the activity's title"},"description":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's description. Supports HTML."},"plan":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's plan. Supports HTML."},"trackingNumber":{"type":["string","null"],"maxLength":50,"description":"The activity's tracking number"},"shared":{"description":"Whether the activity is shared across the organisation","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"fullTeam":{"description":"Whether the activity requires the attendance of the full team or is selective. If set true on activity creation, the attendance records will automatically be created for appropriate team members.","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"address":{"type":["object"],"properties":{"country":{"type":["string"],"description":"Country"},"postcode":{"type":["string"],"maxLength":100,"description":"Postcode or ZIP code"},"region":{"type":["string"],"maxLength":100,"description":"Province, county or region"},"street":{"type":["string"],"maxLength":100,"description":"Number, street and house"},"town":{"type":["string"],"maxLength":100,"description":"City or town"}}},"location":{"type":["object"],"properties":{"latitude":{"type":["number"],"minimum":-90,"maximum":90,"description":"The latitude where this entity is located"},"longitude":{"type":["number"],"minimum":-180,"maximum":180,"description":"The longitude where this entity is located"}},"required":["latitude","longitude"]},"locationBookmarkId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"startsAt":{"description":"The activity's starting date","type":["string"],"format":"date-time"},"endsAt":{"description":"The activity's end date","type":["string"],"format":"date-time"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}}}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An event","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.295Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.295Z","updatedAt":"2026-07-03T06:46:51.295Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.295Z","endsAt":"2026-07-03T06:46:51.295Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.295Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Events"]}},"/v3/{context}/{contextId}/exercises/{activityId}":{"get":{"summary":"Retrieve an exercises","description":"Retrieve an exercises

**Required modules:** activities","parameters":[],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An Exercise resource","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.306Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.306Z","updatedAt":"2026-07-03T06:46:51.306Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.306Z","endsAt":"2026-07-03T06:46:51.306Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.306Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Exercises"]},"patch":{"summary":"Update an exercise","description":"Update an exercise

**Required modules:** ","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"reference":{"type":["string"],"maxLength":30,"description":"Reference code for activity. Must be unique. Only allowed if team has activity auto-id enabled."},"referenceDescription":{"type":["string"],"maxLength":100,"description":"A text description for the reference / the activity's title"},"description":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's description. Supports HTML."},"plan":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's plan. Supports HTML."},"trackingNumber":{"type":["string","null"],"maxLength":50,"description":"The activity's tracking number"},"shared":{"description":"Whether the activity is shared across the organisation","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"fullTeam":{"description":"Whether the activity requires the attendance of the full team or is selective. If set true on activity creation, the attendance records will automatically be created for appropriate team members.","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"address":{"type":["object"],"properties":{"country":{"type":["string"],"description":"Country"},"postcode":{"type":["string"],"maxLength":100,"description":"Postcode or ZIP code"},"region":{"type":["string"],"maxLength":100,"description":"Province, county or region"},"street":{"type":["string"],"maxLength":100,"description":"Number, street and house"},"town":{"type":["string"],"maxLength":100,"description":"City or town"}}},"location":{"type":["object"],"properties":{"latitude":{"type":["number"],"minimum":-90,"maximum":90,"description":"The latitude where this entity is located"},"longitude":{"type":["number"],"minimum":-180,"maximum":180,"description":"The longitude where this entity is located"}},"required":["latitude","longitude"]},"locationBookmarkId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"startsAt":{"description":"The activity's starting date","type":["string"],"format":"date-time"},"endsAt":{"description":"The activity's end date","type":["string"],"format":"date-time"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}}}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An exercise","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.306Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.306Z","updatedAt":"2026-07-03T06:46:51.306Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.306Z","endsAt":"2026-07-03T06:46:51.306Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.306Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Exercises"]}},"/v3/{context}/{contextId}/handler-group-memberships/{handlerGroupMembershipId}":{"get":{"summary":"Retrieve a handler group membership","description":"Retrieve a handler group membership

**Required modules:** groups","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A handler's group membership identifier","in":"path","required":true,"name":"handlerGroupMembershipId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A handler's group membership identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A handler group membership","content":{"application/json":{"example":{"id":1,"owner":{"resourceType":"Team","id":1},"group":{"resourceType":"HandlerGroup","id":1},"handler":{"resourceType":"Handler","id":1},"resourceType":"HandlerGroupMembership","createdAt":"2026-07-03T06:46:50.695Z","updatedAt":"2026-07-03T06:46:50.695Z"}}}}},"tags":["Group Memberships"]}},"/v3/{context}/{contextId}/handler-groups/{groupId}":{"get":{"summary":"Retrieve a handler group","description":"Retrieve a handler group

**Required modules:** groups","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A group identifier","in":"path","required":true,"name":"groupId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A group identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A handler group","content":{"application/json":{"example":{"id":1,"title":"Handlers of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Handler","owner":{"resourceType":"Team","id":1},"resourceType":"HandlerGroup","createdAt":"2026-07-03T06:46:51.329Z","updatedAt":"2026-07-03T06:46:51.329Z"}}}}},"tags":["Groups"]},"patch":{"summary":"Update a handler group","description":"Update a handler group

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The group's identifier","in":"path","required":true,"name":"groupId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The group's identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":50,"description":"The groups's title"},"deprecatedBundle":{"type":["string"],"minLength":0,"maxLength":50,"description":"The group's bundle title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A handler Group","content":{"application/json":{"example":{"id":1,"title":"Handlers of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Handler","owner":{"resourceType":"Team","id":1},"resourceType":"HandlerGroup","createdAt":"2026-07-03T06:46:51.329Z","updatedAt":"2026-07-03T06:46:51.329Z"}}}}},"tags":["Groups"]},"delete":{"summary":"Delete a handler group","description":"Delete a handler group

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The group's identifier","in":"path","required":true,"name":"groupId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The group's identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"HandlerGroup","message":"An optional message"}}}}},"tags":["Groups"]}},"/v3/{context}/{contextId}/handler-qualifications/{qualificationId}":{"get":{"summary":"Retrieve a handler qualification","description":"Retrieve a handler qualification ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The qualification's id","in":"path","required":true,"name":"qualificationId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The qualification's id"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A handler qualification","content":{"application/json":{"example":{"id":8,"owner":{"id":2,"resourceType":"Team"},"title":"Cat Herding","description":"You don't want to take this course, trust me","cost":null,"expiredCost":null,"deprecatedBundle":"Discontinued courses","expiresMonthsDefault":null,"reminderDays":30,"createdAt":"2026-07-03T06:46:51.335Z","updatedAt":"2026-07-03T06:46:51.335Z","resourceType":"HandlerQualification"}}}}},"tags":["Qualifications"]}},"/v3/{context}/{contextId}/handlers/{handlerId}":{"get":{"summary":"Retrieve a handler","description":"Retrieve a handler

**Required modules:** members,animals","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A handler identifier","in":"path","required":true,"name":"handlerId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A handler identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A handler","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"member":{"id":1,"resourceType":"Member"},"animal":{"id":1,"resourceType":"Animal"},"resourceType":"Handler","createdAt":"2026-07-03T06:46:51.341Z","updatedAt":"2026-07-03T06:46:51.341Z"}}}}},"tags":["Animals"]},"patch":{"summary":"Update a handler","description":"Update a handler

**Required modules:** members,animals","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A handler identifier","in":"path","required":true,"name":"handlerId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A handler identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"memberId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The member's identifier"},"animalId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The animal's identifier"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A handler","content":{"application/json":{"example":{"id":1,"owner":{"id":1,"resourceType":"Team"},"member":{"id":1,"resourceType":"Member"},"animal":{"id":1,"resourceType":"Animal"},"resourceType":"Handler","createdAt":"2026-07-03T06:46:51.341Z","updatedAt":"2026-07-03T06:46:51.341Z"}}}}},"tags":["Animals"]},"delete":{"summary":"Delete a handler","description":"Delete a handler

**Required modules:** members,animals","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A handler identifier","in":"path","required":true,"name":"handlerId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A handler identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"Handler","message":"An optional message"}}}}},"tags":["Animals"]}},"/v3/{context}/{contextId}/health-safety-categories/{categoryId}":{"get":{"summary":"Retrieve a Health & Safety Category","description":"Retrieve a Health & Safety Category

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Health & Safety Category","in":"path","required":true,"name":"categoryId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Category"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A Health & Safety Category","content":{"application/json":{"example":{"colour":"BLACK","createdAt":"2026-07-03T06:46:51.353Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"HealthSafetyCategory","title":"Category Alpha","updatedAt":"2026-07-03T06:46:51.353Z"}}}}},"tags":["Health & Safety"]},"patch":{"summary":"Update a Health & Safety Category","description":"Update a Health & Safety Category

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Health & Safety Category","in":"path","required":true,"name":"categoryId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Category"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":50,"description":"The category title"},"colour":{"type":["string"],"enum":["BLACK","BLUE","CADET_BLUE","DARK_BLUE","DARK_GREEN","DARK_PURPLE","DARK_RED","GRAY","GREEN","LIGHT_GRAY","LIGHT_RED","ORANGE","PURPLE","RED"],"description":"The colour assigned to the category"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A Health & Safety Category","content":{"application/json":{"example":{"colour":"BLACK","createdAt":"2026-07-03T06:46:51.353Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"HealthSafetyCategory","title":"Category Alpha","updatedAt":"2026-07-03T06:46:51.353Z"}}}}},"tags":["Health & Safety"]},"delete":{"summary":"Delete a Health & Safety Category","description":"Delete a Health & Safety Category

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Health & Safety Category","in":"path","required":true,"name":"categoryId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Category"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"HealthSafetyCategory","message":"An optional message"}}}}},"tags":["Health & Safety"]}},"/v3/{context}/{contextId}/health-safety-reports/{reportId}":{"get":{"summary":"Retrieve a Health & Safety Report","description":"Retrieve a Health & Safety Report

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Health & Safety Report","in":"path","required":true,"name":"reportId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Report"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A Health & Safety Report","content":{"application/json":{"example":{"targetResource":{"id":1,"resourceType":"Incident"},"address":{"country":"","postcode":"","region":"","street":"","town":""},"approvedAt":"2026-07-03T06:46:43.215Z","category":{"id":1,"resourceType":"HealthSafetyCategory"},"cause":"Some cause","createdAt":"2026-07-03T06:46:43.215Z","startsAt":"2026-07-03T06:46:43.215Z","description":"","id":1,"location":{"type":"Point","coordinates":[0,0]},"measures":"","resourceType":"HealthSafetyReport","severity":{"id":1,"resourceType":"HealthSafetySeverity"},"owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:43.215Z","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Health & Safety"]}},"/v3/{context}/{contextId}/health-safety-severities/{severityId}":{"get":{"summary":"Retrieve a Health & Safety Severity","description":"Retrieve a Health & Safety Severity

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Health & Safety Severity","in":"path","required":true,"name":"severityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Severity"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A Health & Safety Severity","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:52.261Z","id":1,"resourceType":"HealthSafetySeverity","score":0,"owner":{"id":1,"resourceType":"Team"},"title":"Severity Alpha","updatedAt":"2026-07-03T06:46:52.261Z"}}}}},"tags":["Health & Safety"]},"patch":{"summary":"Update a Health & Safety Severity","description":"Update a Health & Safety Severity

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Health & Safety Severity","in":"path","required":true,"name":"severityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Severity"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":20,"description":"The severity title"},"score":{"default":null,"type":["integer","null"],"minimum":-9007199254740991,"maximum":9007199254740991,"description":"The score assigned to this severity"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A Health & Safety Severity","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:52.261Z","id":2,"resourceType":"HealthSafetySeverity","score":2,"owner":{"id":1,"resourceType":"Team"},"title":"Severity Beta","updatedAt":"2026-07-03T06:46:52.261Z"}}}}},"tags":["Health & Safety"]},"delete":{"summary":"Delete a Health & Safety Severity","description":"Delete a Health & Safety Severity

**Required modules:** healthsafety","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Health & Safety Severity","in":"path","required":true,"name":"severityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Health & Safety Severity"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"HealthSafetySeverity","message":"An optional message"}}}}},"tags":["Health & Safety"]}},"/v3/{context}/{contextId}/incident-involved-injuries/{involvedInjuryId}":{"get":{"summary":"Retrieve a person involved injury","description":"Retrieve a person involved injury

**Required modules:** persons_involved_medical","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"involvedInjuryId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A person involved injury","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:50Z","id":1,"injury":{"id":30,"title":"Face","category":"HEAD"},"injuryType":{"id":12,"title":"Sprain","bundle":"MUSCULOSKELETAL","location":"ANY"},"owner":{"id":1,"resourceType":"Team"},"person":{"resourceType":"PersonInvolved","id":1},"resourceType":"PersonInvolvedInjury","updatedAt":"2026-07-03T06:46:50Z"}}}}},"tags":["Incidents"]}},"/v3/{context}/{contextId}/incident-involved-persons/{involvedPersonId}":{"get":{"summary":"Retrieve a person involved in an incident","description":"Retrieve a person involved in an incident

**Required modules:** persons_involved","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"involvedPersonId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A person involved in an incident","content":{"application/json":{"example":{"incident":{"resourceType":"Incident","id":1},"age":21,"areaKnowledge":"UNFAMILIAR","cause":"UNDETERMINED","contact":"Joe Duffy, call this number 123456789 and talk to Joe","createdAt":"2026-07-03T06:46:50Z","dateOfBirth":"1990-01-01","handover":"HOSPITAL","id":1,"involvementNotes":"Some involvement notes","involvementType":{"id":1,"title":"Victim"},"injuries":[{"createdAt":"2026-07-03T06:46:50Z","id":1,"injury":{"id":30,"title":"Face","category":"HEAD"},"injuryType":{"id":12,"title":"Sprain","bundle":"MUSCULOSKELETAL","location":"ANY"},"owner":{"id":1,"resourceType":"Team"},"person":{"resourceType":"PersonInvolved","id":1},"resourceType":"PersonInvolvedInjury","updatedAt":"2026-07-03T06:46:50Z"}],"name":"John Doe","nationality":"US","assistance":"Medical assistance notes","owner":{"id":1,"resourceType":"Team"},"outcome":{"id":4,"title":"Life Saved"},"resourceType":"PersonInvolved","sex":"MALE","spinalInjury":"SUSPECTED","transfer":"HOSPITAL","updatedAt":"2026-07-03T06:46:50Z","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Incidents"]}},"/v3/{context}/{contextId}/incidents/{activityId}":{"get":{"summary":"Retrieve an incident","description":"Retrieve an incident

**Required modules:** activities","parameters":[],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An incident","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.407Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.407Z","updatedAt":"2026-07-03T06:46:51.407Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.407Z","endsAt":"2026-07-03T06:46:51.407Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.407Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Incidents"]},"patch":{"summary":"Update an incident","description":"Update an incident

**Required modules:** ","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"reference":{"type":["string"],"maxLength":30,"description":"Reference code for activity. Must be unique. Only allowed if team has activity auto-id enabled."},"referenceDescription":{"type":["string"],"maxLength":100,"description":"A text description for the reference / the activity's title"},"description":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's description. Supports HTML."},"plan":{"default":null,"type":["string","null"],"maxLength":65535,"description":"The activity's plan. Supports HTML."},"trackingNumber":{"type":["string","null"],"maxLength":50,"description":"The activity's tracking number"},"shared":{"description":"Whether the activity is shared across the organisation","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"fullTeam":{"description":"Whether the activity requires the attendance of the full team or is selective. If set true on activity creation, the attendance records will automatically be created for appropriate team members.","oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"type":"boolean"},"address":{"type":["object"],"properties":{"country":{"type":["string"],"description":"Country"},"postcode":{"type":["string"],"maxLength":100,"description":"Postcode or ZIP code"},"region":{"type":["string"],"maxLength":100,"description":"Province, county or region"},"street":{"type":["string"],"maxLength":100,"description":"Number, street and house"},"town":{"type":["string"],"maxLength":100,"description":"City or town"}}},"location":{"type":["object"],"properties":{"latitude":{"type":["number"],"minimum":-90,"maximum":90,"description":"The latitude where this entity is located"},"longitude":{"type":["number"],"minimum":-180,"maximum":180,"description":"The longitude where this entity is located"}},"required":["latitude","longitude"]},"locationBookmarkId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"startsAt":{"description":"The activity's starting date","type":["string"],"format":"date-time"},"endsAt":{"description":"The activity's end date","type":["string"],"format":"date-time"},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}}}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An incident","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.407Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.407Z","updatedAt":"2026-07-03T06:46:51.407Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.407Z","endsAt":"2026-07-03T06:46:51.407Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.407Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Incidents"]}},"/v3/{context}/{contextId}/location-bookmarks/{bookmarkId}":{"get":{"summary":"Retrieve a location bookmark","description":"Retrieve a location bookmark

**Required modules:** location","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A location bookmark id","in":"path","required":true,"name":"bookmarkId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A location bookmark id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A location bookmark resource","content":{"application/json":{"example":{"id":1,"title":"Office","address":{"country":"United States","street":"742 Evergreen Terrace","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"parent":{"id":1,"resourceType":"LocationBookmark"},"createdAt":"2026-07-03T06:46:51.414Z","updatedAt":"2026-07-03T06:46:51.414Z","archivedAt":null,"resourceType":"LocationBookmark"}}}}},"tags":["Location Bookmarks"]}},"/v3/{context}/{contextId}/member-group-memberships/{memberGroupMembershipId}":{"get":{"summary":"Retrieve a member group membership","description":"Retrieve a member group membership

**Required modules:** groups","parameters":[],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A member group membership","content":{"application/json":{"example":{"id":1,"owner":{"resourceType":"Team","id":1},"group":{"resourceType":"MemberGroup","id":1},"member":{"resourceType":"Member","id":1},"resourceType":"MemberGroupMembership","createdAt":"2026-07-03T06:46:50.741Z","updatedAt":"2026-07-03T06:46:50.741Z"}}}}},"tags":["Group Memberships"]}},"/v3/{context}/{contextId}/member-groups/{groupId}":{"get":{"summary":"Retrieve a member group","description":"Retrieve a member group

**Required modules:** groups","parameters":[],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A member group","content":{"application/json":{"example":{"id":1,"globalSyncId":"62a68dac60b511f09c4a325096b39f47","title":"Trappers of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Member","owner":{"resourceType":"Team","id":1},"required":0,"deprecatedShortcode":"ALPHA","resourceType":"MemberGroup","createdAt":"2026-07-03T06:46:51.437Z","updatedAt":"2026-07-03T06:46:51.437Z"}}}}},"tags":["Groups"]},"patch":{"summary":"Update a member group","description":"Update a member group

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The group's identifier","in":"path","required":true,"name":"groupId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The group's identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":50,"description":"The groups's title"},"deprecatedBundle":{"type":["string"],"minLength":0,"maxLength":50,"description":"The group's bundle title"}},"required":["title"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A member Group","content":{"application/json":{"example":{"id":1,"globalSyncId":"62a68dac60b511f09c4a325096b39f47","title":"Trappers of Beavers","deprecatedBundle":"SAR Bundle","membershipResourceType":"Member","owner":{"resourceType":"Team","id":1},"required":0,"deprecatedShortcode":"ALPHA","resourceType":"MemberGroup","createdAt":"2026-07-03T06:46:51.437Z","updatedAt":"2026-07-03T06:46:51.437Z"}}}}},"tags":["Groups"]},"delete":{"summary":"Delete a member group","description":"Delete a member group

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The group's identifier","in":"path","required":true,"name":"groupId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The group's identifier"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"MemberGroup","message":"An optional message"}}}}},"tags":["Groups"]}},"/v3/{context}/{contextId}/member-qualifications/{qualificationId}":{"get":{"summary":"Retrieve a member qualification","description":"Retrieve a member qualification ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The qualification's id","in":"path","required":true,"name":"qualificationId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The qualification's id"}},{"description":"*Organisation context*: Exclude entities belonging to accessible teams","in":"query","name":"exclude_teams_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Organisation context*: Exclude entities belonging to accessible teams"}},{"description":"*Team context*: Exclude entities inherited from the team's org","in":"query","name":"exclude_org_data","required":false,"schema":{"default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"*Team context*: Exclude entities inherited from the team's org"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A member qualification","content":{"application/json":{"example":{"id":8,"owner":{"id":2,"resourceType":"Team"},"title":"Knot Qualification","description":"Nuts for knots","cost":null,"expiredCost":null,"deprecatedBundle":"Qualification-bundle","expiresMonthsDefault":null,"reminderDays":30,"createdAt":"2026-07-03T06:46:51.458Z","updatedAt":"2026-07-03T06:46:51.458Z","resourceType":"MemberQualification"}}}}},"tags":["Qualifications"]}},"/v3/{context}/{contextId}/members/{member}":{"get":{"summary":"Retrieve a member","description":"Retrieve a member

**Required modules:** ","parameters":[],"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"A member","content":{"application/json":{"example":{"alertActivityApproval":true,"alertAllQualifications":true,"alertGear":true,"alertQualifications":true,"chatAutosubscribe":true,"chatDailyDigest":true,"contactUpdateMail":true,"costPerHour":50,"costPerUse":10,"countReportingEvent":20,"countReportingExercise":10,"countReportingHours":40,"countReportingIncident":5,"countRollingHours":30,"countRollingHoursEvent":15,"countRollingHoursExercise":25,"countRollingHoursIncident":3,"createdAt":"2026-07-03T06:46:50Z","credits":100,"defaultDuty":"ON","defaultEquipmentLocation":{"id":2,"resourceType":"EquipmentLocation"},"deprecatedAddress":"456 Oak Ave, Springfield, London, SW1A 1AA, England","email":{"value":"john.doe@example.com","verified":true},"primaryEmergencyContact":{"name":"Emergency Contact 1","primaryPhone":"555-123-4567","secondaryPhone":"555-987-6543","relation":"Parent"},"secondaryEmergencyContact":{"name":"Emergency Contact 2","primaryPhone":"555-555-5555","secondaryPhone":"555-666-6666","relation":"Sibling"},"endsAt":"2026-07-03T06:46:50Z","globalSyncId":"62a68dac60b511f09c4a325096b39f47","home":{"phone":"555-789-0123","verified":true},"icalSecret":"icalSecret123","id":1,"idTag":"RFID123","startsAt":"2026-07-03T06:46:50Z","lastLogin":"2026-07-03T06:46:50Z","location":{"type":"Point","coordinates":[12.3456,-78.9101]},"locationBookmark":{"id":4,"resourceType":"LocationBookmark"},"mobile":{"phone":"555-222-3333","verified":true},"name":"John Doe","notes":"Some notes here","pager":{"phone":"555-444-5555","email":"pager.email@example.com"},"percReportingEvent":50,"percReportingExercise":70,"percReportingIncident":30,"percRollingEvent":60,"percRollingExercise":80,"percRollingIncident":40,"permission":1,"deprecatedPermission":"MEMBER","position":"Manager","ref":"ABC123","retiredReason":{"id":null,"resourceType":"RetiredReason"},"role":{"id":7,"resourceType":"Role"},"signedTandC":"2026-07-03T06:46:50Z","status":"OPERATIONAL","customStatus":{"id":8,"resourceType":"CustomMemberStatus"},"teamAgreementSigned":"Agreement123","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:50Z","weeklyDayOfWeek":1,"weeklyDayOfWeekUtc":2,"weeklyHourOfDay":2,"weeklyHourOfDayUtc":2,"weeklyMail":true,"work":{"phone":"555-777-8888"},"resourceType":"Member","deletedAt":null,"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Members"]},"patch":{"summary":"Update a member","description":"Update a member

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Member the resource belongs to. Either an id or \"me\".","in":"path","required":true,"name":"member","schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["string"],"enum":["me"]}],"description":"Member the resource belongs to. Either an id or \"me\"."}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"name":{"type":["string"],"maxLength":100},"ref":{"type":["string"],"maxLength":100},"idTag":{"type":["string","null"],"minLength":1,"maxLength":80,"description":"RFID tag or barcode"},"status":{"type":["string"],"enum":["OPERATIONAL","NON_OPERATIONAL","OBSERVER"],"description":"Status of member"},"statusLabelId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Custom status identifier"},"startsAt":{"description":"An ISO8601 datetime string","type":["string"],"format":"date-time"},"position":{"type":["string"],"maxLength":100},"roleId":{"description":"Role identifier","oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"]},"costPerHour":{"type":["number"],"minimum":0,"description":"Cost per hour in lowest denomination"},"costPerUse":{"type":["number"],"minimum":0,"description":"Cost per activity in lowest denomination"},"deprecatedAddress":{"type":["string"],"maxLength":300,"description":"Member contact address"},"location":{"type":["object"],"properties":{"latitude":{"type":["number"],"minimum":-90,"maximum":90,"description":"The latitude where this entity is located"},"longitude":{"type":["number"],"minimum":-180,"maximum":180,"description":"The longitude where this entity is located"}},"required":["latitude","longitude"]},"locationBookmarkId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"Location bookmark identifier"},"email":{"type":["string"],"format":"email"},"phone":{"type":["object"],"properties":{"mobile":{"type":["string"],"maxLength":100},"home":{"type":["string"],"maxLength":100},"work":{"type":["string"],"maxLength":100}}},"pager":{"type":["object"],"properties":{"number":{"type":["string"],"maxLength":100},"email":{"type":["string"],"format":"email"}}},"notes":{"type":["string"],"maxLength":600},"primaryEmergencyContact":{"type":["object"],"properties":{"name":{"type":["string"],"maxLength":80},"relation":{"type":["string"],"maxLength":80},"primaryPhone":{"type":["string"],"maxLength":100},"secondaryPhone":{"type":["string"],"maxLength":100}}},"secondaryEmergencyContact":{"type":["object"],"properties":{"name":{"type":["string"],"maxLength":80},"relation":{"type":["string"],"maxLength":80},"primaryPhone":{"type":["string"],"maxLength":100},"secondaryPhone":{"type":["string"],"maxLength":100}}},"customFieldValues":{"type":["array"],"items":{"oneOf":[{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"minItems":1,"description":"array of custom-field OPTION identifiers"}},"required":["id","value"],"additionalProperties":false},{"type":["object"],"properties":{"id":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"custom-field identifier"},"value":{"type":["string","null"]}},"required":["id","value"],"additionalProperties":false}]},"description":"An array of objects consisting of the custom-field id and either: the value as a properly formatted string for the field type, or array of ids for choice type fields (with a max of one id for single-choice fields"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A member","content":{"application/json":{"example":{"alertActivityApproval":true,"alertAllQualifications":true,"alertGear":true,"alertQualifications":true,"chatAutosubscribe":true,"chatDailyDigest":true,"contactUpdateMail":true,"costPerHour":50,"costPerUse":10,"countReportingEvent":20,"countReportingExercise":10,"countReportingHours":40,"countReportingIncident":5,"countRollingHours":30,"countRollingHoursEvent":15,"countRollingHoursExercise":25,"countRollingHoursIncident":3,"createdAt":"2026-07-03T06:46:50Z","credits":100,"defaultDuty":"ON","defaultEquipmentLocation":{"id":2,"resourceType":"EquipmentLocation"},"deprecatedAddress":"456 Oak Ave, Springfield, London, SW1A 1AA, England","email":{"value":"john.doe@example.com","verified":true},"primaryEmergencyContact":{"name":"Emergency Contact 1","primaryPhone":"555-123-4567","secondaryPhone":"555-987-6543","relation":"Parent"},"secondaryEmergencyContact":{"name":"Emergency Contact 2","primaryPhone":"555-555-5555","secondaryPhone":"555-666-6666","relation":"Sibling"},"endsAt":"2026-07-03T06:46:50Z","globalSyncId":"62a68dac60b511f09c4a325096b39f47","home":{"phone":"555-789-0123","verified":true},"icalSecret":"icalSecret123","id":1,"idTag":"RFID123","startsAt":"2026-07-03T06:46:50Z","lastLogin":"2026-07-03T06:46:50Z","location":{"type":"Point","coordinates":[12.3456,-78.9101]},"locationBookmark":{"id":4,"resourceType":"LocationBookmark"},"mobile":{"phone":"555-222-3333","verified":true},"name":"John Doe","notes":"Some notes here","pager":{"phone":"555-444-5555","email":"pager.email@example.com"},"percReportingEvent":50,"percReportingExercise":70,"percReportingIncident":30,"percRollingEvent":60,"percRollingExercise":80,"percRollingIncident":40,"permission":1,"deprecatedPermission":"MEMBER","position":"Manager","ref":"ABC123","retiredReason":{"id":null,"resourceType":"RetiredReason"},"role":{"id":7,"resourceType":"Role"},"signedTandC":"2026-07-03T06:46:50Z","status":"OPERATIONAL","customStatus":{"id":8,"resourceType":"CustomMemberStatus"},"teamAgreementSigned":"Agreement123","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:50Z","weeklyDayOfWeek":1,"weeklyDayOfWeekUtc":2,"weeklyHourOfDay":2,"weeklyHourOfDayUtc":2,"weeklyMail":true,"work":{"phone":"555-777-8888"},"resourceType":"Member","deletedAt":null,"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Members"]}},"/v3/{context}/{contextId}/organisations/{organisationId}":{"get":{"summary":"Retrieve an organisation","description":"Retrieve an organisation ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A organisation`s id","in":"path","required":true,"name":"organisationId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A organisation`s id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A organisation","content":{"application/json":{"example":{"id":1,"title":"Test Organisation","country":"MA","timezone":"America/El_Salvador","createdAt":"2021-10-08T15:55:27.000Z","updatedAt":"2022-09-23T18:00:02.000Z","resourceType":"Organisation"}}}}},"tags":["Organisations"]}},"/v3/{context}/{contextId}/repairs/{repairId}":{"get":{"summary":"Retrieve a repair","description":"Retrieve a repair

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"repairId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A repair resource","content":{"application/json":{"example":{"id":6,"ref":"Fuga consequatur voluptatibus nulla est. Eaque eveniet tenetur commodi non.","description":null,"assigned":{"resourceType":"Member","id":5},"assignments":[{"id":21,"assignee":{"resourceType":"Member","id":466},"completedAt":null,"createdAt":"2025-10-01T08:35:43.000Z","owner":{"resourceType":"Team","id":5},"resourceType":"TaskAssignment","status":"NOT_STARTED","task":{"resourceType":"Task","id":102},"updatedAt":"2025-10-01T08:35:43.000Z"}],"createdBy":{"resourceType":"Member","id":5},"targetResource":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"dueAt":"2022-04-18T03:17:33.000Z","completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"cause":"NATURAL_DETERIORATION","cost":0,"activity":{"resourceType":"Activity","id":2},"fund":{"resourceType":"EquipmentFund","id":2},"originator":{"resourceType":"EquipmentInspectionResult","id":1},"createdAt":"2021-10-08T18:33:20.000Z","updatedAt":"2022-04-19T01:17:33.000Z","resourceType":"Repair"}}}}},"tags":["Equipment Repairs"]},"patch":{"summary":"Update a repair","description":"Update a repair

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"repairId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"ref":{"type":["string"],"maxLength":80,"description":"The repair resource ref"},"completedAt":{"description":"Date repair was completed. Status must be COMPLETED. Defaults to time of request.","type":["string","null"],"format":"date-time"},"dueAt":{"description":"Date repair resource is due","type":["string","null"],"format":"date-time"},"description":{"type":["string"],"description":"The description of a resource"},"assignedMemberId":{"description":"ID of the member resource ref. DEPRECATED - use task-assignments endpoint.","oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"]},"cost":{"type":["integer"],"maximum":4294967295,"minimum":0,"description":"Repair cost in the lowest denomination"},"cause":{"type":["string"],"enum":["UNKNOWN","NATURAL_DETERIORATION","USED_AS_INTENDED","INCORRECT_OPERATION","PLANNED_MAINTENANCE"],"description":"Reason for repair"},"status":{"type":["string"],"enum":["NOT_STARTED","IN_PROGRESS","COMPLETED"],"description":"Status of repair"},"fundId":{"oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"]},"activityId":{"oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"]}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A repair resource","content":{"application/json":{"example":{"id":6,"ref":"Fuga consequatur voluptatibus nulla est. Eaque eveniet tenetur commodi non.","description":null,"assigned":{"resourceType":"Member","id":5},"assignments":[{"id":21,"assignee":{"resourceType":"Member","id":466},"completedAt":null,"createdAt":"2025-10-01T08:35:43.000Z","owner":{"resourceType":"Team","id":5},"resourceType":"TaskAssignment","status":"NOT_STARTED","task":{"resourceType":"Task","id":102},"updatedAt":"2025-10-01T08:35:43.000Z"}],"createdBy":{"resourceType":"Member","id":5},"targetResource":{"id":14,"ref":"000014","owner":{"resourceType":"Team","id":1},"category":{"resourceType":"EquipmentCategory","id":1},"kind":{"id":8,"title":"Eum occaecati voluptatem id.","owner":{"resourceType":"Team","id":1},"category":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentCategory","title":"A category","updatedAt":"2026-07-03T06:46:51Z"},"required":0,"type":"VEHICLE","costPerHour":0,"costPerUse":0,"costPerDistance":0,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"EquipmentKind"},"model":{"brand":{"id":1,"resourceType":"EquipmentBrand"},"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"resourceType":"EquipmentModel","title":"A model","updatedAt":"2026-07-03T06:46:51Z"},"brand":{"createdAt":"2026-07-03T06:46:51Z","id":1,"owner":{"id":1,"resourceType":"Team"},"title":"A brand","resourceType":"EquipmentBrand","updatedAt":"2026-07-03T06:46:51Z"},"supplier":{"resourceType":"EquipmentSupplier","id":1},"supplierRef":{"resourceType":"EquipmentSupplierRef","id":1},"fund":{"resourceType":"EquipmentFund","id":1},"retiredReason":{"resourceType":"EquipmentRetiredReason","id":1},"status":"OPERATIONAL","dateManufactured":null,"datePurchased":"2026-07-03T06:46:51Z","dateFirstUse":"2026-07-03T06:46:51Z","dateWarranty":null,"dateExpires":null,"dateRetired":null,"replacementCost":0,"totalReplacementCost":null,"weight":0,"totalWeight":null,"idMarks":null,"serial":null,"barcode":null,"quantity":1,"odometerReading":null,"odometerReadingDate":null,"odometerReadingTotal":null,"odometerReadingTotalAllowed":null,"type":"SUPPLY","location":{"id":1,"title":"New Warehouse","description":"This is a new warehouse.","deprecatedBundle":"SAR Bundle","address":{"country":"United States","street":"456 Oak Ave","town":"Springfield","region":"London","postcode":"SW1A 1AA"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"owner":{"id":1,"resourceType":"Team"},"createdAt":"2026-07-03T06:46:50Z","updatedAt":"2026-07-03T06:46:50Z","archivedAt":null,"resourceType":"EquipmentLocation"},"parents":[],"pending":{"resourceType":"EquipmentLocation","id":1,"owner":{"resourceType":"Team","id":1}},"minutesUse":0,"minutesAllowed":0,"countUses":0,"usesAllowed":0,"distanceUsed":null,"isCritical":true,"isMonitor":false,"notes":"000014","minutesUnserviceable":0,"dateLastStatusChange":"2026-07-03T06:46:51Z","countRepairs":0,"countUnserviceable":0,"costRepairs":0,"expireAlert":true,"expireWarningAlert":false,"expireWarningDays":null,"expireWarningUseMinutes":null,"expireWarningUseCount":null,"expireWarningUseOdometer":null,"criticalAlert":false,"costPerHour":100,"costPerUse":null,"costPerDistance":null,"dateMoved":"2026-07-03T06:46:51Z","movedBy":{"resourceType":"Member","id":1},"isAllChildOp":true,"createdAt":"2026-07-03T06:46:51Z","updatedAt":"2026-07-03T06:46:51Z","resourceType":"Equipment","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"dueAt":"2022-04-18T03:17:33.000Z","completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"cause":"NATURAL_DETERIORATION","cost":0,"activity":{"resourceType":"Activity","id":2},"fund":{"resourceType":"EquipmentFund","id":2},"originator":{"resourceType":"EquipmentInspectionResult","id":1},"createdAt":"2021-10-08T18:33:20.000Z","updatedAt":"2022-04-19T01:17:33.000Z","resourceType":"Repair"}}}}},"tags":["Equipment Repairs"]},"delete":{"summary":"Delete a repair","description":"Delete a repair

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"repairId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"Repair","message":"An optional message"}}}}},"tags":["Equipment Repairs"]}},"/v3/{context}/{contextId}/resource-bundles/{resourceBundleId}":{"get":{"summary":"Retrieve a resource bundle","description":"Retrieve a resource bundle ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Resource Bundle","in":"path","required":true,"name":"resourceBundleId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Resource Bundle"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A resource bundle","content":{"application/json":{"example":{"id":93,"owner":{"resourceType":"Team","id":40},"target":{"resourceType":"CustomField","subResourceType":"Member"},"title":"Rem corporis doloribus et neque rerum.","createdAt":"2026-07-03T06:46:51.538Z","updatedAt":"2026-07-03T06:46:51.538Z","resourceType":"ResourceBundle","ordering":0}}}}},"tags":["Resource Bundles"]}},"/v3/{context}/{contextId}/roles/{roleId}":{"get":{"summary":"Retrieve a role","description":"Retrieve a role

**Required modules:** roles","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"A role id","in":"path","required":true,"name":"roleId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"A role id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A role","content":{"application/json":{"example":{"id":1,"title":"This role's title","deprecatedBundle":"This role's bundle","owner":{"resourceType":"Team","id":1},"order":0,"cost":{"hour":20,"use":100},"resourceType":"Role","createdAt":"2026-07-03T06:46:50.985Z","updatedAt":"2026-07-03T06:46:50.985Z"}}}}},"tags":["Roles"]}},"/v3/{context}/{contextId}/tags/{tagId}":{"get":{"summary":"Retrieve a tag","description":"Retrieve a tag

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"tagId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A tag resource","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51.569Z","title":"Avalanche Rescue","id":1,"notes":"Some text about this tag","resourceType":"Tag","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:51.569Z"}}}}},"tags":["Tags"]},"patch":{"summary":"Update a tag","description":"Update a tag

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"tagId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"title":{"type":["string"],"minLength":1,"maxLength":100,"description":"The title of a resource"},"notes":{"type":["string"],"minLength":1,"maxLength":65535,"description":"Some descriptive text for the resource"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A tag resource","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51.569Z","title":"Avalanche Rescue","id":1,"notes":"Some text about this tag","resourceType":"Tag","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:51.569Z"}}}}},"tags":["Tags"]},"delete":{"summary":"Delete a tag","description":"Delete a tag

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"tagId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"Tag","message":"An optional message"}}}}},"tags":["Tags"]}},"/v3/{context}/{contextId}/task-assignments/{assignmentId}":{"get":{"summary":"Retrieve a task assignment","description":"Retrieve a task assignment

**Required modules:** tasks","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"assignmentId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A task assignment resource","content":{"application/json":{"example":{"id":1,"task":{"resourceType":"Task","id":5},"assignee":{"resourceType":"Member","id":10},"completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"TaskAssignment"}}}}},"tags":["Tasks"]}},"/v3/{context}/{contextId}/tasks/{taskId}":{"get":{"summary":"Retrieve a task","description":"Retrieve a task

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"taskId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A task resource","content":{"application/json":{"example":{"id":1,"ref":"TASK-001","description":"Example task description","completionType":"ANY","assigned":[{"id":1,"task":{"resourceType":"Task","id":1},"assignee":{"resourceType":"Member","id":5},"completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"TaskAssignment"}],"createdBy":{"resourceType":"Member","id":5},"targetResource":{"resourceType":"Event","id":15},"dueAt":"2023-12-31T23:59:59.000Z","completedAt":null,"status":"NOT_STARTED","owner":{"resourceType":"Team","id":1},"createdAt":"2023-01-01T00:00:00.000Z","updatedAt":"2023-01-01T00:00:00.000Z","resourceType":"Task"}}}}},"tags":["Tasks"]}},"/v3/{context}/{contextId}/teams/{teamId}":{"get":{"summary":"Retrieve a team","description":"Retrieve a team ","parameters":[],"security":[{"Unified":[]}],"responses":{"200":{"description":"A team","content":{"application/json":{"example":{"id":1,"globalSyncId":"62a68dac60b511f09c4a325096b39f47","owner":{"id":1,"resourceType":"Organisation"},"title":"Task Force Llama","location":{"type":"Point","coordinates":[0,0]},"memberCounts":{"total":192,"operational":89},"timezone":"America/New_York","country":"CA","deletedAt":null,"overview":"Some text about the team","createdAt":"2021-10-08T15:55:27.000Z","updatedAt":"2022-12-27T18:05:51.000Z","subdomain":"task-force-llama","resourceType":"Team"}}}}},"tags":["Teams"]}},"/v3/{context}/{contextId}/whiteboard/{noteId}":{"get":{"summary":"Retrieve a whiteboard note","description":"Retrieve a whiteboard note

**Required modules:** whiteboard","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Whiteboard note","in":"path","required":true,"name":"noteId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Whiteboard note"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A whiteboard note","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51.599Z","archivedAt":"2026-07-03T06:46:51.599Z","id":1,"author":{"resourceType":"Member","id":1},"text":"","resourceType":"Whiteboard","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:51.599Z","important":false,"url":"http://d4h.com"}}}}},"tags":["Whiteboard"]},"patch":{"summary":"Update a whiteboard note","description":"Update a whiteboard note

**Required modules:** whiteboard","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Whiteboard note","in":"path","required":true,"name":"noteId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Whiteboard note"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"archivedAt":{"description":"The date-time at which the note is archived","type":["string"],"format":"date-time"},"important":{"description":"Set to true to mark the note as important","default":false,"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}]},"text":{"type":["string"],"minLength":3,"maxLength":140,"description":"The contents of the note. Supports plain text or HTML."},"url":{"type":["string"],"format":"uri","minLength":1,"maxLength":2083,"description":"A http/https RFC-3986 URI to be associate with the note"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A whiteboard note","content":{"application/json":{"example":{"createdAt":"2026-07-03T06:46:51.599Z","archivedAt":"2026-07-03T06:46:51.599Z","id":1,"author":{"resourceType":"Member","id":1},"text":"","resourceType":"Whiteboard","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:51.599Z","important":false,"url":"http://d4h.com"}}}}},"tags":["Whiteboard"]},"delete":{"summary":"Delete a whiteboard note","description":"Delete a whiteboard note

**Required modules:** whiteboard","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the Whiteboard note","in":"path","required":true,"name":"noteId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the Whiteboard note"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"Whiteboard","message":"An optional message"}}}}},"tags":["Whiteboard"]}},"/v3/team/{teamId}/events/reference/check":{"post":{"summary":"Check if an auto-id reference is available","description":"Check if an auto-id reference is available

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"reference":{"type":["string"],"maxLength":30,"description":"Reference code for activity. Must be unique. Only allowed if team has activity auto-id enabled."},"targetResourceId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},"required":["reference"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A response indicating availability","content":{"application/json":{"example":{"available":true}}}}},"tags":["Events"]}},"/v3/team/{teamId}/events/reference/increment":{"post":{"summary":"Increment the auto-id reference sequence","description":"Increment the auto-id reference sequence

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A response indicating a reference to be used","content":{"application/json":{"example":{"reference":"00001"}}}}},"tags":["Events"]}},"/v3/team/{teamId}/events/reference/peek":{"post":{"summary":"Retrieve the next available auto-id reference","description":"Retrieve the next available auto-id reference

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A response indicating the next available reference","content":{"application/json":{"example":{"reference":"00001"}}}}},"tags":["Events"]}},"/v3/team/{teamId}/exercises/reference/check":{"post":{"summary":"Check if an auto-id reference is available","description":"Check if an auto-id reference is available

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"reference":{"type":["string"],"maxLength":30,"description":"Reference code for activity. Must be unique. Only allowed if team has activity auto-id enabled."},"targetResourceId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},"required":["reference"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A response indicating availability","content":{"application/json":{"example":{"available":true}}}}},"tags":["Exercises"]}},"/v3/team/{teamId}/exercises/reference/increment":{"post":{"summary":"Increment the auto-id reference sequence","description":"Increment the auto-id reference sequence

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A response indicating a reference to be used","content":{"application/json":{"example":{"reference":"00001"}}}}},"tags":["Exercises"]}},"/v3/team/{teamId}/exercises/reference/peek":{"post":{"summary":"Retrieve the next available auto-id reference","description":"Retrieve the next available auto-id reference

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A response indicating the next available reference","content":{"application/json":{"example":{"reference":"00001"}}}}},"tags":["Exercises"]}},"/v3/team/{teamId}/incidents/reference/check":{"post":{"summary":"Check if an auto-id reference is available","description":"Check if an auto-id reference is available

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"reference":{"type":["string"],"maxLength":30,"description":"Reference code for activity. Must be unique. Only allowed if team has activity auto-id enabled."},"targetResourceId":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},"required":["reference"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A response indicating availability","content":{"application/json":{"example":{"available":true}}}}},"tags":["Incidents"]}},"/v3/team/{teamId}/incidents/reference/increment":{"post":{"summary":"Increment the auto-id reference sequence","description":"Increment the auto-id reference sequence

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A response indicating a reference to be used","content":{"application/json":{"example":{"reference":"00001"}}}}},"tags":["Incidents"]}},"/v3/team/{teamId}/incidents/reference/peek":{"post":{"summary":"Retrieve the next available auto-id reference","description":"Retrieve the next available auto-id reference

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A response indicating the next available reference","content":{"application/json":{"example":{"reference":"00001"}}}}},"tags":["Incidents"]}},"/v3/team/{teamId}/duties/{dutyId}/update-duty-period":{"post":{"summary":"Update a duty period","description":"Update a duty period

**Required modules:** duty","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"dutyId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"notes":{"type":["string","null"],"maxLength":65535},"roleId":{"oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"]},"startsAt":{"description":"Start of the duty period","type":["string"],"format":"date-time"},"endsAt":{"description":"End of the duty period","type":["string"],"format":"date-time"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A duty period","content":{"application/json":{"example":{"id":1,"notes":"A note about this duty","startsAt":"2026-07-03T06:46:50.987Z","endsAt":"2026-07-03T06:46:50.987Z","type":"OFF","role":{"id":1,"title":"This role's title","deprecatedBundle":"This role's bundle","owner":{"resourceType":"Team","id":1},"order":0,"cost":{"hour":20,"use":100},"resourceType":"Role","createdAt":"2026-07-03T06:46:50.985Z","updatedAt":"2026-07-03T06:46:50.985Z"},"parent":{"resourceType":"Duty","id":1},"member":{"alertActivityApproval":true,"alertAllQualifications":true,"alertGear":true,"alertQualifications":true,"chatAutosubscribe":true,"chatDailyDigest":true,"contactUpdateMail":true,"costPerHour":50,"costPerUse":10,"countReportingEvent":20,"countReportingExercise":10,"countReportingHours":40,"countReportingIncident":5,"countRollingHours":30,"countRollingHoursEvent":15,"countRollingHoursExercise":25,"countRollingHoursIncident":3,"createdAt":"2026-07-03T06:46:50Z","credits":100,"defaultDuty":"ON","defaultEquipmentLocation":{"id":2,"resourceType":"EquipmentLocation"},"deprecatedAddress":"456 Oak Ave, Springfield, London, SW1A 1AA, England","email":{"value":"john.doe@example.com","verified":true},"primaryEmergencyContact":{"name":"Emergency Contact 1","primaryPhone":"555-123-4567","secondaryPhone":"555-987-6543","relation":"Parent"},"secondaryEmergencyContact":{"name":"Emergency Contact 2","primaryPhone":"555-555-5555","secondaryPhone":"555-666-6666","relation":"Sibling"},"endsAt":"2026-07-03T06:46:50Z","globalSyncId":"62a68dac60b511f09c4a325096b39f47","home":{"phone":"555-789-0123","verified":true},"icalSecret":"icalSecret123","id":1,"idTag":"RFID123","startsAt":"2026-07-03T06:46:50Z","lastLogin":"2026-07-03T06:46:50Z","location":{"type":"Point","coordinates":[12.3456,-78.9101]},"locationBookmark":{"id":4,"resourceType":"LocationBookmark"},"mobile":{"phone":"555-222-3333","verified":true},"name":"John Doe","notes":"Some notes here","pager":{"phone":"555-444-5555","email":"pager.email@example.com"},"percReportingEvent":50,"percReportingExercise":70,"percReportingIncident":30,"percRollingEvent":60,"percRollingExercise":80,"percRollingIncident":40,"permission":1,"deprecatedPermission":"MEMBER","position":"Manager","ref":"ABC123","retiredReason":{"id":null,"resourceType":"RetiredReason"},"role":{"id":7,"resourceType":"Role"},"signedTandC":"2026-07-03T06:46:50Z","status":"OPERATIONAL","customStatus":{"id":8,"resourceType":"CustomMemberStatus"},"teamAgreementSigned":"Agreement123","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:50Z","weeklyDayOfWeek":1,"weeklyDayOfWeekUtc":2,"weeklyHourOfDay":2,"weeklyHourOfDayUtc":2,"weeklyMail":true,"work":{"phone":"555-777-8888"},"resourceType":"Member","deletedAt":null,"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]},"owner":{"resourceType":"Team","id":1},"repeat":{"every":{"interval":"WEEK","period":1},"until":"2026-07-03T06:46:50.987Z"},"resourceType":"Duty","createdAt":"2026-07-03T06:46:50.987Z","updatedAt":"2026-07-03T06:46:50.987Z"}}}}},"tags":["Duties"]}},"/v3/team/{teamId}/events/{activityId}/approval":{"post":{"summary":"Change an event approval readiness","description":"Change an event approval readiness

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"oneOf":[{"type":["integer"],"minimum":1},{"type":["string"],"minLength":32,"maxLength":32,"pattern":"^[0-9a-f]{32}$","description":"A global resource identifier for cross-product sync"}],"description":"A team id"}},{"description":"The activity identifier","in":"path","required":true,"name":"activityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The activity identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"approval":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether or not an activity is ready to be approved (published)"}},"required":["approval"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An event","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.295Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.295Z","updatedAt":"2026-07-03T06:46:51.295Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.295Z","endsAt":"2026-07-03T06:46:51.295Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.295Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Events"]}},"/v3/team/{teamId}/events/{activityId}/publish":{"post":{"summary":"Change an event published status","description":"Change an event published status

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"oneOf":[{"type":["integer"],"minimum":1},{"type":["string"],"minLength":32,"maxLength":32,"pattern":"^[0-9a-f]{32}$","description":"A global resource identifier for cross-product sync"}],"description":"A team id"}},{"description":"The activity identifier","in":"path","required":true,"name":"activityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The activity identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"published":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether or not an activity is published"}},"required":["published"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An event","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.295Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.295Z","updatedAt":"2026-07-03T06:46:51.295Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.295Z","endsAt":"2026-07-03T06:46:51.295Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.295Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Events"]}},"/v3/team/{teamId}/events/{activityId}/tags":{"post":{"summary":"Set an event's tags","description":"Set an event's tags

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The activity identifier","in":"path","required":true,"name":"activityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The activity identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"tagIds":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"description":"The complete list of desired tag ids"}},"required":["tagIds"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An event","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.295Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.295Z","updatedAt":"2026-07-03T06:46:51.295Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.295Z","endsAt":"2026-07-03T06:46:51.295Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.295Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Events"]}},"/v3/team/{teamId}/exercises/{activityId}/approval":{"post":{"summary":"Change an exercise approval readiness","description":"Change an exercise approval readiness

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"oneOf":[{"type":["integer"],"minimum":1},{"type":["string"],"minLength":32,"maxLength":32,"pattern":"^[0-9a-f]{32}$","description":"A global resource identifier for cross-product sync"}],"description":"A team id"}},{"description":"The activity identifier","in":"path","required":true,"name":"activityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The activity identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"approval":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether or not an activity is ready to be approved (published)"}},"required":["approval"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An exercise","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.306Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.306Z","updatedAt":"2026-07-03T06:46:51.306Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.306Z","endsAt":"2026-07-03T06:46:51.306Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.306Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Exercises"]}},"/v3/team/{teamId}/exercises/{activityId}/publish":{"post":{"summary":"Change an exercise published status","description":"Change an exercise published status

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"oneOf":[{"type":["integer"],"minimum":1},{"type":["string"],"minLength":32,"maxLength":32,"pattern":"^[0-9a-f]{32}$","description":"A global resource identifier for cross-product sync"}],"description":"A team id"}},{"description":"The activity identifier","in":"path","required":true,"name":"activityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The activity identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"published":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether or not an activity is published"}},"required":["published"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An exercise","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.306Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.306Z","updatedAt":"2026-07-03T06:46:51.306Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.306Z","endsAt":"2026-07-03T06:46:51.306Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.306Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Exercises"]}},"/v3/team/{teamId}/exercises/{activityId}/tags":{"post":{"summary":"Set an exercise's tags","description":"Set an exercise's tags

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The activity identifier","in":"path","required":true,"name":"activityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The activity identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"tagIds":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"description":"The complete list of desired tag ids"}},"required":["tagIds"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An exercise","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.306Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.306Z","updatedAt":"2026-07-03T06:46:51.306Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.306Z","endsAt":"2026-07-03T06:46:51.306Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.306Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Exercises"]}},"/v3/team/{teamId}/health-safety-reports/{resourceId}/approval":{"post":{"summary":"Change a health & safety report's approval status","description":"Change a health & safety report's approval status

**Required modules:** healthsafety","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The resource identifier","in":"path","required":true,"name":"resourceId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The resource identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"approved":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether or not a resource is approved"}},"required":["approved"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"A health & safety report","content":{"application/json":{"example":{"targetResource":{"id":1,"resourceType":"Incident"},"address":{"country":"","postcode":"","region":"","street":"","town":""},"approvedAt":"2026-07-03T06:46:43.215Z","category":{"id":1,"resourceType":"HealthSafetyCategory"},"cause":"Some cause","createdAt":"2026-07-03T06:46:43.215Z","startsAt":"2026-07-03T06:46:43.215Z","description":"","id":1,"location":{"type":"Point","coordinates":[0,0]},"measures":"","resourceType":"HealthSafetyReport","severity":{"id":1,"resourceType":"HealthSafetySeverity"},"owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:43.215Z","customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Health & Safety"]}},"/v3/team/{teamId}/incidents/{activityId}/approval":{"post":{"summary":"Change an incident approval readiness","description":"Change an incident approval readiness

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"oneOf":[{"type":["integer"],"minimum":1},{"type":["string"],"minLength":32,"maxLength":32,"pattern":"^[0-9a-f]{32}$","description":"A global resource identifier for cross-product sync"}],"description":"A team id"}},{"description":"The activity identifier","in":"path","required":true,"name":"activityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The activity identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"approval":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether or not an activity is ready to be approved (published)"}},"required":["approval"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An incident","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.407Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.407Z","updatedAt":"2026-07-03T06:46:51.407Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.407Z","endsAt":"2026-07-03T06:46:51.407Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.407Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Incidents"]}},"/v3/team/{teamId}/incidents/{activityId}/publish":{"post":{"summary":"Change an incident published status","description":"Change an incident published status

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"oneOf":[{"type":["integer"],"minimum":1},{"type":["string"],"minLength":32,"maxLength":32,"pattern":"^[0-9a-f]{32}$","description":"A global resource identifier for cross-product sync"}],"description":"A team id"}},{"description":"The activity identifier","in":"path","required":true,"name":"activityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The activity identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"published":{"oneOf":[{"type":["boolean"]},{"type":["string"],"enum":["true","false","1","0",""]}],"description":"Whether or not an activity is published"}},"required":["published"]}}}},"security":[{"Unified":[]},{"Legacy":[]}],"responses":{"200":{"description":"An incident","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.407Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.407Z","updatedAt":"2026-07-03T06:46:51.407Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.407Z","endsAt":"2026-07-03T06:46:51.407Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.407Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Incidents"]}},"/v3/team/{teamId}/incidents/{activityId}/tags":{"post":{"summary":"Set an incident's tags","description":"Set an incident's tags

**Required modules:** activities","parameters":[{"description":"A team id","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"description":"A team id"}},{"description":"The activity identifier","in":"path","required":true,"name":"activityId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The activity identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"tagIds":{"type":["array"],"items":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},"description":"The complete list of desired tag ids"}},"required":["tagIds"]}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"An incident","content":{"application/json":{"example":{"id":1,"reference":"0001","referenceDescription":"Monthly test","owner":{"resourceType":"Team","id":1},"locationBookmark":{"resourceType":"LocationBookmark","id":1},"weather":{"symbol":"sunny","symbolDate":"2026-07-03T06:46:51.407Z","temperature":11.4},"address":{"postcode":"11023","region":"The Shire","street":"Bag End","town":"Hobbiton","country":"Eriador"},"location":{"type":"Point","coordinates":[12.3456,-78.9101]},"resourceType":"Event","createdAt":"2026-07-03T06:46:51.407Z","updatedAt":"2026-07-03T06:46:51.407Z","bearing":null,"coordinator":null,"description":"The activity description","distance":0,"startsAt":"2026-07-03T06:46:51.407Z","endsAt":"2026-07-03T06:46:51.407Z","night":true,"plan":"plan text","published":true,"shared":false,"fullTeam":false,"approved":false,"countAttendance":9,"countGuests":5,"createdOrPublishedAt":"2026-07-03T06:46:51.407Z","percAttendance":90,"selfCoordinator":true,"trackingNumber":"193","deletedAt":null,"tags":[{"id":1,"resourceType":"Tag"}],"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Incidents"]}},"/v3/{context}/{contextId}/documents/{documentId}/download":{"get":{"summary":"Download a document","description":"Download a document

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the document","in":"path","required":true,"name":"documentId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the document"}},{"description":"The document size to be downloaded","in":"query","name":"size","required":false,"schema":{"type":["string"],"enum":["ORIGINAL","PREVIEW","THUMBNAIL"],"description":"The document size to be downloaded"}},{"description":"The revision number to be downloaded","in":"query","name":"revision","required":false,"schema":{"type":["number"],"description":"The revision number to be downloaded"}},{"description":"Legacy version search","in":"query","name":"version","required":false,"schema":{"type":["string"],"description":"Legacy version search"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A binary file with the Document file type","content":{"application/json":{}}}},"tags":["Documents"]}},"/v3/{context}/{contextId}/documents/{documentId}/revisions":{"get":{"summary":"Retrieve a single document's revisions","description":"Retrieve a single document's revisions

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the document","in":"path","required":true,"name":"documentId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the document"}},{"description":"Page number","in":"query","name":"page","required":false,"schema":{"type":["integer"],"minimum":0,"description":"Page number"}},{"description":"Items per page","in":"query","name":"size","required":false,"schema":{"type":["integer"],"description":"Items per page"}},{"description":"A list of ids","in":"query","name":"id","required":false,"schema":{"oneOf":[{"type":["integer"]},{"type":["array"],"items":{"type":["integer"]}}],"description":"A list of ids"}},{"description":"The requested revision number","in":"query","name":"revision","required":false,"schema":{"type":["string"],"minLength":1,"maxLength":20,"description":"The requested revision number"}},{"in":"query","name":"sort","required":false,"schema":{"default":"id","type":["string"],"enum":["createdAt","updatedAt","id"]}},{"in":"query","name":"order","required":false,"schema":{"default":"asc","type":["string"],"enum":["asc","desc"]}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A document revision detail","content":{"application/json":{"example":{"results":[{"id":1,"createdAt":"2026-07-03T06:46:53.167Z","updatedAt":"2026-07-03T06:46:53.167Z","description":"","revision":1,"availableSizes":["original","preview","thumbnail"],"avScanStatus":"SAFE","document":{"id":1,"resourceType":"Document"},"fileName":"example.pdf","fileSize":100,"resourceType":"DocumentRevision"}],"pageSize":1,"page":0,"totalSize":1}}}}},"tags":["Documents"]}},"/v3/{context}/{contextId}/equipment-brands/{brandId}/image":{"get":{"summary":"Download an equipment brand profile image","description":"Download an equipment brand profile image

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"brandId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},{"description":"The image size to be downloaded","in":"query","name":"size","required":false,"schema":{"type":["string"],"enum":["ORIGINAL","PREVIEW","THUMBNAIL"],"description":"The image size to be downloaded"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A binary image file","content":{"application/json":{}}}},"tags":["Equipment Brands"]}},"/v3/{context}/{contextId}/equipment-inspection-results/{inspectionResultId}/equipment-inspection-step-results":{"get":{"summary":"Retrieve an equipment inspection's steps' results","description":"Retrieve an equipment inspection's steps' results

**Required modules:** equipment_inspections","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"An inspection result id","in":"path","required":true,"name":"inspectionResultId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"An inspection result id"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"An inspection result's step's results","content":{"application/json":{"example":{"results":[{"id":1,"notes":"A note on how the step went","outcome":"PASS","stepText":"Check seatbelts","equipmentInspectionResult":{"resourceType":"EquipmentInspectionResult","id":1},"owner":{"resourceType":"Team","id":40},"resourceType":"EquipmentInspectionStepResult","createdAt":"2026-07-03T06:46:51.054Z","updatedAt":"2026-07-03T06:46:51.054Z"}],"page":0,"pageSize":1,"totalSize":1}}}}},"tags":["Equipment Inspections"]}},"/v3/{context}/{contextId}/equipment-models/{modelId}/image":{"get":{"summary":"Download an equipment model profile image","description":"Download an equipment model profile image

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"modelId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},{"description":"The image size to be downloaded","in":"query","name":"size","required":false,"schema":{"type":["string"],"enum":["ORIGINAL","PREVIEW","THUMBNAIL"],"description":"The image size to be downloaded"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A binary image file","content":{"application/json":{}}}},"tags":["Equipment Models"]}},"/v3/{context}/{contextId}/equipment-suppliers/{supplierId}/image":{"get":{"summary":"Download an equipment supplier profile image","description":"Download an equipment supplier profile image

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"supplierId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},{"description":"The image size to be downloaded","in":"query","name":"size","required":false,"schema":{"type":["string"],"enum":["ORIGINAL","PREVIEW","THUMBNAIL"],"description":"The image size to be downloaded"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A binary image file","content":{"application/json":{}}}},"tags":["Equipment Suppliers"]}},"/v3/{context}/{contextId}/equipment/{itemId}/image":{"get":{"summary":"Download an equipment item profile image","description":"Download an equipment item profile image

**Required modules:** equipment","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"itemId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},{"description":"The image size to be downloaded","in":"query","name":"size","required":false,"schema":{"type":["string"],"enum":["ORIGINAL","PREVIEW","THUMBNAIL"],"description":"The image size to be downloaded"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A binary image file","content":{"application/json":{}}}},"tags":["Equipment Items"]}},"/v3/{context}/{contextId}/members/{member}/image":{"get":{"summary":"Download a member profile image","description":"Download a member profile image

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"Member the resource belongs to. Either an id or \"me\".","in":"path","required":true,"name":"member","schema":{"oneOf":[{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"},{"type":["string"],"enum":["me"]}],"description":"Member the resource belongs to. Either an id or \"me\"."}},{"description":"The image size to be downloaded","in":"query","name":"size","required":false,"schema":{"type":["string"],"enum":["ORIGINAL","PREVIEW","THUMBNAIL"],"description":"The image size to be downloaded"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A binary image file","content":{"application/json":{}}}},"tags":["Members"]}},"/v3/{context}/{contextId}/members/{member}/retire":{"patch":{"summary":"Retire or unretire a member","description":"Retire or unretire a member

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"member","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}}],"requestBody":{"content":{"application/json":{"schema":{"type":["object"],"properties":{"date":{"description":"Member retirement date","type":["string"],"format":"date-time"},"reasonId":{"oneOf":[{"type":["string"],"enum":["null"]},{"type":["string","null"],"enum":["null"]},{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}],"type":["null"],"description":"A retirement reason identifier"},"direction":{"default":"RETIRE","type":["string"],"enum":["RETIRE","UNRETIRE"],"description":"Whether to retire or unretire the member"}}}}}},"security":[{"Unified":[]}],"responses":{"200":{"description":"The updated member","content":{"application/json":{"example":{"alertActivityApproval":true,"alertAllQualifications":true,"alertGear":true,"alertQualifications":true,"chatAutosubscribe":true,"chatDailyDigest":true,"contactUpdateMail":true,"costPerHour":50,"costPerUse":10,"countReportingEvent":20,"countReportingExercise":10,"countReportingHours":40,"countReportingIncident":5,"countRollingHours":30,"countRollingHoursEvent":15,"countRollingHoursExercise":25,"countRollingHoursIncident":3,"createdAt":"2026-07-03T06:46:50Z","credits":100,"defaultDuty":"ON","defaultEquipmentLocation":{"id":2,"resourceType":"EquipmentLocation"},"deprecatedAddress":"456 Oak Ave, Springfield, London, SW1A 1AA, England","email":{"value":"john.doe@example.com","verified":true},"primaryEmergencyContact":{"name":"Emergency Contact 1","primaryPhone":"555-123-4567","secondaryPhone":"555-987-6543","relation":"Parent"},"secondaryEmergencyContact":{"name":"Emergency Contact 2","primaryPhone":"555-555-5555","secondaryPhone":"555-666-6666","relation":"Sibling"},"endsAt":"2026-07-03T06:46:50Z","globalSyncId":"62a68dac60b511f09c4a325096b39f47","home":{"phone":"555-789-0123","verified":true},"icalSecret":"icalSecret123","id":1,"idTag":"RFID123","startsAt":"2026-07-03T06:46:50Z","lastLogin":"2026-07-03T06:46:50Z","location":{"type":"Point","coordinates":[12.3456,-78.9101]},"locationBookmark":{"id":4,"resourceType":"LocationBookmark"},"mobile":{"phone":"555-222-3333","verified":true},"name":"John Doe","notes":"Some notes here","pager":{"phone":"555-444-5555","email":"pager.email@example.com"},"percReportingEvent":50,"percReportingExercise":70,"percReportingIncident":30,"percRollingEvent":60,"percRollingExercise":80,"percRollingIncident":40,"permission":1,"deprecatedPermission":"MEMBER","position":"Manager","ref":"ABC123","retiredReason":{"id":null,"resourceType":"RetiredReason"},"role":{"id":7,"resourceType":"Role"},"signedTandC":"2026-07-03T06:46:50Z","status":"OPERATIONAL","customStatus":{"id":8,"resourceType":"CustomMemberStatus"},"teamAgreementSigned":"Agreement123","owner":{"id":1,"resourceType":"Team"},"updatedAt":"2026-07-03T06:46:50Z","weeklyDayOfWeek":1,"weeklyDayOfWeekUtc":2,"weeklyHourOfDay":2,"weeklyHourOfDayUtc":2,"weeklyMail":true,"work":{"phone":"555-777-8888"},"resourceType":"Member","deletedAt":null,"customFieldValues":[{"customField":{"id":1,"type":"NUMBER","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":"123.45"},{"customField":{"id":2,"type":"SINGLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[666]},{"customField":{"id":3,"type":"MULTIPLE_CHOICE","owner":{"id":1,"resourceType":"Team"},"resourceType":"CustomField"},"value":[999,888]}]}}}}},"tags":["Members"]}},"/v3/{context}/{contextId}/teams/{teamId}/image":{"get":{"summary":"Download a team profile image","description":"Download a team profile image ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The numeric identifier for a resource","in":"path","required":true,"name":"teamId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The numeric identifier for a resource"}},{"description":"The image size to be downloaded","in":"query","name":"size","required":false,"schema":{"type":["string"],"enum":["ORIGINAL","PREVIEW","THUMBNAIL"],"description":"The image size to be downloaded"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A binary image file","content":{"application/json":{}}}},"tags":["Teams"]}},"/v3/{context}/{contextId}/documents/{documentId}/revisions/{revisionId}":{"get":{"summary":"Retrieve a single document revision's details","description":"Retrieve a single document revision's details

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The document revision number","in":"path","required":true,"name":"revisionId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The document revision number"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"A document revision detail","content":{"application/json":{"example":{"id":1,"createdAt":"2026-07-03T06:46:53.167Z","updatedAt":"2026-07-03T06:46:53.167Z","description":"","revision":1,"availableSizes":["original","preview","thumbnail"],"avScanStatus":"SAFE","document":{"id":1,"resourceType":"Document"},"fileName":"example.pdf","fileSize":100,"resourceType":"DocumentRevision"}}}}},"tags":["Documents"]},"delete":{"summary":"Delete a document revision","description":"Delete a document revision

**Required modules:** ","parameters":[{"description":"The point of view from where the request takes place","in":"path","required":true,"name":"context","schema":{"type":["string"],"enum":["team","organisation","admin"],"description":"The point of view from where the request takes place"}},{"description":"Either a team, organisation or admin's id","in":"path","required":true,"name":"contextId","schema":{"type":["integer"],"minimum":1,"description":"Either a team, organisation or admin's id"}},{"description":"The ID of the document","in":"path","required":true,"name":"documentId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the document"}},{"description":"The ID of the document revision","in":"path","required":true,"name":"revisionId","schema":{"type":["integer"],"minimum":1,"maximum":2147483647,"description":"The ID of the document revision"}}],"security":[{"Unified":[]}],"responses":{"200":{"description":"The delete response","content":{"application/json":{"example":{"deleted":true,"resourceType":"DocumentRevision","message":"An optional message"}}}}},"tags":["Documents"]}}},"security":[{"Bearer":["B2B","B2B_DEV","UNIFIED","LEGACY"]}],"components":{"schemas":{},"securitySchemes":{"Unified":{"type":"http","description":"Enter Personal Access Token **_only_**","scheme":"bearer","bearerFormat":"JWT"},"B2B":{"type":"http","description":"Enter B2B token **_only_**","scheme":"bearer","bearerFormat":"JWT"}}},"tags":[{"name":"Custom Fields","description":"Please note, these endpoints are for interacting with Custom Fields themselves, _not_ the values of a custom field for any particular resource.\n\nIn order to 'fill-in' a field for a particular resource, you can use the CREATE or UPDATE endpoint for the resource itself -- by populating the `customFieldValues` property in your request payload.\n\nSimilarly to view the values of fields for a particular resource, those values will be returned alongside all of the other resource properties from its own endpoint -- again within the `customFieldValues` property.\n"},{"name":"Duties","description":"Duty period creation (`/duties/add-duty-period`) and updating (`/duties/update-duty-period`) endpoints are considered 'functional' endpoints, instead of the typical REST CRUD endpoint. Mainly because they do not behave in the standard manner, and may not even return a resource (however in that case you will receive an empty response but with an appropriate status code to indicate that the request was still a success). Functional endpoints always use POST unless they are purely for data retrieval.\n\nEach member has a 'default duty' state ('ON' or 'OFF') and can have a default role. If your member is 'ON' by default you can create 'OFF' duty resources for them, but an 'ON' resource will only be created if there is some distinction from their defaults - i.e. either a role id that is different to their default, or adding notes. Otherwise, since there is no actual resource for the default duty state of a member - there is nothing to return.\n\nTo 'create' an 'ON' period for a user that defaults to 'ON' you would make a POST request - but no actual resource will be created (unless the role or notes are different). The api will split or edit any 'OFF' duty periods in order to fit the 'ON' period in, and return an empty response with an appropriate status code to indicate that nothing was created but the operation was successful.\n\nSimilarly, when updating a duty other duties can be affected. They can potentially be deleted, shortened or lengthened, absorb or be absorbed by the target duty resource. The returned duty period, if there is one, may not have the same start or end dates as were sent - depending on what existing duty periods there already were. The target duty period may be deleted if the update would result in it matching the member's defaults.\n\nDeletion of a duty period resource, can be performed as with other resources. Two things to note however:\n\n- Firstly, when a repeating duty is deleted using the standard method - if it is the \"parent\" duty of the repitition then the next chronological duty by date will become the new \"parent\" to all other duties.\n- Secondly, if query parameter `all_following` is set to true and the duty is a repeating one, then every child duty following the target one will also be deleted.\n\nThe creation of repeating duties is not currently supported by the API. Updating is supported, but any changes will be applied to that single duty resource and not any repetitions.\n"},{"name":"Equipment Inspections","description":"### Notes on creation of Inspection Results\n\nInspection Results are handled a bit differently to other resources. Basically when an inspection is completed, the system itself should automatically create a new 'incomplete' result for that inspection for that item. This might not happen instantly depending on how much equipment / inspections your team has, but would normally be available straight away.\n\nEssentially, you should never have to create a result resource yourself (so long as the inspection is active) - only update the sole incomplete one to be 'complete'. This applies only to Inspection Results, not inspections themselves or inspection steps.\n"},{"name":"Resource Bundles","description":"Currently, only custom fields can be added to resource bundles. Each bundle is only for a specific sub-resource-type. Meaning, resource bundles can be used to collect together custom fields for a particular resource type. You can have bundles of member custom fields, bundles of incident custom fields, etc.\n"}]}