Teambridge Collections (Unified API) API
**Powerful generic endpoints** for reading and writing any collection type.Works with all collections using field UUIDs. Query `/fields` first todiscover the schema, then use these endpoints for flexible data access acrossall collection types (shifts, users, placements, locations, custom collections, etc.).## FilteringThe unified Collections API (`/v1/collections/{collectionId}/records`) supports powerful filtering via query parameters.You can filter records by adding query parameters in the format `{fieldUUID}_{operator}={value}`.**Supported Operators:**- `_is`: Exact match (all field types) - **default if no suffix provided**- `_contains`: Partial text match (TEXT fields only)- `_gt`: Greater than (NUMBER, DATETIME fields)- `_gte`: Greater than or equal (NUMBER, DATETIME fields)- `_lt`: Less than (NUMBER, DATETIME fields)- `_lte`: Less than or equal (NUMBER, DATETIME fields)**Filtering Features:**- **Multiple filters**: Up to 10 filters per request with implicit AND logic (all must match)- **Default operator**: Parameters without a suffix default to `_is` behavior- **Multiple operators on same field**: Allowed (e.g., `age_gte=21&age_lte=65` for range queries)- **Case-insensitive**: TEXT and SELECT field matching is case-insensitive- **Smart date handling**: DATETIME fields support both date-only (`2025-01-01`) and full ISO 8601 format (`2025-01-01T14:30:00Z`)**Reserved Parameters**: The following parameter names are reserved and cannot be used as filter bases: `page`, `size`, `limit`, `offset`.**Filtering Examples:**- Single filter (exact match): `?550e8400-..._is=john@example.com`- Default operator (no suffix): `?550e8400-...=john@example.com` (equivalent to `_is`)- Partial text match: `?550e8400-..._contains=john`- Date exact match: `?abc123-..._is=2025-12-01`- Date range: `?abc123-..._gte=2025-01-01&abc123-..._lte=2025-12-31`- Number range: `?age-uuid-..._gte=21&age-uuid-..._lte=65`- Multiple fields: `?550e8400-..._is=john@example.com&7c9e6679-..._is=active`- Mixed operators: `?name-uuid-..._contains=john&age-uuid-..._gte=21`
Teambridge Collections (Unified API) API is one of 4 APIs that Teambridge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Collections (Unified API). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 6 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.
Requests are made against a single base URL, https://open-api.teambridge.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Teambridge Collections (Unified API) API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 1 scope.
An API key is passed in the header as X-Webhook-Signature (WebhookSignature).
By default, every request must be authenticated.
WebhookSignature— HMAC-SHA256 signature for webhook authentication. The signature is computed from the concatenation of the timestamp and request body: {timestamp}.{body}. The s…
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Powerful generic endpoints for reading and writing any collection type. Works with all collections using field UUIDs. Query /fields first to discover the schema, then use these en…
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Field (7 properties), GenericErrorResponse (2 properties), ListCollectionsMetadata (2 properties), ListCollectionsResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Teambridge 3
Other APIs Teambridge publishes across the network.