Introduction
Bramble provides an API which makes it easy for developers to integrate external systems with our platform.
Our API is designed to handle the data integration needs for your business or application while making the integration process as painless as possible.
Through the API you can you seamlessly synchronize your key workflow events with Bramble check-ins, inventory volumes, quality scores and much more.
We designed the Bramble API around REST principles influenced by the JSON API specification.
This version of our API reference is auto-generated from an Open API specification.
API Endpoint
All API calls must be made to https://api.SUBDOMAIN.brmbl.io/v1
.
JSON-only
All responses will be in JSON. Input
data passed through the request body can be form-encoded or JSON-encoded. If
using a JSON body, please specify the Content-Type
header as
application/json
.
In the API dates are represented as ISO8601. Each entity like entries or groups has a unique integer ID.
Pagination
The Bramble API supports two ways to paginate collections. The most common way to paginate is through offset-based pagination which is often used where the list of items is of a fixed, predetermined length.
In most cases we will paginate requests returning more than 100 results. You can
control pagination with the page
parameter (object). Pages start at
1
and the first page will be returned if no page is specified.
curl https://api.YOURDOMAIN.brmbl.io/v1/groups?page[number]=3&page[size]=10 \
-H "authorization: Bearer ACCESS_TOKEN"
Most endpoints will return meta.pagination
information in the response (see the example on the right).
"meta": {
"pagination": {
"page_number": 1,
"page_size": 25,
"total_entries": 1,
"total_pages": 1
}
}
In some cases an API endpoint supports marker-based pagination, either as an alternative to offset-based pagination or as a full replacement. Marker-based pagination is often used in cases where the length of the total set of items is either changing frequently, or where the total length might not be known upfront.
Sorting
Where an API returns a collection of items it often supports sorting of API responses.
Use the sort
query parameters to sort the collection. Use a hyphen prefix to sort in
Both the field and the direction to sort on is defined by the sort
query
parameter. Check the API endpoint's documentation for the possible options for
this value.
curl https://api.YOURDOMAIN.brmbl.io/v1/users/?sort=full_name,-inserted_at \
-H "authorization: Bearer ACCESS_TOKEN"
Working with Dates
When working with dates, the Bramble API endpoints expect the following:
Dates in ISO 8601 format (YYYY-MM-DD
). For example, date_happened
in the TaskEvent type.
Timestamps (date and time) in RFC 3339 format. For example, a UTC time
2022-01-15T00:00:00Z
.
An offset from UTC time indicates a time zone, such as
2013-01-15T00:00:00-08:00
(8 hours behind UTC time).
Clients must account for daylight savings time when providing offset dates.
Versioning
We follow the Global URL versioning scheme. This means that major changes to our API will be versioned in order to maintain backwards compatibility with existing integrations.
In order to notify consumers of upcoming upgrades, deprecated operations will be annotated using the OpenAPI spec
Getting Help or Contributing
We've made this document open source. Please report any issues or suggestions in the API doc issues. Any pull requests to improve this document are welcome too! If you need help using the API or need to discuss anything sensitive please message us at support@brmbl.io.
Errors
Each API call returns an HTTP status code that reflects the nature of the response. We have done our best to follow the HTTP status code conventions.
Any request that did not succeed will return a 4xx or 5xx error. The 4xx range means there was a problem with the request, like a missing parameter. The 5xx range means that something went wrong on our end.
Codes
The Bramble API returns the following HTTP status codes:
Code | Description |
---|---|
200 OK | Request succeeded |
201 Created | A resource was created |
204 No Content | Request succeeded but there is no response body |
400 Bad Request | Invalid request parameters |
401 Unauthorized | Incorrect or missing API key |
403 Forbidden | You do not have permission to view a resource or perform an action |
404 Not Found | The specified resource could not be found |
409 Conflict | The requested change cannot be done, because it conflicts with the Brmbl internal state of the resource |
422 Unprocessable Entity | The request body you sent is missing fields / fields have the wrong data type |
500 Internal Server Error | There was a problem on our end |
Response format
Error responses are separated into two categories:
- General errors like Internal Server Error or Authentication Error
- Client input related errors like JSON Error or Conflict Error
All error responses will have an errors
array field, containing objects with these attributes:
Parameter | Description |
---|---|
detail | Explanation of the error |
source.pointer | Available when a specific request parameter was responsible |
title | A concise summary of the error |
type | (If available), a machine readable type of error, for example "AUTHENTICATION_FAILED" |
Rate Limits
Each request is tracked by its unique IP. The limit is 1000 requests per minute. Hitting the limit will block further requests for that minute.
Please contact your Account Manager or Customer Success to request a limit increase.
Authentication
All calls to Bramble APIs are authenticated with an API key that an admin can generate within your Bramble app. Allowed resources can be customized per API key.
Please keep your API keys private.
API Keys created should never be exposed in untrusted contexts. Never put an API Key in client-side JavaScript, embed it in a web page, or otherwise allow users to access it. If an API Key is exposed, lost, or stolen, then it is compromised. Revoke compromised keys immediately from your Integration Settings page to prevent unauthorized access.
apiKey
Header: Authorization
Enter the token with the Bearer:
prefix, e.g. "Bearer brmbl_ZLXZ4PYn_E34CJQSRtlmf0CXLsKFjMOf7".
Checkins
Creates a check-in for a user
Request: Create a check-in
curl -X POST https://api.COMPANY.brmbl.io/v1/checkins \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_AxVo6hvi_eMZj0pi7LiYCsYO4QWHkbtqH" \
-d @- << EOF
{
"date": "2022-02-23",
"user_id": "27786",
"work_location": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:24Z",
"updated_at": "2025-01-14T13:24:24Z",
"work_location": null
},
"id": "33536",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33536"
},
"relationships": {
"user": {
"data": {
"id": "27786",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27786",
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33536/relationships/user"
}
}
},
"type": "checkins"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33536"
}
}
Request: Create a check-in
curl -X POST https://api.COMPANY.brmbl.io/v1/checkins \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_9fOBBJNJ_triPqt1jeaqn1mix6wUx0nF7" \
-d @- << EOF
{
"date": "2022-02-23",
"user_id": "27788",
"work_location": "distributed"
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:24Z",
"updated_at": "2025-01-14T13:24:24Z",
"work_location": "distributed"
},
"id": "33537",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33537"
},
"relationships": {
"user": {
"data": {
"id": "27788",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27788",
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33537/relationships/user"
}
}
},
"type": "checkins"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33537"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Invalid format. Expected :date",
"source": {
"pointer": "/date"
},
"title": "Invalid value"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "already entered on this day",
"source": {
"pointer": ":date"
},
"title": "Conflict"
}
]
}
You can create a check-in for a user per day.
A Check-in is used to track where you plan on doing work, and is also referenced in how we create the check-in items.
Request
POST /v1/checkins
Responses
Status | Description | Schema |
---|---|---|
201 | Checkin | |
401 | Authentication Error | |
404 | Not Found Error | |
409 | Conflict | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Fetch a check-in by ID
Request: Returns a check-in
curl -X GET https://api.COMPANY.brmbl.io/v1/checkins/id/33540 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_PTV0mxfv_vTrVF8X31ZA19JgMAjyL7jOO" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2020-01-01",
"inserted_at": "2025-01-14T13:24:24Z",
"updated_at": "2025-01-14T13:24:24Z",
"work_location": "office"
},
"id": "33540",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33540"
},
"relationships": {
"user": {
"data": {
"id": "27794",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27794",
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33540/relationships/user"
}
}
},
"type": "checkins"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33540"
}
}
Returns the check-in identified by an internal Bramble ID.
Request
GET /v1/checkins/id/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
Check-in ID | path | integer | true | 233 | |
include |
Comma separated list of relationships to include. | query | array | false | user | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Checkin | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Fetch a check-in by user ID, and date
Request: Returns a check-in by user id and date
curl -X GET https://api.COMPANY.brmbl.io/v1/checkins/user/27780/date/2020-01-01 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_nLDUX0xO_ehDdzsesEs3wrpb2og2fuauT" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2020-01-01",
"inserted_at": "2025-01-14T13:24:24Z",
"updated_at": "2025-01-14T13:24:24Z",
"work_location": "office"
},
"id": "33532",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33532"
},
"relationships": {
"user": {
"data": {
"id": "27780",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27780",
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33532/relationships/user"
}
}
},
"type": "checkins"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkins/33532"
}
}
Response: 404 Not Found
{
"errors": [
{
"code": "40401",
"detail": "Could not find check-in with user_id: -1 and date: 2020-01-01",
"status": "404",
"title": "Resource Not Found"
}
]
}
Returns the check-in identified by an internal Bramble user ID, and date.
Request
GET /v1/checkins/user/{user_id}/date/{date}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
user_id |
User ID | path | integer | true | 233 | |
date |
Date | path | string | true | 2022-01-01 | |
include |
Comma separated list of relationships to include. | query | array | false | user | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Checkin | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Checkin Items
Creates a user's check-in item
Request: Create a production task check-in item
curl -X POST https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_Dm5sqkJj_N6a5idZdKxffs3Gy9mdo8K9P" \
-d @- << EOF
{
"date": "2022-02-23",
"volume": 1,
"user_id": "27481",
"production_task_id": 8933,
"checkin_id": "33433",
"cost_category_id": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:21Z",
"minutes": "10.00",
"updated_at": "2025-01-14T13:24:21Z",
"volume": 1
},
"id": "63542",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63542"
},
"relationships": {
"checkin": {
"data": {
"id": "33433",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33433",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63542/relationships/checkin"
}
},
"production_task": {
"data": {
"id": "8933",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8933",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63542/relationships/production_task"
}
},
"user": {
"data": {
"id": "27481",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27481",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63542/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63542"
}
}
Request: Create a production task check-in item with cost category
curl -X POST https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_kLIghLM1_jTDyYPKiSd7MmMz9JRlijsif" \
-d @- << EOF
{
"date": "2022-02-23",
"volume": 1,
"user_id": "27457",
"production_task_id": 8923,
"checkin_id": "33416",
"cost_category_id": "2174"
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:20Z",
"minutes": "10.00",
"updated_at": "2025-01-14T13:24:20Z",
"volume": 1
},
"id": "63529",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63529"
},
"relationships": {
"checkin": {
"data": {
"id": "33416",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33416",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63529/relationships/checkin"
}
},
"cost_category": {
"data": {
"id": "2174",
"type": "cost_categories"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/cost_categories/2174",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63529/relationships/cost_category"
}
},
"production_task": {
"data": {
"id": "8923",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8923",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63529/relationships/production_task"
}
},
"user": {
"data": {
"id": "27457",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27457",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63529/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63529"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Failed to cast value to one of: no schemas validate",
"source": {
"pointer": "/"
},
"title": "Invalid value"
},
{
"detail": "Invalid format. Expected :date",
"source": {
"pointer": "/date"
},
"title": "Invalid value"
},
{
"detail": "Missing field: supporting_task_id",
"source": {
"pointer": "/supporting_task_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: minutes",
"source": {
"pointer": "/minutes"
},
"title": "Invalid value"
},
{
"detail": "Missing field: friction_type_id",
"source": {
"pointer": "/friction_type_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: minutes",
"source": {
"pointer": "/minutes"
},
"title": "Invalid value"
},
{
"detail": "Missing field: leave_type_id",
"source": {
"pointer": "/leave_type_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: minutes",
"source": {
"pointer": "/minutes"
},
"title": "Invalid value"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "already entered on this day",
"source": {
"pointer": ":production_task_id"
},
"title": "Conflict"
}
]
}
Request: Create a supporting task check-in item
curl -X POST https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_NNPG5tFQ_G5sNS2Aa6ojmAQK6GkzYtqCp" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27530",
"supporting_task_id": "5752",
"checkin_id": "33469"
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:21Z",
"minutes": "450.00",
"updated_at": "2025-01-14T13:24:21Z",
"volume": null
},
"id": "63579",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63579"
},
"relationships": {
"checkin": {
"data": {
"id": "33469",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33469",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63579/relationships/checkin"
}
},
"supporting_task": {
"data": {
"id": "5752",
"type": "supporting_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/5752",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63579/relationships/supporting_task"
}
},
"user": {
"data": {
"id": "27530",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27530",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63579/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63579"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Failed to cast value to one of: no schemas validate",
"source": {
"pointer": "/"
},
"title": "Invalid value"
},
{
"detail": "Missing field: production_task_id",
"source": {
"pointer": "/production_task_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: volume",
"source": {
"pointer": "/volume"
},
"title": "Invalid value"
},
{
"detail": "Invalid format. Expected :date",
"source": {
"pointer": "/date"
},
"title": "Invalid value"
},
{
"detail": "Missing field: friction_type_id",
"source": {
"pointer": "/friction_type_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: leave_type_id",
"source": {
"pointer": "/leave_type_id"
},
"title": "Invalid value"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "already entered on this day",
"source": {
"pointer": ":supporting_task_id"
},
"title": "Conflict"
}
]
}
Request: Create a friction type check-in item
curl -X POST https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_hzc42OJU_EOQ74BygisMhc2Ef9aTZBiSG" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27519",
"checkin_id": "33461",
"friction_type_id": "3626"
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:21Z",
"minutes": "450.00",
"updated_at": "2025-01-14T13:24:21Z",
"volume": null
},
"id": "63573",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63573"
},
"relationships": {
"checkin": {
"data": {
"id": "33461",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33461",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63573/relationships/checkin"
}
},
"friction_type": {
"data": {
"id": "3626",
"type": "friction_types"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/friction_types/3626",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63573/relationships/friction_type"
}
},
"user": {
"data": {
"id": "27519",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27519",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63573/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63573"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Failed to cast value to one of: no schemas validate",
"source": {
"pointer": "/"
},
"title": "Invalid value"
},
{
"detail": "Missing field: production_task_id",
"source": {
"pointer": "/production_task_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: volume",
"source": {
"pointer": "/volume"
},
"title": "Invalid value"
},
{
"detail": "Missing field: supporting_task_id",
"source": {
"pointer": "/supporting_task_id"
},
"title": "Invalid value"
},
{
"detail": "Invalid format. Expected :date",
"source": {
"pointer": "/date"
},
"title": "Invalid value"
},
{
"detail": "Missing field: leave_type_id",
"source": {
"pointer": "/leave_type_id"
},
"title": "Invalid value"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "already entered on this day",
"source": {
"pointer": ":friction_type_id"
},
"title": "Conflict"
}
]
}
Request: Create a leave type check-in item
curl -X POST https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_hzT4NVJ8_lMJE80tPD4AGt1aiCgF7aLxO" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27397",
"checkin_id": "33374",
"leave_type_id": "2078"
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:19Z",
"minutes": "450.00",
"updated_at": "2025-01-14T13:24:19Z",
"volume": null
},
"id": "63488",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63488"
},
"relationships": {
"checkin": {
"data": {
"id": "33374",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33374",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63488/relationships/checkin"
}
},
"leave_type": {
"data": {
"id": "2078",
"type": "leave_types"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/leave_types/2078",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63488/relationships/leave_type"
}
},
"user": {
"data": {
"id": "27397",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27397",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63488/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63488"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Failed to cast value to one of: no schemas validate",
"source": {
"pointer": "/"
},
"title": "Invalid value"
},
{
"detail": "Missing field: production_task_id",
"source": {
"pointer": "/production_task_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: volume",
"source": {
"pointer": "/volume"
},
"title": "Invalid value"
},
{
"detail": "Missing field: supporting_task_id",
"source": {
"pointer": "/supporting_task_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: friction_type_id",
"source": {
"pointer": "/friction_type_id"
},
"title": "Invalid value"
},
{
"detail": "Invalid format. Expected :date",
"source": {
"pointer": "/date"
},
"title": "Invalid value"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "already entered on this day",
"source": {
"pointer": ":leave_type_id"
},
"title": "Conflict"
}
]
}
Creates user's check-in item for a day, could be a production task, supporting task, leave type or friction type.
Request
POST /v1/checkin_items
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
x-lineage-data |
Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. | header | string | false |
Responses
Status | Description | Schema |
---|---|---|
201 | Checkin Item Response | |
401 | Authentication Error | |
404 | Not Found Error | |
409 | Conflict | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Deletes a user's check-in item
Request: Delete a production task check-in item.
curl -X DELETE https://api.COMPANY.brmbl.io/v1/checkin_items/63533 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_TZmnPG8S_SpBlekYu5P53Lh3bGAMLaikm" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2020-01-01",
"inserted_at": "2025-01-14T13:24:20Z",
"minutes": "150.00",
"updated_at": "2025-01-14T13:24:20Z",
"volume": 15
},
"id": "63533",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63533"
},
"relationships": {
"checkin": {
"data": {
"id": "33421",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33421",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63533/relationships/checkin"
}
},
"production_task": {
"data": {
"id": "8926",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8926",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63533/relationships/production_task"
}
},
"user": {
"data": {
"id": "27465",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27465",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63533/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63533"
}
}
Soft-Deletes user's check-in item for a day.
Request
DELETE /v1/checkin_items/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
x-lineage-data |
Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. | header | string | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Checkin Item Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Retrieve a check-in item.
Request: Returns a check-in item
curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/63513 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_aOOV58TJ_quZohulQsCPbBtZAQ59Msni4" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2020-01-01",
"inserted_at": "2025-01-14T13:24:20Z",
"minutes": "150.00",
"updated_at": "2025-01-14T13:24:20Z",
"volume": 15
},
"id": "63513",
"links": {
"self": "http://company.brmbl.io/v1/checkin_items/63513"
},
"relationships": {},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://company.brmbl.io/v1/checkin_items/63513"
}
}
Request: Returns a check-in item
curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/63504?include=production_task \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_XzOgfamn_lqRRGOlVzT6rF6twaiL2UXOG" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2020-01-01",
"inserted_at": "2025-01-14T13:24:20Z",
"minutes": "150.00",
"updated_at": "2025-01-14T13:24:20Z",
"volume": 15
},
"id": "63504",
"links": {
"self": "http://company.brmbl.io/v1/checkin_items/63504"
},
"relationships": {
"production_task": {
"data": {
"id": "8909",
"type": "production_tasks"
},
"links": {
"related": "http://company.brmbl.io/v1/production_tasks/8909",
"self": "http://company.brmbl.io/v1/checkin_items/63504/relationships/production_task"
}
}
},
"type": "checkin_items"
},
"included": [
{
"attributes": {
"description": "pt-1YzNtYf4",
"entry_mode": "AUTO",
"improvement_category": "rpa",
"inserted_at": "2025-01-14T13:24:20Z",
"name": "TaskB",
"state": "detached",
"updated_at": "2025-01-14T13:24:20Z"
},
"id": "8909",
"links": {
"self": "http://company.brmbl.io/v1/production_tasks/8909"
},
"relationships": {},
"type": "production_tasks"
}
],
"links": {
"self": "http://company.brmbl.io/v1/checkin_items/63504"
}
}
Request: Returns a check-in item
curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/63505?include=supporting_task \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_XzOgfamn_lqRRGOlVzT6rF6twaiL2UXOG" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2020-01-01",
"inserted_at": "2025-01-14T13:24:20Z",
"minutes": "60.00",
"updated_at": "2025-01-14T13:24:20Z",
"volume": null
},
"id": "63505",
"links": {
"self": "http://company.brmbl.io/v1/checkin_items/63505"
},
"relationships": {
"supporting_task": {
"data": {
"id": "5725",
"type": "supporting_tasks"
},
"links": {
"related": "http://company.brmbl.io/v1/supporting_tasks/5725",
"self": "http://company.brmbl.io/v1/checkin_items/63505/relationships/supporting_task"
}
}
},
"type": "checkin_items"
},
"included": [
{
"attributes": {
"category": "meet",
"description": "ilfGXCIP",
"inserted_at": "2025-01-14T13:24:20Z",
"name": "ilfGXCIP",
"state": "active",
"updated_at": "2025-01-14T13:24:20Z"
},
"id": "5725",
"links": {
"self": "http://company.brmbl.io/v1/supporting_tasks/5725"
},
"relationships": {},
"type": "supporting_tasks"
}
],
"links": {
"self": "http://company.brmbl.io/v1/checkin_items/63505"
}
}
Request: Returns a check-in item
curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/63506?include=friction_type \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_XzOgfamn_lqRRGOlVzT6rF6twaiL2UXOG" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2020-01-01",
"inserted_at": "2025-01-14T13:24:20Z",
"minutes": "30.00",
"updated_at": "2025-01-14T13:24:20Z",
"volume": null
},
"id": "63506",
"links": {
"self": "http://company.brmbl.io/v1/checkin_items/63506"
},
"relationships": {
"friction_type": {
"data": {
"id": "3617",
"type": "friction_types"
},
"links": {
"related": "http://company.brmbl.io/v1/friction_types/3617",
"self": "http://company.brmbl.io/v1/checkin_items/63506/relationships/friction_type"
}
}
},
"type": "checkin_items"
},
"included": [
{
"attributes": {
"category": "interruption",
"description": "OjIC0XtW",
"inserted_at": "2025-01-14T13:24:20Z",
"name": "OjIC0XtW",
"state": "active",
"updated_at": "2025-01-14T13:24:20Z"
},
"id": "3617",
"links": {
"self": "http://company.brmbl.io/v1/friction_types/3617"
},
"relationships": {},
"type": "friction_types"
}
],
"links": {
"self": "http://company.brmbl.io/v1/checkin_items/63506"
}
}
Request: Returns a check-in item
curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/63507?include=leave_type \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_XzOgfamn_lqRRGOlVzT6rF6twaiL2UXOG" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2020-01-01",
"inserted_at": "2025-01-14T13:24:20Z",
"minutes": "480.00",
"updated_at": "2025-01-14T13:24:20Z",
"volume": null
},
"id": "63507",
"links": {
"self": "http://company.brmbl.io/v1/checkin_items/63507"
},
"relationships": {
"leave_type": {
"data": {
"id": "2080",
"type": "leave_types"
},
"links": {
"related": "http://company.brmbl.io/v1/leave_types/2080",
"self": "http://company.brmbl.io/v1/checkin_items/63507/relationships/leave_type"
}
}
},
"type": "checkin_items"
},
"included": [
{
"attributes": {
"category": "planned_paid",
"description": "ZxhJxQ95",
"inserted_at": "2025-01-14T13:24:20Z",
"name": "ZxhJxQ95",
"state": "active",
"updated_at": "2025-01-14T13:24:20Z"
},
"id": "2080",
"links": {
"self": "http://company.brmbl.io/v1/leave_types/2080"
},
"relationships": {},
"type": "leave_types"
}
],
"links": {
"self": "http://company.brmbl.io/v1/checkin_items/63507"
}
}
You can fetch the details of a single item.
Request
GET /v1/checkin_items/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
Checkin item ID to retrieve. | path | integer | true | 233 | |
include |
Comma separated list of relationships to include. | query | array | false | user | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Checkin Item Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
List all check-in items
Request: List of check-in items (filtered by date)
curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items?date=2020-01-02&page[number]=1&page[size]=10&sort=date&fields[checkin_items]=volume,date \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_vN16Og9z_LKcGp5hWeYIcFeXUwiUKzJis" \
Response: 200 OK
{
"data": [
{
"attributes": {
"date": "2020-01-02",
"volume": 15
},
"id": "63492",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63492"
},
"relationships": {},
"type": "checkin_items"
},
{
"attributes": {
"date": "2020-01-02",
"volume": 20
},
"id": "63493",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63493"
},
"relationships": {},
"type": "checkin_items"
}
],
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items?date=2020-01-02&fields%5Bcheckin_items%5D=volume%2Cdate&page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=date"
},
"meta": {
"pagination": {
"page_number": 1,
"page_size": 10,
"total_entries": 2,
"total_pages": 1
}
}
}
You can fetch a list of all check-in items.
Request
GET /v1/checkin_items
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
date |
Filter results for this date | query | string | false | 2022-02-28 | |
user_id |
Filter results with this Bramble user ID | query | integer | false | 12 | |
page |
query | Page | false | |||
sort |
Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. | query | array | false | -date,-volume | |
include |
Comma separated list of relationships to include. | query | array | false | user | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | CheckinItems | |
401 | Authentication Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Updates a user's check-in item
Request: Update a production task check-in item. Note that this will replace the existing values.
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items/63575 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_0MFG7ATg_W1fnrbqYhg1TqXQkoMEQ0lNx" \
-d @- << EOF
{
"date": "2022-02-23",
"volume": 1,
"user_id": "27524",
"production_task_id": 8951,
"checkin_id": "33465",
"cost_category_id": null
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:21Z",
"minutes": "10.00",
"updated_at": "2025-01-14T13:24:21Z",
"volume": 1
},
"id": "63575",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63575"
},
"relationships": {
"checkin": {
"data": {
"id": "33465",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33465",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63575/relationships/checkin"
}
},
"production_task": {
"data": {
"id": "8951",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8951",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63575/relationships/production_task"
}
},
"user": {
"data": {
"id": "27524",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27524",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63575/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63575"
}
}
Request: Update a production task check-in item with a cost category. Note that this will replace the existing values.
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items/63499 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_Ll6YVwgB_LHwhgwolhlQMygbkseljaFzf" \
-d @- << EOF
{
"date": "2022-02-23",
"volume": 1,
"user_id": "27417",
"production_task_id": 8905,
"checkin_id": "33388",
"cost_category_id": "2168"
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:19Z",
"minutes": "10.00",
"updated_at": "2025-01-14T13:24:19Z",
"volume": 1
},
"id": "63499",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63499"
},
"relationships": {
"checkin": {
"data": {
"id": "33388",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33388",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63499/relationships/checkin"
}
},
"cost_category": {
"data": {
"id": "2168",
"type": "cost_categories"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/cost_categories/2168",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63499/relationships/cost_category"
}
},
"production_task": {
"data": {
"id": "8905",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8905",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63499/relationships/production_task"
}
},
"user": {
"data": {
"id": "27417",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27417",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63499/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63499"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Failed to cast value to one of: no schemas validate",
"source": {
"pointer": "/"
},
"title": "Invalid value"
},
{
"detail": "Invalid format. Expected :date",
"source": {
"pointer": "/date"
},
"title": "Invalid value"
},
{
"detail": "Missing field: supporting_task_id",
"source": {
"pointer": "/supporting_task_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: minutes",
"source": {
"pointer": "/minutes"
},
"title": "Invalid value"
},
{
"detail": "Missing field: friction_type_id",
"source": {
"pointer": "/friction_type_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: minutes",
"source": {
"pointer": "/minutes"
},
"title": "Invalid value"
},
{
"detail": "Missing field: leave_type_id",
"source": {
"pointer": "/leave_type_id"
},
"title": "Invalid value"
},
{
"detail": "Missing field: minutes",
"source": {
"pointer": "/minutes"
},
"title": "Invalid value"
}
]
}
Request: Update a supporting task check-in item. Note that this will replace the existing values.
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items/63498 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_iykwGMAv_YjodB0RJ68zr5g08KDcnOmtf" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27414",
"supporting_task_id": "5721",
"checkin_id": "33386"
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:19Z",
"minutes": "450.00",
"updated_at": "2025-01-14T13:24:19Z",
"volume": null
},
"id": "63498",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63498"
},
"relationships": {
"checkin": {
"data": {
"id": "33386",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33386",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63498/relationships/checkin"
}
},
"supporting_task": {
"data": {
"id": "5721",
"type": "supporting_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/5721",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63498/relationships/supporting_task"
}
},
"user": {
"data": {
"id": "27414",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27414",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63498/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63498"
}
}
Request: Update a friction type check-in item. Note that this will replace the existing values.
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items/63551 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_UkoPMHDy_4Xw4baMJs1m33OVpVXyhtolg" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27493",
"checkin_id": "33443",
"friction_type_id": "3624"
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:21Z",
"minutes": "450.00",
"updated_at": "2025-01-14T13:24:21Z",
"volume": null
},
"id": "63551",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63551"
},
"relationships": {
"checkin": {
"data": {
"id": "33443",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33443",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63551/relationships/checkin"
}
},
"friction_type": {
"data": {
"id": "3624",
"type": "friction_types"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/friction_types/3624",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63551/relationships/friction_type"
}
},
"user": {
"data": {
"id": "27493",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27493",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63551/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63551"
}
}
Request: Update a leave type check-in item. Note that this will replace the existing values.
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items/63534 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_tVaWSG8C_u9T9jwDWnTYrsgoQh0vRmYya" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27467",
"checkin_id": "33424",
"leave_type_id": "2085"
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:21Z",
"minutes": "450.00",
"updated_at": "2025-01-14T13:24:21Z",
"volume": null
},
"id": "63534",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63534"
},
"relationships": {
"checkin": {
"data": {
"id": "33424",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33424",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63534/relationships/checkin"
}
},
"leave_type": {
"data": {
"id": "2085",
"type": "leave_types"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/leave_types/2085",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63534/relationships/leave_type"
}
},
"user": {
"data": {
"id": "27467",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27467",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63534/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63534"
}
}
Updates user's check-in item for a day, could be a production task, supporting task, leave type or friction type.
Request
PUT /v1/checkin_items/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
x-lineage-data |
Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. | header | string | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Checkin Item Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Upserts a user's production task, supporting task, leave type or friction type check-in item.
Request: Upserts a not existing production task check-in item will create a new one
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_FoIyS9Vj_FRkP8oFbkBzBfe6sqlPcDJr3" \
-d @- << EOF
{
"date": "2022-02-23",
"volume": 1,
"user_id": "27538",
"production_task_id": 8958,
"checkin_id": "33475",
"cost_category_id": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:22Z",
"minutes": "10.00",
"updated_at": "2025-01-14T13:24:22Z",
"volume": 1
},
"id": "63585",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63585"
},
"relationships": {
"checkin": {
"data": {
"id": "33475",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33475",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63585/relationships/checkin"
}
},
"production_task": {
"data": {
"id": "8958",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8958",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63585/relationships/production_task"
}
},
"user": {
"data": {
"id": "27538",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27538",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63585/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63585"
}
}
Request: Upserts a not existing production task check-in item will create a new one
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_kCRVX3ti_21loux7aM7xurvyi9PXoZ5cH" \
-d @- << EOF
{
"date": "2022-02-23",
"volume": 1,
"user_id": "27554",
"production_task_id": 8965,
"checkin_id": "33487",
"cost_category_id": "2191"
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:22Z",
"minutes": "10.00",
"updated_at": "2025-01-14T13:24:22Z",
"volume": 1
},
"id": "63592",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63592"
},
"relationships": {
"checkin": {
"data": {
"id": "33487",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33487",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63592/relationships/checkin"
}
},
"cost_category": {
"data": {
"id": "2191",
"type": "cost_categories"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/cost_categories/2191",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63592/relationships/cost_category"
}
},
"production_task": {
"data": {
"id": "8965",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8965",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63592/relationships/production_task"
}
},
"user": {
"data": {
"id": "27554",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27554",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63592/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63592"
}
}
Request: Upsert an existing production task check-in item
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_H4vo3A1r_68XX79SUcC88U1cLBHdrFOge" \
-d @- << EOF
{
"date": "2022-02-23",
"volume": 1,
"user_id": "27507",
"production_task_id": 8944,
"checkin_id": "33453",
"cost_category_id": null
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:21Z",
"minutes": "20.00",
"updated_at": "2025-01-14T13:24:22Z",
"volume": 2
},
"id": "63564",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63564"
},
"relationships": {
"checkin": {
"data": {
"id": "33453",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33453",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63564/relationships/checkin"
}
},
"production_task": {
"data": {
"id": "8944",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8944",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63564/relationships/production_task"
}
},
"user": {
"data": {
"id": "27507",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27507",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63564/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63564"
}
}
Response: 409 Conflict
{
"errors": [
{
"detail": "cannot exceed 24h",
"source": {
"pointer": ":minutes"
},
"title": "Conflict"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "cannot exceed 24h",
"source": {
"pointer": ":minutes"
},
"title": "Conflict"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "cannot exceed 24h",
"source": {
"pointer": ":minutes"
},
"title": "Conflict"
}
]
}
Request: When upserting negative volume, if that upsert will bring the entry's volume or minutes equal to or below zero, then a delete will ultimately be performed.
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_bAjbl7gl_CrysQfWubs1gQWWOGr3j3GHF" \
-d @- << EOF
{
"date": "2022-02-23",
"volume": -101,
"user_id": "27486",
"production_task_id": 8935,
"checkin_id": "33437",
"cost_category_id": null
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:21Z",
"minutes": "1000.00",
"updated_at": "2025-01-14T13:24:21Z",
"volume": 100
},
"id": "63546",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63546"
},
"relationships": {
"checkin": {
"data": {
"id": "33437",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33437",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63546/relationships/checkin"
}
},
"production_task": {
"data": {
"id": "8935",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8935",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63546/relationships/production_task"
}
},
"user": {
"data": {
"id": "27486",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27486",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63546/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63546"
}
}
Request: Upserting a non-existent supporting task check-in item will create a new one
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_aMdwwU4C_oY9j7IgGAoCTSNeJeVa1DKT9" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27431",
"supporting_task_id": "5727",
"checkin_id": "33397"
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:20Z",
"minutes": "450.00",
"updated_at": "2025-01-14T13:24:20Z",
"volume": null
},
"id": "63510",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63510"
},
"relationships": {
"checkin": {
"data": {
"id": "33397",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33397",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63510/relationships/checkin"
}
},
"supporting_task": {
"data": {
"id": "5727",
"type": "supporting_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/5727",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63510/relationships/supporting_task"
}
},
"user": {
"data": {
"id": "27431",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27431",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63510/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63510"
}
}
Request: Upsert an existing supporting task check-in item
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_XgdXwScL_N408IYC4QhIeU6Wsq292U27E" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27444",
"supporting_task_id": "5732",
"checkin_id": "33405"
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:20Z",
"minutes": "900.00",
"updated_at": "2025-01-14T13:24:21Z",
"volume": null
},
"id": "63519",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63519"
},
"relationships": {
"checkin": {
"data": {
"id": "33405",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33405",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63519/relationships/checkin"
}
},
"supporting_task": {
"data": {
"id": "5732",
"type": "supporting_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/5732",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63519/relationships/supporting_task"
}
},
"user": {
"data": {
"id": "27444",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27444",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63519/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63519"
}
}
Response: 409 Conflict
{
"errors": [
{
"detail": "cannot exceed 24h",
"source": {
"pointer": ":minutes"
},
"title": "Conflict"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "cannot exceed 24h",
"source": {
"pointer": ":minutes"
},
"title": "Conflict"
}
]
}
Request: When upserting negative minutes, if that upsert will bring the entry's minutes equal to or below zero, then a delete will ultimately be performed.
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_KZ2AonWI_9hFBZsX31yBjgjYn4EpphMxG" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": -6.0,
"user_id": "27568",
"supporting_task_id": "5759",
"checkin_id": "33499"
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:22Z",
"minutes": "5.00",
"updated_at": "2025-01-14T13:24:22Z",
"volume": null
},
"id": "63603",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63603"
},
"relationships": {
"checkin": {
"data": {
"id": "33499",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33499",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63603/relationships/checkin"
}
},
"supporting_task": {
"data": {
"id": "5759",
"type": "supporting_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/5759",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63603/relationships/supporting_task"
}
},
"user": {
"data": {
"id": "27568",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27568",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63603/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63603"
}
}
Request: Upserting a non-existent friction type check-in item will create a new one
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_oJATrch2_NXvFcgvkxlVzcEnAs2EnisPY" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27451",
"checkin_id": "33411",
"friction_type_id": "3620"
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:20Z",
"minutes": "450.00",
"updated_at": "2025-01-14T13:24:20Z",
"volume": null
},
"id": "63526",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63526"
},
"relationships": {
"checkin": {
"data": {
"id": "33411",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33411",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63526/relationships/checkin"
}
},
"friction_type": {
"data": {
"id": "3620",
"type": "friction_types"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/friction_types/3620",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63526/relationships/friction_type"
}
},
"user": {
"data": {
"id": "27451",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27451",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63526/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63526"
}
}
Request: Upsert an existing friction type check-in item
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_sOl5sq9U_C9clI86WSYKrNsRfDWMiXwiy" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27556",
"checkin_id": "33489",
"friction_type_id": "3630"
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:22Z",
"minutes": "900.00",
"updated_at": "2025-01-14T13:24:23Z",
"volume": null
},
"id": "63594",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63594"
},
"relationships": {
"checkin": {
"data": {
"id": "33489",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33489",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63594/relationships/checkin"
}
},
"friction_type": {
"data": {
"id": "3630",
"type": "friction_types"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/friction_types/3630",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63594/relationships/friction_type"
}
},
"user": {
"data": {
"id": "27556",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27556",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63594/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63594"
}
}
Response: 409 Conflict
{
"errors": [
{
"detail": "cannot exceed 24h",
"source": {
"pointer": ":minutes"
},
"title": "Conflict"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "cannot exceed 24h",
"source": {
"pointer": ":minutes"
},
"title": "Conflict"
}
]
}
Request: When upserting negative minutes, if that upsert will bring the entry's minutes equal to or below zero, then a delete will ultimately be performed.
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_NFqZOeNM_tg8OpCqzKlHhlPD7StvcH4iJ" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": -6.0,
"user_id": "27526",
"checkin_id": "33467",
"friction_type_id": "3627"
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:21Z",
"minutes": "5.00",
"updated_at": "2025-01-14T13:24:21Z",
"volume": null
},
"id": "63577",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63577"
},
"relationships": {
"checkin": {
"data": {
"id": "33467",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33467",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63577/relationships/checkin"
}
},
"friction_type": {
"data": {
"id": "3627",
"type": "friction_types"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/friction_types/3627",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63577/relationships/friction_type"
}
},
"user": {
"data": {
"id": "27526",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27526",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63577/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63577"
}
}
Request: Upserting a non-existent leave type check-in item will create a new one
curl -X PUT https://api.COMPANY.brmbl.io/v1/checkin_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_0h552PTf_TbMKm2rOQ2bdbwD7qs5l69u3" \
-d @- << EOF
{
"date": "2022-02-23",
"minutes": 450.0,
"user_id": "27532",
"checkin_id": "33471",
"leave_type_id": "2090"
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:21Z",
"minutes": "450.00",
"updated_at": "2025-01-14T13:24:21Z",
"volume": null
},
"id": "63581",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63581"
},
"relationships": {
"checkin": {
"data": {
"id": "33471",
"type": "checkins"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkins/33471",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63581/relationships/checkin"
}
},
"leave_type": {
"data": {
"id": "2090",
"type": "leave_types"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/leave_types/2090",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63581/relationships/leave_type"
}
},
"user": {
"data": {
"id": "27532",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27532",
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63581/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/checkin_items/63581"
}
}
Response: 409 Conflict
{
"errors": [
{
"detail": "cannot exceed 24h",
"source": {
"pointer": ":minutes"
},
"title": "Conflict"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "cannot exceed 24h",
"source": {
"pointer": ":minutes"
},
"title": "Conflict"
}
]
}
Tries to create a user's production task, supporting task, leave type or friction type check-in item.
If an existing item exists, it will update the existing one instead.
If an upsert tries to update with negative volume
or minutes
, but that would bring minutes
less than or equal to zero, that entry will ultimately be deleted.
Request
PUT /v1/checkin_items
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
x-lineage-data |
Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. | header | string | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Checkin Item Response | |
201 | Checkin Item Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Checkpoint Item
Create a checkpoint item
Request: Create an inventory checkpoint item for a production task date combination and update or create the associated checkpoint
curl -X POST https://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_u1AEGyBQ_iGSi2fU7bqd215WnCjpYYZm6" \
-d @- << EOF
{
"date": "2024-04-09",
"amount": 10,
"production_task_id": 9026
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"amount": 10,
"date": "2024-04-09",
"external_resource_uri": null,
"inserted_at": "2025-01-14T13:24:25Z",
"updated_at": "2025-01-14T13:24:25Z"
},
"id": "445",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/445"
},
"relationships": {
"checkpoint": {
"data": {
"id": "1552",
"type": "checkpoints"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoints/1552",
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/445/relationships/checkpoint"
}
},
"production_task": {
"data": {
"id": "9026",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/9026",
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/445/relationships/production_task"
}
}
},
"type": "checkpoint_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/445"
}
}
You can adjust an Inventory Checkpoint and it's balance by creating a Checkpoint Item.
Request
POST /v1/inventory/checkpoint_items
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
x-external-resource-uri |
Log optional external-resource-uri data with which to build a history. | header | string | false |
Responses
Status | Description | Schema |
---|---|---|
201 | Checkpoint Item | |
401 | Authentication Error | |
404 | Not Found Error | |
409 | Conflict | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Delete an Inventory Checkpoint Item
Request: Deletes a checkpoint item and updates or deletes the associated checkpoint
curl -X DELETE https://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/448 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_0Fg7b5uy_yI8ktBPeeZ02Hu5Otpcjgwho" \
Response: 200 OK
{
"data": {
"attributes": {
"amount": 10,
"date": "2024-01-01",
"external_resource_uri": null,
"inserted_at": "2025-01-14T13:24:25Z",
"updated_at": "2025-01-14T13:24:25Z"
},
"id": "448",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/448"
},
"relationships": {
"production_task": {
"data": {
"id": "9028",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/9028",
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/448/relationships/production_task"
}
}
},
"type": "checkpoint_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/448"
}
}
(Soft-)delete an Inventory Checkpoint Item. The operation will also subtract the amount of the checkpoint item from the balance of the checkpoint.
Request
DELETE /v1/inventory/checkpoint_items/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
The ID of the Inventory Checkpoint Item to delete. | path | integer | true | 123 |
Responses
Status | Description | Schema |
---|---|---|
200 | Checkpoint Item | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Retrieve a Checkpoint Item
Request: Retrieve a checkpoint item
curl -X GET https://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/456 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_4Hy6hC8Q_yB4Hq7jZAqWa3SFuBeXWkfso" \
Response: 200 OK
{
"data": {
"attributes": {
"amount": 30,
"date": "2024-01-01",
"external_resource_uri": null,
"inserted_at": "2025-01-14T13:24:26Z",
"updated_at": "2025-01-14T13:24:26Z"
},
"id": "456",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/456"
},
"relationships": {
"checkpoint": {
"data": {
"id": "1571",
"type": "checkpoints"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoints/1571",
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/456/relationships/checkpoint"
}
},
"production_task": {
"data": {
"id": "9032",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/9032",
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/456/relationships/production_task"
}
}
},
"type": "checkpoint_items"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/456"
}
}
You can fetch the details of a single Checkpoint Item.
Request
GET /v1/inventory/checkpoint_items/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
Checkpoint Item ID | path | integer | true | 233 | |
include |
Comma separated list of relationships to include. | query | array | false | production_task | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Checkpoint Item | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Contact Center
Create an Agent Metric set
Request: Create daily metrics for an agent
curl -X POST https://api.COMPANY.brmbl.io/v1/agent_daily_metrics \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_6dNtd50F_oFfDcyttWDjlzONlMdPdbSQg" \
-d @- << EOF
{
"date": "2022-12-13",
"user_id": 27694,
"conversations": 3,
"idle_seconds": null,
"after_call_work_seconds": null,
"aux_seconds": null,
"available_seconds": null,
"handle_seconds": null,
"hold_seconds": null,
"staffed_seconds": null,
"talk_seconds": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"aux_seconds": null,
"available_seconds": null,
"conversations": 3,
"date": "2022-12-13",
"handle_seconds": null,
"hold_seconds": null,
"idle_seconds": null,
"staffed_seconds": null,
"talk_seconds": null,
"user_id": 27694
},
"id": "728",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/728"
},
"relationships": {},
"type": "agent_daily_metrics"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/728"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Invalid format. Expected :date",
"source": {
"pointer": "/date"
},
"title": "Invalid value"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "Agent data already exists for the given day",
"source": {
"pointer": ":date"
},
"title": "Conflict"
}
]
}
You can record several agent metrics on a day-by-day basis from an Automatic Call Distribution (ACD) system.
Request
POST /v1/agent_daily_metrics
Responses
Status | Description | Schema |
---|---|---|
201 | Agent Daily Metrics Response | |
401 | Authentication Error | |
404 | Not Found Error | |
409 | Conflict | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Create an Agent Queue Metric set
Request: Create queue metrics for an agent
curl -X POST https://api.COMPANY.brmbl.io/v1/agent_queue_metrics \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_wfNkjnCg_eUzXi4VZ7QOOLJYhrt1eOjDS" \
-d @- << EOF
{
"date": "2022-12-13",
"user_id": 27858,
"production_task_id": 9019,
"entry_id": 63642,
"quality_score": 0.8,
"conversations": 3,
"quality_score_id": 3455,
"after_call_work_seconds": null,
"handle_seconds": null,
"hold_seconds": null,
"talk_seconds": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"conversations": 3,
"date": "2022-12-13",
"entry_id": 63642,
"handle_seconds": null,
"hold_seconds": null,
"production_task_id": 9019,
"quality": 0.8,
"talk_seconds": null,
"user_id": 27858
},
"id": "1124",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1124"
},
"relationships": {
"checkin_item": {
"data": {
"id": "63642",
"type": "checkin_items"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkin_items/63642",
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1124/relationships/checkin_item"
}
},
"quality_score": {
"data": {
"id": "3455",
"type": "quality_scores"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/quality_scores/3455",
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1124/relationships/quality_score"
}
}
},
"type": "agent_queue_metrics"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1124"
}
}
Request: Create queue metrics for an agent
curl -X POST https://api.COMPANY.brmbl.io/v1/agent_queue_metrics \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_Q7kr9JH0_SdZsIfelUa1KUFyMLqkZAft9" \
-d @- << EOF
{
"date": "2022-12-13",
"user_id": 27856,
"production_task_id": 9018,
"entry_id": 63641,
"quality_score": 0.87,
"conversations": 3,
"quality_score_id": 3454,
"after_call_work_seconds": null,
"handle_seconds": null,
"hold_seconds": null,
"talk_seconds": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"conversations": 3,
"date": "2022-12-13",
"entry_id": 63641,
"handle_seconds": null,
"hold_seconds": null,
"production_task_id": 9018,
"quality": 0.87,
"talk_seconds": null,
"user_id": 27856
},
"id": "1123",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1123"
},
"relationships": {
"checkin_item": {
"data": {
"id": "63641",
"type": "checkin_items"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkin_items/63641",
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1123/relationships/checkin_item"
}
},
"quality_score": {
"data": {
"id": "3454",
"type": "quality_scores"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/quality_scores/3454",
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1123/relationships/quality_score"
}
}
},
"type": "agent_queue_metrics"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1123"
}
}
Request: Create queue metrics for an agent
curl -X POST https://api.COMPANY.brmbl.io/v1/agent_queue_metrics \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_qkuMagnk_I8reuQTqB9cOtvWrGPvPVcS9" \
-d @- << EOF
{
"date": "2022-12-13",
"user_id": 27854,
"production_task_id": 9017,
"entry_id": 63640,
"quality_score": 0.8,
"conversations": 3,
"quality_score_id": 3453,
"after_call_work_seconds": null,
"handle_seconds": null,
"hold_seconds": null,
"talk_seconds": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"conversations": 3,
"date": "2022-12-13",
"entry_id": 63640,
"handle_seconds": null,
"hold_seconds": null,
"production_task_id": 9017,
"quality": 0.8,
"talk_seconds": null,
"user_id": 27854
},
"id": "1122",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1122"
},
"relationships": {
"checkin_item": {
"data": {
"id": "63640",
"type": "checkin_items"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkin_items/63640",
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1122/relationships/checkin_item"
}
},
"quality_score": {
"data": {
"id": "3453",
"type": "quality_scores"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/quality_scores/3453",
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1122/relationships/quality_score"
}
}
},
"type": "agent_queue_metrics"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1122"
}
}
You can record several agent metrics on a per-queue, per-day basis from an Automatic Call Distribution (ACD) system.
Request
POST /v1/agent_queue_metrics
Responses
Status | Description | Schema |
---|---|---|
201 | Agent Queue Metrics Response | |
401 | Authentication Error | |
404 | Not Found Error | |
409 | Conflict | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Create a Queue Metric set
Request: Create daily metrics for a queue
curl -X POST https://api.COMPANY.brmbl.io/v1/queue_daily_metrics \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_xjEoG8b5_DEKm2x8ZXNz8IKR4QdBLYtLi" \
-d @- << EOF
{
"date": "2022-12-13",
"production_task_id": 9034,
"service_level": 0.6,
"conversations": 3,
"after_call_work_seconds": null,
"handle_seconds": null,
"hold_seconds": null,
"talk_seconds": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"conversations": 3,
"date": "2022-12-13",
"handle_seconds": null,
"hold_seconds": null,
"queue_id": 9034,
"talk_seconds": null
},
"id": "463",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/463"
},
"relationships": {
"service_level": {
"data": {
"id": "696",
"type": "service_levels"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/service_levels/696",
"self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/463/relationships/service_level"
}
}
},
"type": "queue_daily_metrics"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/463"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Invalid format. Expected :date",
"source": {
"pointer": "/date"
},
"title": "Invalid value"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "Queue data already exists for the given day",
"source": {
"pointer": ":date"
},
"title": "Conflict"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "You have to change the Production Task to Contact Center type",
"source": {
"pointer": ":production_task_id"
},
"title": "Production Task not of type Contact Center"
}
]
}
Use this endpoint to import contact-center queue-data on a day-by-day basis.
Request
POST /v1/queue_daily_metrics
Responses
Status | Description | Schema |
---|---|---|
201 | Agent Queue Metrics Response | |
401 | Authentication Error | |
404 | Not Found Error | |
409 | Conflict | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Delete an Agent Daily Metrics set
Request: Deletes agent metrics and updates or deletes the associated entry
curl -X DELETE https://api.COMPANY.brmbl.io/v1/agent_daily_metrics/733 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_RNJi6evp_KiU7Wz0Zi0FzfMRZaWETSnko" \
Response: 200 OK
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"aux_seconds": null,
"available_seconds": null,
"conversations": 403,
"date": "2025-01-14",
"handle_seconds": null,
"hold_seconds": null,
"idle_seconds": null,
"staffed_seconds": null,
"talk_seconds": null,
"user_id": 27704
},
"id": "733",
"links": {
"self": "http://company.brmbl.io/v1/agent_daily_metrics/733"
},
"relationships": {},
"type": "agent_daily_metrics"
},
"included": [],
"links": {
"self": "http://company.brmbl.io/v1/agent_daily_metrics/733"
}
}
Response: 404 Not Found
{
"errors": [
{
"code": "40401",
"detail": "The given agent daily metrics could not be found.",
"status": "404",
"title": "Agent Daily Metrics Not Found"
}
]
}
Delete an Agent Daily Metrics set.
Request
DELETE /v1/agent_daily_metrics/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
The ID of the agent daily metrics to delete. | path | integer | true | 123 |
Responses
Status | Description | Schema |
---|---|---|
200 | Agent Daily Metrics Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Delete an Agent Queue Metrics set
Request: Deletes an agent queue dataset and updates the entry
curl -X DELETE https://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1121 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_1YQ3SY5A_M7Gu4gCsksjsy670nOppbpVF" \
Response: 200 OK
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"conversations": 11,
"date": "2025-01-13",
"entry_id": null,
"handle_seconds": null,
"hold_seconds": null,
"production_task_id": 9015,
"quality": null,
"talk_seconds": 500,
"user_id": 27850
},
"id": "1121",
"links": {
"self": "http://company.brmbl.io/v1/agent_queue_metrics/1121"
},
"relationships": {},
"type": "agent_queue_metrics"
},
"included": [],
"links": {
"self": "http://company.brmbl.io/v1/agent_queue_metrics/1121"
}
}
Response: 404 Not Found
{
"errors": [
{
"code": "40401",
"detail": "The given agent queue metrics could not be found.",
"status": "404",
"title": "Agent Queue Metrics Not Found"
}
]
}
Delete an Agent Queue Metrics set.
Request
DELETE /v1/agent_queue_metrics/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
The ID of the agent queue metrics to delete. | path | integer | true | 233 |
Responses
Status | Description | Schema |
---|---|---|
200 | Agent Queue Metrics Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Delete a Queue Daily Metrics set
Request: Deletes queue metrics and updates or deletes the associated entry
curl -X DELETE https://api.COMPANY.brmbl.io/v1/queue_daily_metrics/464 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_0QL0Upwq_6JIHLj6mtia7OuiIlOoPsVbF" \
Response: 200 OK
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"conversations": 401,
"date": "2025-01-14",
"handle_seconds": null,
"hold_seconds": null,
"queue_id": 9035,
"talk_seconds": null
},
"id": "464",
"links": {
"self": "http://company.brmbl.io/v1/queue_daily_metrics/464"
},
"relationships": {},
"type": "queue_daily_metrics"
},
"included": [],
"links": {
"self": "http://company.brmbl.io/v1/queue_daily_metrics/464"
}
}
Response: 404 Not Found
{
"errors": [
{
"code": "40401",
"detail": "The given queue daily metrics could not be found.",
"status": "404",
"title": "Queue Daily Metrics Not Found"
}
]
}
Delete a Queue Daily Metrics set.
Request
DELETE /v1/queue_daily_metrics/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
The ID of the queue daily metrics to delete. | path | integer | true | 123 |
Responses
Status | Description | Schema |
---|---|---|
200 | Agent Queue Metrics Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Upserts an Agent Metric set
Request: Create daily metrics for an agent
curl -X PUT https://api.COMPANY.brmbl.io/v1/agent_daily_metrics \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_xGp7JXOD_Lv2hY50zL5QUJPTcNv8fiYCM" \
-d @- << EOF
{
"date": "2022-12-13",
"user_id": 27696,
"conversations": 3,
"idle_seconds": null,
"after_call_work_seconds": null,
"aux_seconds": null,
"available_seconds": null,
"handle_seconds": null,
"hold_seconds": null,
"staffed_seconds": null,
"talk_seconds": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"aux_seconds": null,
"available_seconds": null,
"conversations": 3,
"date": "2022-12-13",
"handle_seconds": null,
"hold_seconds": null,
"idle_seconds": null,
"staffed_seconds": null,
"talk_seconds": null,
"user_id": 27696
},
"id": "729",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/729"
},
"relationships": {},
"type": "agent_daily_metrics"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/729"
}
}
Request: Update daily metrics for an agent
curl -X PUT https://api.COMPANY.brmbl.io/v1/agent_daily_metrics \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_KyUTURJO_CWE5Gj2tWaQgqNZERhnR7jbc" \
-d @- << EOF
{
"date": "2022-12-13",
"user_id": 27710,
"conversations": null,
"idle_seconds": null,
"after_call_work_seconds": null,
"aux_seconds": null,
"available_seconds": null,
"handle_seconds": null,
"hold_seconds": null,
"staffed_seconds": 60,
"talk_seconds": null
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"aux_seconds": null,
"available_seconds": null,
"conversations": 3,
"date": "2022-12-13",
"handle_seconds": null,
"hold_seconds": null,
"idle_seconds": null,
"staffed_seconds": 60,
"talk_seconds": null,
"user_id": 27710
},
"id": "734",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/734"
},
"relationships": {},
"type": "agent_daily_metrics"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/734"
}
}
Response: 409 Conflict
{
"errors": [
{
"detail": "Agent metrics data is empty",
"source": {
"pointer": ":metrics"
},
"title": "Conflict"
}
]
}
Tries to create a an Agent Metric set. If an existing dataset exists, it will update the existing one instead
Request
PUT /v1/agent_daily_metrics
Responses
Status | Description | Schema |
---|---|---|
200 | Agent Daily Metrics Response | |
201 | Agent Daily Metrics Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Cost Categories
Retrieve a cost category
Request: Returns a cost category
curl -X GET https://api.COMPANY.brmbl.io/v1/cost_categories/2204 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_FF75jiLB_ShGNh6FwkhC6qzMcedjNXmge" \
Response: 200 OK
{
"data": {
"attributes": {
"description": "pt-8/ClG3v/",
"inserted_at": "2025-01-14T13:24:26Z",
"name": "Auto",
"state": "active",
"updated_at": "2025-01-14T13:24:26Z"
},
"id": "2204",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/cost_categories/2204"
},
"relationships": {},
"type": "cost_categories"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/cost_categories/2204"
}
}
You can fetch the details of a single cost category.
Request
GET /v1/cost_categories/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
Cost category ID to retrieve. | path | integer | true | 233 |
Responses
Status | Description | Schema |
---|---|---|
200 | Cost Category Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
List all cost categories
Request: List of cost categories
curl -X GET https://api.COMPANY.brmbl.io/v1/cost_categories?page[number]=1&page[size]=2&sort=name&fields[cost_categories]=name,state \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_PgDdQ54C_5yDE8ALPqS3vQIurxYt9kcJQ" \
Response: 200 OK
{
"data": [
{
"attributes": {
"name": "Auto",
"state": "active"
},
"id": "2192",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/cost_categories/2192"
},
"relationships": {},
"type": "cost_categories"
},
{
"attributes": {
"name": "Property",
"state": "active"
},
"id": "2193",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/cost_categories/2193"
},
"relationships": {},
"type": "cost_categories"
}
],
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/cost_categories?fields%5Bcost_categories%5D=name%2Cstate&page%5Bnumber%5D=1&page%5Bsize%5D=2&sort=name"
},
"meta": {
"pagination": {
"page_number": 1,
"page_size": 2,
"total_entries": 2,
"total_pages": 1
}
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Unexpected field: FOO",
"source": {
"pointer": "/FOO"
},
"title": "Invalid value"
}
]
}
You can fetch a list of all cost categories.
You can optionally filter the list by state.
Request
GET /v1/cost_categories
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
state |
Filter cost categories by given states (comma-separated) | query | array | false | active,archived | |
page |
query | Page | false | |||
sort |
Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. | query | array | false | -name,updated_at,-state | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Cost Categories | |
401 | Authentication Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Friction Types
Retrieve a friction type
Request: Retrieve a supporting task
curl -X GET https://api.COMPANY.brmbl.io/v1/friction_types/3644 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_bU2Ym2Xp_aMVmc3PvsjOAMLrkL4QIxpMx" \
Response: 200 OK
{
"data": {
"attributes": {
"category": "downtime",
"description": "T94Xa1We",
"inserted_at": "2025-01-14T13:24:26Z",
"name": "Power Outage",
"state": "active",
"updated_at": "2025-01-14T13:24:26Z"
},
"id": "3644",
"links": {
"self": "http://www.example.com/v1/friction_types/3644"
},
"relationships": {},
"type": "friction_types"
},
"included": [],
"links": {
"self": "http://www.example.com/v1/friction_types/3644"
}
}
You can fetch the details of a single friction type.
Request
GET /v1/friction_types/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
Friction Type ID to retrieve. | path | integer | true | 32 |
Responses
Status | Description | Schema |
---|---|---|
200 | FrictionType | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
List all Friction Types
Request: List all friction types (filtered).
curl -X GET https://api.COMPANY.brmbl.io/v1/friction_types?state=active \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_Szo1xoGF_pih7OCjd8k2L3LxK44X47gQZ" \
Response: 200 OK
{
"data": [
{
"attributes": {
"category": "downtime",
"description": "A1GUegdl",
"inserted_at": "2025-01-14T13:24:26Z",
"name": "Power Outage",
"state": "active",
"updated_at": "2025-01-14T13:24:26Z"
},
"id": "3646",
"links": {
"self": "http://www.example.com/v1/friction_types/3646"
},
"relationships": {},
"type": "friction_types"
}
],
"included": [],
"links": {
"self": "http://www.example.com/v1/friction_types?state=active"
},
"meta": {
"pagination": {
"page_number": 1,
"page_size": 25,
"total_entries": 1,
"total_pages": 1
}
}
}
You can fetch a list of all friction types.
Request
GET /v1/friction_types
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
category |
Filter the friction type's in given category(ies). | query | array | false | downtime,coaching | |
state |
Filter by the friction type's status. | query | array | false | active,archived | |
page |
query | Page | false | |||
sort |
Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. | query | array | false | -name,updated_at,-state | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Friction Types | |
401 | Authentication Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Groups
Retrieve a group
Request: Returns a group
curl -X GET https://api.COMPANY.brmbl.io/v1/groups/25798?include=users \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_RsOyp25p_0uh6OMDX1V5Bi20aRsLZ6VfT" \
Response: 200 OK
{
"data": {
"attributes": {
"inserted_at": "2025-01-14T13:24:23Z",
"name": "Sales",
"state": "active",
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "25798",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/groups/25798"
},
"relationships": {
"users": {
"data": [
{
"id": "27631",
"type": "users"
}
],
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users",
"self": "http://api.COMPANY.brmbl.io/v1/groups/25798/relationships/users"
}
}
},
"type": "groups"
},
"included": [
{
"attributes": {
"account_role": null,
"email": "orland_collins@bahringer.net",
"full_name": "Some User",
"inserted_at": "2025-01-14T13:24:23Z",
"preferred_first_name": "Some",
"state": "new",
"team_role": "team_contributor",
"timezone": "Etc/UTC",
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "27631",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/users/27631"
},
"relationships": {},
"type": "users"
}
],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/groups/25798"
}
}
You can fetch the details of a single group, using it's Bramble ID.
Request
GET /v1/groups/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
The ID of the group to fetch | path | integer | true | 233 | |
include |
Comma separated list of relationships to include. | query | array | false | parent,users | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Group Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
List all groups
Request: List of groups (filtered by parent_id)
curl -X GET https://api.COMPANY.brmbl.io/v1/groups?ancestors_id=25763&page[number]=1&page[size]=2&sort=name&fields[groups]=name,state \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_81wLLBwq_ZKjN7ewOzTS2Kmh0BJZP35Hd" \
Response: 200 OK
{
"data": [
{
"attributes": {
"name": "division",
"state": "active"
},
"id": "25764",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/groups/25764"
},
"relationships": {},
"type": "groups"
},
{
"attributes": {
"name": "root",
"state": "active"
},
"id": "25763",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/groups/25763"
},
"relationships": {},
"type": "groups"
}
],
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/groups?ancestors_id=25763&fields%5Bgroups%5D=name%2Cstate&page%5Bnumber%5D=1&page%5Bsize%5D=2&sort=name"
},
"meta": {
"pagination": {
"page_number": 1,
"page_size": 2,
"total_entries": 3,
"total_pages": 2
}
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Unexpected field: FOO",
"source": {
"pointer": "/FOO"
},
"title": "Invalid value"
}
]
}
You can fetch a list of all groups.
You can optionally filter the list by group status, or by to all groups that are descendant from a given parent group (using root_group_ids
).
Request
GET /v1/groups
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
ancestors_id |
Filter groups who have these IDs above them in the group hierarchy | query | array | false | 1,51,42 | |
parent_id |
Filter groups who have these IDs above them in the group hierarchy | query | array | false | 1,51,42 | |
state |
Filter groups by given states (comma-separated) | query | array | false | active,archived | |
page |
query | Page | false | |||
sort |
Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. | query | array | false | -name,updated_at,-state | |
include |
Comma separated list of relationships to include. | query | array | false | parent,users | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Groups | |
401 | Authentication Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Leave Types
Retrieve a leave type
Request: Retrieve a leave type
curl -X GET https://api.COMPANY.brmbl.io/v1/leave_types/2112 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_ZHpuw8k4_l6zstF5gO0BAkBf2bEIJJxPu" \
Response: 200 OK
{
"data": {
"attributes": {
"category": "unplanned_paid",
"description": "l4K9rEoO",
"inserted_at": "2025-01-14T13:24:26Z",
"name": "Kid Sickness",
"state": "active",
"updated_at": "2025-01-14T13:24:26Z"
},
"id": "2112",
"links": {
"self": "http://www.example.com/v1/leave_types/2112"
},
"relationships": {},
"type": "leave_types"
},
"included": [],
"links": {
"self": "http://www.example.com/v1/leave_types/2112"
}
}
You can fetch the details of a single leave type.
Request
GET /v1/leave_types/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
Leave Type ID to retrieve. | path | integer | true | 42 |
Responses
Status | Description | Schema |
---|---|---|
200 | LeaveType | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
List all Leave Types
Request: List all leave types (filtered).
curl -X GET https://api.COMPANY.brmbl.io/v1/leave_types?state=active \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_7KfbX1Rc_Gl7TIcDDkwXjHPbtfkQmPudm" \
Response: 200 OK
{
"data": [
{
"attributes": {
"category": "unplanned_paid",
"description": "xXmWseBF",
"inserted_at": "2025-01-14T13:24:26Z",
"name": "Kid Sickness",
"state": "active",
"updated_at": "2025-01-14T13:24:26Z"
},
"id": "2114",
"links": {
"self": "http://www.example.com/v1/leave_types/2114"
},
"relationships": {},
"type": "leave_types"
}
],
"included": [],
"links": {
"self": "http://www.example.com/v1/leave_types?state=active"
},
"meta": {
"pagination": {
"page_number": 1,
"page_size": 25,
"total_entries": 1,
"total_pages": 1
}
}
}
You can fetch a list of all leave types.
Request
GET /v1/leave_types
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
category |
Filter the leave type's in given category(ies). | query | array | false | planned_paid,unplanned_paid | |
state |
Filter by the leave type's status. | query | array | false | active,archived | |
page |
query | Page | false | |||
sort |
Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. | query | array | false | -name,updated_at,-state | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Leave Types | |
401 | Authentication Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Production Tasks
Retrieve a production task
Request: Retrieve a production task
curl -X GET https://api.COMPANY.brmbl.io/v1/production_tasks/9008 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_zZAcjLJI_WBqH2L6G5WPqmZNhseHlUVUv" \
Response: 200 OK
{
"data": {
"attributes": {
"description": "pt-wZyFL4LS",
"entry_mode": "AUTO",
"improvement_category": "rpa",
"inserted_at": "2025-01-14T13:24:25Z",
"name": "Customer Outreach",
"state": "active",
"updated_at": "2025-01-14T13:24:25Z"
},
"id": "9008",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/production_tasks/9008"
},
"relationships": {},
"type": "production_tasks"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/production_tasks/9008"
}
}
You can fetch the details of a single production task.
Request
GET /v1/production_tasks/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
Production task ID to retrieve. | path | integer | true | 233 |
Responses
Status | Description | Schema |
---|---|---|
200 | ProductionTask | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
List all Production Tasks
Request: List all production tasks (filtered).
curl -X GET https://api.COMPANY.brmbl.io/v1/production_tasks?improvement_category=lean \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_nhvVXjOq_sOr7bSSJbO2BIPyg2zcRitJL" \
Response: 200 OK
{
"data": [
{
"attributes": {
"description": "pt-Wn7TVMUk",
"entry_mode": "AUTO",
"improvement_category": "lean",
"inserted_at": "2025-01-14T13:24:25Z",
"name": "Lodge Claim",
"state": "active",
"updated_at": "2025-01-14T13:24:25Z"
},
"id": "9010",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/production_tasks/9010"
},
"relationships": {
"process": {
"data": {
"id": "3861",
"type": "process"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/process/3861",
"self": "http://api.COMPANY.brmbl.io/v1/production_tasks/9010/relationships/process"
}
}
},
"type": "production_tasks"
}
],
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/production_tasks?improvement_category=lean"
},
"meta": {
"pagination": {
"page_number": 1,
"page_size": 25,
"total_entries": 1,
"total_pages": 1
}
}
}
You can fetch a list of all production tasks.
Request
GET /v1/production_tasks
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
group_id |
Filter the tasks owned by the given group(s). | query | array | false | 1, 2, 3 | |
improvement_category |
Filter the tasks in given continuous improvement category(ies). | query | array | false | lean,rpa | |
process_id |
Filter by Process(es) | query | array | false | 1,2,3 | |
state |
Filter by the task status. | query | array | false | active,archived | |
page |
query | Page | false | |||
sort |
Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. | query | array | false | -name,ideal_task_time | |
include |
Comma separated list of relationships to include. | query | array | false | process | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Production Tasks | |
401 | Authentication Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Quality Scores
Create a Quality score
Request: Create a quality score
curl -X POST https://api.COMPANY.brmbl.io/v1/quality_scores \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_4W3CD2Eu_U5kBJw0aYDFo6L7pr5YFTJQs" \
-d @- << EOF
{
"date": "2022-02-23",
"note": null,
"score": 0.95,
"user_id": "27603",
"production_task_id": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:22Z",
"note": null,
"score": 0.95,
"updated_at": "2025-01-14T13:24:22Z"
},
"id": "3448",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3448"
},
"relationships": {
"user": {
"data": {
"id": "27603",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27603",
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3448/relationships/user"
}
}
},
"type": "quality_scores"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3448"
}
}
Request: Create a quality score with optional production task
curl -X POST https://api.COMPANY.brmbl.io/v1/quality_scores \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_GQOgwXhf_ibT6z5XedSpdxHVLhDP3zsXs" \
-d @- << EOF
{
"date": "2022-02-23",
"note": null,
"score": 0.95,
"user_id": "27587",
"production_task_id": 8973
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:22Z",
"note": null,
"score": 0.95,
"updated_at": "2025-01-14T13:24:22Z"
},
"id": "3439",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3439"
},
"relationships": {
"production_task": {
"data": {
"id": "8973",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8973",
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3439/relationships/production_task"
}
},
"user": {
"data": {
"id": "27587",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27587",
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3439/relationships/user"
}
}
},
"type": "quality_scores"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3439"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Invalid format. Expected :date",
"source": {
"pointer": "/date"
},
"title": "Invalid value"
}
]
}
You can create a quality score for a user, and optionally for a production task, for a particular day.
Request
POST /v1/quality_scores
Responses
Status | Description | Schema |
---|---|---|
201 | Quality Score Response | |
401 | Authentication Error | |
404 | Not Found Error | |
409 | Conflict | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Delete a Quality Score
Request: Deletes a quality score
curl -X DELETE https://api.COMPANY.brmbl.io/v1/quality_scores/3443 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_CO0sv7ll_vZHfwiRVfametZ0pfIVvLTcV" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2025-01-14",
"inserted_at": "2025-01-14T13:24:22Z",
"note": null,
"score": 0.5,
"updated_at": "2025-01-14T13:24:22Z"
},
"id": "3443",
"links": {
"self": "http://company.brmbl.io/v1/quality_scores/3443"
},
"relationships": {
"production_task": {
"data": {
"id": "8974",
"type": "production_tasks"
},
"links": {
"related": "http://company.brmbl.io/v1/production_tasks/8974",
"self": "http://company.brmbl.io/v1/quality_scores/3443/relationships/production_task"
}
},
"user": {
"data": {
"id": "27597",
"type": "users"
},
"links": {
"related": "http://company.brmbl.io/v1/users/27597",
"self": "http://company.brmbl.io/v1/quality_scores/3443/relationships/user"
}
}
},
"type": "quality_scores"
},
"included": [],
"links": {
"self": "http://company.brmbl.io/v1/quality_scores/3443"
}
}
Response: 404 Not Found
{
"errors": [
{
"code": "40401",
"detail": "The given quality score could not be found.",
"status": "404",
"title": "Quality Score Not Found"
}
]
}
Delete a Quality Score.
Request
DELETE /v1/quality_scores/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
The ID of the quality score to delete. | path | integer | true | 233 |
Responses
Status | Description | Schema |
---|---|---|
200 | Quality Score Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Retrieve a quality score
Request: Retrieve a quality score
curl -X GET https://api.COMPANY.brmbl.io/v1/quality_scores/3442 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_UHejwLHS_sQVMTPsJjJH9nBrmGX6QgzDw" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2023-01-01",
"inserted_at": "2025-01-14T13:24:22Z",
"note": null,
"score": 0.5,
"updated_at": "2025-01-14T13:24:22Z"
},
"id": "3442",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3442"
},
"relationships": {
"user": {
"data": {
"id": "27593",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27593",
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3442/relationships/user"
}
}
},
"type": "quality_scores"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3442"
}
}
Response: 404 Not Found
{
"errors": [
{
"code": "40401",
"detail": "Could not find quality score with id: 3441",
"status": "404",
"title": "Resource Not Found"
}
]
}
You can fetch the details of a single quality score.
Request
GET /v1/quality_scores/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
Quality score ID to retrieve. | path | integer | true | 233 | |
include |
Comma separated list of relationships to include. | query | array | false | user | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Quality Score Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
List all quality scores
Request: List of quality scores (filtered by date)
curl -X GET https://api.COMPANY.brmbl.io/v1/quality_scores?date=2023-01-02&page[number]=1&page[size]=10&sort=score&fields[quality_scores]=score,date \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_yiDZoLCB_4AGW9UDY6ijGTxk8e15UlTtm" \
Response: 200 OK
{
"data": [
{
"attributes": {
"date": "2023-01-02",
"score": 0.25
},
"id": "3423",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3423"
},
"relationships": {
"user": {
"data": {
"id": "27570",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27570",
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3423/relationships/user"
}
}
},
"type": "quality_scores"
},
{
"attributes": {
"date": "2023-01-02",
"score": 0.5
},
"id": "3424",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3424"
},
"relationships": {
"user": {
"data": {
"id": "27571",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27571",
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores/3424/relationships/user"
}
}
},
"type": "quality_scores"
}
],
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/quality_scores?date=2023-01-02&fields%5Bquality_scores%5D=score%2Cdate&page%5Bnumber%5D=1&page%5Bsize%5D=10&sort=score"
},
"meta": {
"pagination": {
"page_number": 1,
"page_size": 10,
"total_entries": 2,
"total_pages": 1
}
}
}
You can fetch a list of all quality scores.
Request
GET /v1/quality_scores
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
date |
Filter results scored for this date | query | string | false | 2022-02-28 | |
user_id |
Filter results with this Bramble user ID | query | integer | false | 12 | |
group_id |
Filter scores for users in this Bramble group | query | integer | false | 2 | |
production_task_id |
Filter results with this Bramble task ID | query | integer | false | 5 | |
page |
query | Page | false | |||
sort |
Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. | query | array | false | -date,-score | |
include |
Comma separated list of relationships to include. | query | array | false | user | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Quality Scores | |
401 | Authentication Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Service Level Scores
Create a Service Level score
Request: Create a service level
curl -X POST https://api.COMPANY.brmbl.io/v1/service_levels \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_JgQ5JGFy_zZwcvSh0btNqObZdNQEVMDVj" \
-d @- << EOF
{
"date": "2022-02-23",
"note": null,
"score": 0.55,
"production_task_id": 8994
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:23Z",
"note": null,
"score": 0.55,
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "693",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/693"
},
"relationships": {
"production_task": {
"data": {
"id": "8994",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8994",
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/693/relationships/production_task"
}
}
},
"type": "service_levels"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/693"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Invalid format. Expected :date",
"source": {
"pointer": "/date"
},
"title": "Invalid value"
}
]
}
Request: Several service levels can exist for the same date + production_task parameter
curl -X POST https://api.COMPANY.brmbl.io/v1/service_levels \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_9yKv2Uav_K87dC2vEU5R7Kh1LwZwtUvfp" \
-d @- << EOF
{
"date": "2022-02-23",
"note": null,
"score": 0.55,
"production_task_id": 8990
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:23Z",
"note": null,
"score": 0.55,
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "688",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/688"
},
"relationships": {
"production_task": {
"data": {
"id": "8990",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8990",
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/688/relationships/production_task"
}
}
},
"type": "service_levels"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/688"
}
}
You can create a service level score for a task.
A service level ranks the SLA for a Production Task on a specific date.
Request
POST /v1/service_levels
Responses
Status | Description | Schema |
---|---|---|
201 | Service Level Response | |
401 | Authentication Error | |
404 | Not Found Error | |
409 | Conflict | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Delete a Service Level
Request: Deletes a service level
curl -X DELETE https://api.COMPANY.brmbl.io/v1/service_levels/695 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_e9XfzHCO_7Qv7HMkOF4VMUT5uhMIRN42B" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2020-01-01",
"inserted_at": "2025-01-14T13:24:23Z",
"note": null,
"score": 0.1,
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "695",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/695"
},
"relationships": {
"production_task": {
"data": {
"id": "8996",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8996",
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/695/relationships/production_task"
}
}
},
"type": "service_levels"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/695"
}
}
Response: 404 Not Found
{
"errors": [
{
"code": "40401",
"detail": "Could not find service level with id: 689",
"status": "404",
"title": "Resource Not Found"
}
]
}
Delete a Service Level.
Request
DELETE /v1/service_levels/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
The ID of the service level to delete. | path | integer | true | 123 |
Responses
Status | Description | Schema |
---|---|---|
200 | Service Levels | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Retrieve a service level
Request: Retrieve a service level
curl -X GET https://api.COMPANY.brmbl.io/v1/service_levels/686 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_pOLd1CYP_9nRa3wsppdS6hCqUexUMEGgc" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2020-01-01",
"inserted_at": "2025-01-14T13:24:23Z",
"note": null,
"score": 0.1,
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "686",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/686"
},
"relationships": {
"production_task": {
"data": {
"id": "8989",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8989",
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/686/relationships/production_task"
}
}
},
"type": "service_levels"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/686"
}
}
Response: 404 Not Found
{
"errors": [
{
"code": "40401",
"detail": "Could not find service level with id: 685",
"status": "404",
"title": "Resource Not Found"
}
]
}
You can fetch the details of a single service level score.
Request
GET /v1/service_levels/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
The ID of the Service level to fetch | path | integer | true | 233 | |
include |
Comma separated list of relationships to include. | query | array | false | production_task | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Service Level Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
List all service levels
Request: List all service levels, filtered.
curl -X GET https://api.COMPANY.brmbl.io/v1/service_levels?date=2023-01-01,2023-01-02&page[number]=1&page[size]=100&sort=-score,date&fields[service_levels]=score \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_Fnavzhpi_IeqcUppTZZysYOBL52XuxRKL" \
Response: 200 OK
{
"data": [
{
"attributes": {
"score": 0.9
},
"id": "670",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/670"
},
"relationships": {
"production_task": {
"data": {
"id": "8977",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8977",
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/670/relationships/production_task"
}
}
},
"type": "service_levels"
},
{
"attributes": {
"score": 0.5
},
"id": "669",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/669"
},
"relationships": {
"production_task": {
"data": {
"id": "8976",
"type": "production_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/production_tasks/8976",
"self": "http://api.COMPANY.brmbl.io/v1/service_levels/669/relationships/production_task"
}
}
},
"type": "service_levels"
}
],
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/service_levels?date=2023-01-01%2C2023-01-02&fields%5Bservice_levels%5D=score&page%5Bnumber%5D=1&page%5Bsize%5D=100&sort=-score%2Cdate"
},
"meta": {
"pagination": {
"page_number": 1,
"page_size": 100,
"total_entries": 2,
"total_pages": 1
}
}
}
You can fetch a list of all service level scores.
You can optionally filter the list by score date and production task.
You can also optionally request the page and page size to limit and paginate through the results.
Request
GET /v1/service_levels
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
date |
Filter results scored for this date | query | array | false | 2022-02-28,2022-02-29 | |
sort |
Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. | query | array | false | -date,-score | |
include |
Comma separated list of relationships to include. | query | array | false | production_task | |
fields |
Comma separated list of fields to return. | query | object | false | ||
production_task_id |
Filter results by task id | query | array | false | 12 | |
page |
query | Page | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Service Levels | |
401 | Authentication Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Supporting Tasks
Retrieve a supporting task
Request: Retrieve a supporting task
curl -X GET https://api.COMPANY.brmbl.io/v1/supporting_tasks/5773 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_1nTzozQX_H5Q8fTbjxBZNIDNYKMzBxCFN" \
Response: 200 OK
{
"data": {
"attributes": {
"category": "train",
"description": "AQXmyt2x",
"inserted_at": "2025-01-14T13:24:23Z",
"name": "Compliance Training",
"state": "active",
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "5773",
"links": {
"self": "http://www.example.com/v1/supporting_tasks/5773"
},
"relationships": {},
"type": "supporting_tasks"
},
"included": [],
"links": {
"self": "http://www.example.com/v1/supporting_tasks/5773"
}
}
You can fetch the details of a single supporting task.
Request
GET /v1/supporting_tasks/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
Supporting task ID to retrieve. | path | integer | true | 233 |
Responses
Status | Description | Schema |
---|---|---|
200 | SupportingTask | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
List all Supporting Tasks
Request: List all supporting tasks (filtered).
curl -X GET https://api.COMPANY.brmbl.io/v1/supporting_tasks?state=active \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_4stU7D2w_VoK5FSktqgUCf6dKnMDIrfha" \
Response: 200 OK
{
"data": [
{
"attributes": {
"category": "train",
"description": "L9l98Hwd",
"inserted_at": "2025-01-14T13:24:23Z",
"name": "Compliance Training",
"state": "active",
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "5775",
"links": {
"self": "http://www.example.com/v1/supporting_tasks/5775"
},
"relationships": {},
"type": "supporting_tasks"
}
],
"included": [],
"links": {
"self": "http://www.example.com/v1/supporting_tasks?state=active"
},
"meta": {
"pagination": {
"page_number": 1,
"page_size": 25,
"total_entries": 1,
"total_pages": 1
}
}
}
You can fetch a list of all supporting tasks.
Request
GET /v1/supporting_tasks
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
category |
Filter the tasks in given category(ies). | query | array | false | meeting,leadership | |
state |
Filter by the task status. | query | array | false | active,archived | |
page |
query | Page | false | |||
sort |
Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. | query | array | false | -name,updated_at,-state | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Supporting Tasks | |
401 | Authentication Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
UserPlanEntries
Retrieve a user plan entry.
Request: Returns a user plan entry
curl -X GET https://api.COMPANY.brmbl.io/v1/user_plan_entries/15676 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_qC2DuPZO_coaT3QgwoAfGUSFIuICeeLxT" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2025-01-20",
"inserted_at": "2025-01-14T13:24:24Z",
"minutes": "450",
"type": "base_time",
"updated_at": "2025-01-14T13:24:24Z"
},
"id": "15676",
"links": {
"self": "http://company.brmbl.io/v1/user_plan_entries/15676"
},
"relationships": {},
"type": "user_plan_entries"
},
"included": [],
"links": {
"self": "http://company.brmbl.io/v1/user_plan_entries/15676"
}
}
Request: Returns a user plan entry
curl -X GET https://api.COMPANY.brmbl.io/v1/user_plan_entries/15693?include=user_plan \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_71ic5kUe_APZpzEVZZthIL5BHYlOuSK3P" \
Response: 200 OK
{
"data": {
"attributes": {
"date": "2025-01-20",
"inserted_at": "2025-01-14T13:24:24Z",
"minutes": "450",
"type": "base_time",
"updated_at": "2025-01-14T13:24:24Z"
},
"id": "15693",
"links": {
"self": "http://company.brmbl.io/v1/user_plan_entries/15693"
},
"relationships": {
"user_plan": {
"data": {
"id": "2948",
"type": "user_plans"
},
"links": {
"related": "http://company.brmbl.io/v1/user_plans/2948",
"self": "http://company.brmbl.io/v1/user_plan_entries/15693/relationships/user_plan"
}
}
},
"type": "user_plan_entries"
},
"included": [
{
"attributes": {
"contribution": 0.33,
"from": "2025-01-20",
"inserted_at": "2025-01-14T13:24:24Z",
"until": "2025-01-26",
"updated_at": "2025-01-14T13:24:24Z",
"week_number": 4,
"year": 2025
},
"id": "2948",
"links": {
"self": "http://company.brmbl.io/v1/user_plans/2948"
},
"relationships": {},
"type": "user_plans"
}
],
"links": {
"self": "http://company.brmbl.io/v1/user_plan_entries/15693"
}
}
You can fetch the details of a single user plan entry.
Request
GET /v1/user_plan_entries/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
User plan entry ID to retrieve. | path | integer | true | 233 | |
include |
Comma separated list of relationships to include. | query | array | false | users | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | User Plan Entries Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Upserts a user plan entry.
Request: Create a user plan supporting task entry
curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/2927/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_rj2FB5cN_ZkMYbbEaWsVfXOevyOx52i6L" \
-d @- << EOF
{
"type": "supporting_task",
"date": "2022-02-23",
"user_id": "27736",
"minutes": 450,
"supporting_task_id": "5776"
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:24Z",
"minutes": "450",
"type": "supporting_task",
"updated_at": "2025-01-14T13:24:24Z"
},
"id": "15669",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15669"
},
"relationships": {
"group": {
"data": {
"id": "25890",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25890",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15669/relationships/group"
}
},
"supporting_task": {
"data": {
"id": "5776",
"type": "supporting_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/5776",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15669/relationships/supporting_task"
}
},
"user": {
"data": {
"id": "27736",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27736",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15669/relationships/user"
}
},
"user_plan": {
"data": {
"id": "2927",
"type": "user_plans"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/user_plans/2927",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15669/relationships/user_plan"
}
}
},
"type": "user_plan_entries"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15669"
}
}
Request: Update a user plan supporting task entry
curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/2943/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_c27QAqyf_6jrT0Y5ZwURv7xiqqGhO4TAg" \
-d @- << EOF
{
"type": "supporting_task",
"date": "2022-02-23",
"user_id": "27764",
"minutes": 450,
"supporting_task_id": "5780"
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:24Z",
"minutes": "900",
"type": "supporting_task",
"updated_at": "2025-01-14T13:24:25Z"
},
"id": "15687",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15687"
},
"relationships": {
"group": {
"data": {
"id": "25918",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25918",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15687/relationships/group"
}
},
"supporting_task": {
"data": {
"id": "5780",
"type": "supporting_tasks"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/5780",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15687/relationships/supporting_task"
}
},
"user": {
"data": {
"id": "27764",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27764",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15687/relationships/user"
}
},
"user_plan": {
"data": {
"id": "2943",
"type": "user_plans"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/user_plans/2943",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15687/relationships/user_plan"
}
}
},
"type": "user_plan_entries"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15687"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Failed to cast value to one of: no schemas validate",
"source": {
"pointer": "/"
},
"title": "Invalid value"
},
{
"detail": "Invalid value for enum",
"source": {
"pointer": "/type"
},
"title": "Invalid value"
},
{
"detail": "Invalid integer. Got: string",
"source": {
"pointer": "/minutes"
},
"title": "Invalid value"
},
{
"detail": "Missing field: leave_type_id",
"source": {
"pointer": "/leave_type_id"
},
"title": "Invalid value"
},
{
"detail": "Invalid integer. Got: string",
"source": {
"pointer": "/minutes"
},
"title": "Invalid value"
}
]
}
Request: Create a user plan leave entry
curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/2928/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_nbVyCwmU_kVplNIoaGzk7XnidUC4uJHS6" \
-d @- << EOF
{
"type": "leave_type",
"date": "2025-05-23",
"leave_type_id": "2095",
"user_id": "27738",
"minutes": 450,
"note": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2025-05-23",
"inserted_at": "2025-01-14T13:24:24Z",
"minutes": "450",
"type": "leave_type",
"updated_at": "2025-01-14T13:24:24Z"
},
"id": "15670",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15670"
},
"relationships": {
"group": {
"data": {
"id": "25892",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25892",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15670/relationships/group"
}
},
"leave_plan": {
"data": {
"id": "703",
"type": "leave_plans"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/leave_plans/703",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15670/relationships/leave_plan"
}
},
"user": {
"data": {
"id": "27738",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27738",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15670/relationships/user"
}
},
"user_plan": {
"data": {
"id": "2929",
"type": "user_plans"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/user_plans/2929",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15670/relationships/user_plan"
}
}
},
"type": "user_plan_entries"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15670"
}
}
Request: Update a user plan leave entry
curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/2938/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_zSg8jekc_pBRDCoPDm6wFJ7zfnLoez4el" \
-d @- << EOF
{
"type": "leave_type",
"date": "2025-05-23",
"leave_type_id": "2097",
"user_id": "27756",
"minutes": 450,
"note": null
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2025-05-23",
"inserted_at": "2025-01-14T13:24:24Z",
"minutes": "450",
"type": "leave_type",
"updated_at": "2025-01-14T13:24:24Z"
},
"id": "15684",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15684"
},
"relationships": {
"group": {
"data": {
"id": "25910",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25910",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15684/relationships/group"
}
},
"leave_plan": {
"data": {
"id": "704",
"type": "leave_plans"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/leave_plans/704",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15684/relationships/leave_plan"
}
},
"user": {
"data": {
"id": "27756",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27756",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15684/relationships/user"
}
},
"user_plan": {
"data": {
"id": "2939",
"type": "user_plans"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/user_plans/2939",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15684/relationships/user_plan"
}
}
},
"type": "user_plan_entries"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15684"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Failed to cast value to one of: no schemas validate",
"source": {
"pointer": "/"
},
"title": "Invalid value"
},
{
"detail": "Invalid value for enum",
"source": {
"pointer": "/type"
},
"title": "Invalid value"
},
{
"detail": "Invalid integer. Got: string",
"source": {
"pointer": "/minutes"
},
"title": "Invalid value"
},
{
"detail": "Invalid integer. Got: string",
"source": {
"pointer": "/minutes"
},
"title": "Invalid value"
},
{
"detail": "Missing field: supporting_task_id",
"source": {
"pointer": "/supporting_task_id"
},
"title": "Invalid value"
}
]
}
Request: Create a user plan base time entry
curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/2936/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_heI7teeu_ogsiFjc6sA58pa3HtJbB8VlX" \
-d @- << EOF
{
"type": "base_time",
"date": "2022-02-23",
"user_id": "27752",
"minutes": 450
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:24Z",
"minutes": "450",
"type": "base_time",
"updated_at": "2025-01-14T13:24:24Z"
},
"id": "15683",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15683"
},
"relationships": {
"group": {
"data": {
"id": "25906",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25906",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15683/relationships/group"
}
},
"user": {
"data": {
"id": "27752",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27752",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15683/relationships/user"
}
},
"user_plan": {
"data": {
"id": "2936",
"type": "user_plans"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/user_plans/2936",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15683/relationships/user_plan"
}
}
},
"type": "user_plan_entries"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15683"
}
}
Request: Update a user plan supporting task entry
curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/2946/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_AYvdzKw8_sOG90vNThT1zhnBmrrKEqTzU" \
-d @- << EOF
{
"type": "base_time",
"date": "2022-02-23",
"user_id": "27768",
"minutes": 450
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "2025-01-14T13:24:24Z",
"minutes": "900",
"type": "base_time",
"updated_at": "2025-01-14T13:24:25Z"
},
"id": "15690",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15690"
},
"relationships": {
"group": {
"data": {
"id": "25922",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25922",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15690/relationships/group"
}
},
"user": {
"data": {
"id": "27768",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27768",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15690/relationships/user"
}
},
"user_plan": {
"data": {
"id": "2946",
"type": "user_plans"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/user_plans/2946",
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15690/relationships/user_plan"
}
}
},
"type": "user_plan_entries"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/15690"
}
}
Tries to create a user's planned supporting task or base time entry. If an existing entry exists, it will update the existing one instead
Request
PUT /v1/user_plans/{id}/user_plan_entry
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
x-lineage-data |
Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. | header | string | false |
Responses
Status | Description | Schema |
---|---|---|
200 | User Plan Entries Response | |
201 | User Plan Entries Response | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
UserPlans
Creates a user's plan for the week
Request: Creates user's plan for a week
curl -X POST https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_WqtlJwzU_yeJMB8Ql60ztHku00rXAQRDO" \
-d @- << EOF
{
"year": 2024,
"user_id": "27820",
"week_number": 1,
"contribution": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"contribution": 0.5,
"from": "2024-01-01",
"inserted_at": "2025-01-14T13:24:25Z",
"until": "2024-01-07",
"updated_at": "2025-01-14T13:24:25Z",
"week_number": 1,
"year": 2024
},
"id": "2959",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2959"
},
"relationships": {
"group": {
"data": {
"id": "25974",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25974",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2959/relationships/group"
}
},
"user": {
"data": {
"id": "27820",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27820",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2959/relationships/user"
}
}
},
"type": "user_plans"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2959"
}
}
Request: Creates user's plan with contribution
curl -X POST https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_TLzlWMko_CLZuH31KyGq5p4FPGKE1uPCU" \
-d @- << EOF
{
"year": 2024,
"user_id": "27800",
"week_number": 1,
"contribution": 0.6
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"contribution": 0.6,
"from": "2024-01-01",
"inserted_at": "2025-01-14T13:24:24Z",
"until": "2024-01-07",
"updated_at": "2025-01-14T13:24:24Z",
"week_number": 1,
"year": 2024
},
"id": "2949",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2949"
},
"relationships": {
"group": {
"data": {
"id": "25954",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25954",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2949/relationships/group"
}
},
"user": {
"data": {
"id": "27800",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27800",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2949/relationships/user"
}
}
},
"type": "user_plans"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2949"
}
}
Request: Creates user's plan with contribution
curl -X POST https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_Yb7oVEZy_Hpkoo14oUWwSfl493ZaZCi2d" \
-d @- << EOF
{
"year": 2024,
"user_id": "27822",
"week_number": 1,
"contribution": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"contribution": 0.5,
"from": "2024-01-01",
"inserted_at": "2025-01-14T13:24:25Z",
"until": "2024-01-07",
"updated_at": "2025-01-14T13:24:25Z",
"week_number": 1,
"year": 2024
},
"id": "2960",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2960"
},
"relationships": {
"group": {
"data": {
"id": "25976",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25976",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2960/relationships/group"
}
},
"user": {
"data": {
"id": "27822",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27822",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2960/relationships/user"
}
}
},
"type": "user_plans"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2960"
}
}
Request: Creates user's plan with contribution
curl -X POST https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_AfTt6Pcs_pe4z9YTkBUMiilXw06KkPAyj" \
-d @- << EOF
{
"year": 2024,
"user_id": "27808",
"week_number": 1,
"contribution": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"contribution": 0.8,
"from": "2024-01-01",
"inserted_at": "2025-01-14T13:24:24Z",
"until": "2024-01-07",
"updated_at": "2025-01-14T13:24:24Z",
"week_number": 1,
"year": 2024
},
"id": "2954",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2954"
},
"relationships": {
"group": {
"data": {
"id": "25962",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25962",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2954/relationships/group"
}
},
"user": {
"data": {
"id": "27808",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27808",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2954/relationships/user"
}
}
},
"type": "user_plans"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2954"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Invalid integer. Got: string",
"source": {
"pointer": "/week_number"
},
"title": "Invalid value"
}
]
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Invalid integer. Got: string",
"source": {
"pointer": "/year"
},
"title": "Invalid value"
}
]
}
Response: 409 Conflict
{
"errors": [
{
"detail": "Plan is already defined for this time period",
"source": {
"pointer": ":user_id"
},
"title": "Conflict"
}
]
}
Creates user's plan for a week.
Request
POST /v1/user_plans
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
x-lineage-data |
Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. | header | string | false |
Responses
Status | Description | Schema |
---|---|---|
201 | User Plans Response | |
401 | Authentication Error | |
404 | Not Found Error | |
409 | Conflict | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Gets or creates a user's plan.
Request: Creates a user's plan for a week
curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_xNQlRDhi_M55bnDQsUF9OrlMBwErY0AUz" \
-d @- << EOF
{
"year": 2024,
"user_id": "27812",
"week_number": 1,
"contribution": null
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"contribution": 0.5,
"from": "2024-01-01",
"inserted_at": "2025-01-14T13:24:25Z",
"until": "2024-01-07",
"updated_at": "2025-01-14T13:24:25Z",
"week_number": 1,
"year": 2024
},
"id": "2955",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2955"
},
"relationships": {
"group": {
"data": {
"id": "25966",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25966",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2955/relationships/group"
}
},
"user": {
"data": {
"id": "27812",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27812",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2955/relationships/user"
}
}
},
"type": "user_plans"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2955"
}
}
Request: Creates user's plan with contribution
curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_1stWXWbj_wTaTbMl9AAu2WWeTesJqTKKf" \
-d @- << EOF
{
"year": 2024,
"user_id": "27814",
"week_number": 1,
"contribution": 0.6
}
EOF
Response: 201 Created
{
"data": {
"attributes": {
"contribution": 0.6,
"from": "2024-01-01",
"inserted_at": "2025-01-14T13:24:25Z",
"until": "2024-01-07",
"updated_at": "2025-01-14T13:24:25Z",
"week_number": 1,
"year": 2024
},
"id": "2956",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2956"
},
"relationships": {
"group": {
"data": {
"id": "25968",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25968",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2956/relationships/group"
}
},
"user": {
"data": {
"id": "27814",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27814",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2956/relationships/user"
}
}
},
"type": "user_plans"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2956"
}
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Invalid integer. Got: string",
"source": {
"pointer": "/week_number"
},
"title": "Invalid value"
}
]
}
Response: 422 Unprocessable Entity
{
"errors": [
{
"detail": "Invalid integer. Got: string",
"source": {
"pointer": "/year"
},
"title": "Invalid value"
}
]
}
Request: Gets existing user plan from parameter
curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_Q4bPVEGG_B5UzfkBkifR2HJapT46vo1Ky" \
-d @- << EOF
{
"year": 2024,
"user_id": "27818",
"week_number": 1,
"contribution": null
}
EOF
Response: 200 OK
{
"data": {
"attributes": {
"contribution": 0.5,
"from": "2024-01-01",
"inserted_at": "2025-01-14T13:24:25Z",
"until": "2024-01-07",
"updated_at": "2025-01-14T13:24:25Z",
"week_number": 1,
"year": 2024
},
"id": "2958",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2958"
},
"relationships": {
"group": {
"data": {
"id": "25972",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25972",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2958/relationships/group"
}
},
"user": {
"data": {
"id": "27818",
"type": "users"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/users/27818",
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2958/relationships/user"
}
}
},
"type": "user_plans"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/2958"
}
}
Response: 409 Conflict
{
"errors": [
{
"detail": "can't update locked group plan",
"source": {
"pointer": ":user_id"
},
"title": "Conflict"
}
]
}
Tries to get an existing plan, and will create if no existing plan is found instead.
Request
PUT /v1/user_plans
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
x-lineage-data |
Log optional lineage data (a Base 64 encoded JSON object) with which to build a history. | header | string | false |
Responses
Status | Description | Schema |
---|---|---|
201 | User Plans Response | |
401 | Authentication Error | |
404 | Not Found Error | |
409 | Conflict | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Users
List all users
Request: Returns a list of users, filtered
curl -X GET https://api.COMPANY.brmbl.io/v1/users?email=bob@foo.com,frank@foo.com&sort=-full_name&page[number]=1&page[size]=3 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_rsH4cPeu_aUllXnZnJT0CoiiIoNMjJW4c" \
Response: 200 OK
{
"data": [
{
"attributes": {
"account_role": null,
"email": "frank@foo.com",
"full_name": "Frank Furter",
"inserted_at": "2025-01-14T13:24:23Z",
"preferred_first_name": "Frank",
"state": "invited",
"team_role": "team_owner",
"timezone": "America/Los_Angeles",
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "27652",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/users/27652"
},
"relationships": {
"group": {
"data": {
"id": "25816",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25816",
"self": "http://api.COMPANY.brmbl.io/v1/users/27652/relationships/group"
}
}
},
"type": "users"
},
{
"attributes": {
"account_role": "account_owner",
"email": "bob@foo.com",
"full_name": "Bob Owner",
"inserted_at": "2025-01-14T13:24:23Z",
"preferred_first_name": "Bob",
"state": "new",
"team_role": null,
"timezone": "Etc/UTC",
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "27651",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/users/27651"
},
"relationships": {
"group": {
"data": {
"id": "25815",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25815",
"self": "http://api.COMPANY.brmbl.io/v1/users/27651/relationships/group"
}
}
},
"type": "users"
}
],
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/users?email=bob%40foo.com%2Cfrank%40foo.com&page%5Bnumber%5D=1&page%5Bsize%5D=3&sort=-full_name"
},
"meta": {
"pagination": {
"page_number": 1,
"page_size": 3,
"total_entries": 2,
"total_pages": 1
}
}
}
Returns a list of users.
Request
GET /v1/users
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
email |
Filter by email(s) | query | array | false | example@brmbl.io,foo@bar.com | |
group_id |
Filter users in these groups, including groups above these in hierarchy | query | array | false | 1,51,42 | |
state |
Filter users in these states | query | array | false | archived | |
page |
query | Page | false | |||
sort |
Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending. | query | array | false | -email,updated_at | |
include |
Comma separated list of relationships to include. | query | array | false | group | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | Task Input | |
401 | Authentication Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Fetch a user by ID
Request: Successful request returns the user
curl -X GET https://api.COMPANY.brmbl.io/v1/users/27640 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_okr4Ljo6_g0xgXp1iD2bYv3XkHjH1yAL4" \
Response: 200 OK
{
"data": {
"attributes": {
"account_role": null,
"email": "leora2003@hintz.net",
"full_name": "Jane Doe",
"inserted_at": "2025-01-14T13:24:23Z",
"preferred_first_name": "Something",
"state": "invited",
"team_role": "team_owner",
"timezone": "Africa/Abidjan",
"updated_at": "2025-01-14T13:24:23Z"
},
"id": "27640",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/users/27640"
},
"relationships": {
"group": {
"data": {
"id": "25806",
"type": "groups"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/groups/25806",
"self": "http://api.COMPANY.brmbl.io/v1/users/27640/relationships/group"
}
}
},
"type": "users"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/users/27640"
}
}
Response: 404 Not Found
{
"errors": [
{
"code": "40401",
"detail": "Could not find user with id: 27748",
"status": "404",
"title": "Resource Not Found"
}
]
}
Returns the user identified by an internal Bramble ID.
Request
GET /v1/users/{id}
Parameters
Parameter | Description | In | Type | Required | Default | Example |
---|---|---|---|---|---|---|
id |
User ID | path | integer | true | 233 | |
include |
Comma separated list of relationships to include. | query | array | false | group | |
fields |
Comma separated list of fields to return. | query | object | false |
Responses
Status | Description | Schema |
---|---|---|
200 | User | |
401 | Authentication Error | |
404 | Not Found Error | |
410 | Ignored | |
422 | Unprocessable Entity | |
500 | Internal Server Error |
Models
Pagination
Pagination metadata
{
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
count |
Number of records in the current page | integer | int64 | false |
current_page |
Current page number | integer | int64 | false |
per_page |
Number of records per page | integer | int64 | false |
total |
Total number of records | integer | int64 | false |
total_pages |
Total number of pages | integer | int64 | false |
Checkin
This is a way to record a user checking-in for a day, and also allows user to set which type of work location they did.
{
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"updated_at": "2023-01-01T00:00:00.000000Z",
"work_location": "distributed"
},
"id": "23",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/users/4"
},
"relationships": {
"user": {
"data": {
"id": "2",
"type": "users"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/users/2",
"self": "https://api.COMPANY.brmbl.io/v1/checkins/4/relationships/user"
}
}
},
"type": "checkins"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The id of the checkin. | string | true | |
type |
value is always "checkins" | string | true | |
attributes.date |
Which day was this checkin created? | string | date | false |
attributes.inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
attributes.updated_at |
The last updated timestamp of this resource. | string | date-time | false |
attributes.work_location |
where the work is done. | string | false | |
relationships.user.data.id |
The unique identifier | string | true | |
relationships.user.data.type |
string | true | ||
relationships.user.links.related |
Link for the relationship itself | string | uri | false |
relationships.user.links.self |
Link for the relationship itself | string | uri | false |
ServiceLevel
Service Level
{
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"note": null,
"score": 0.55,
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "281",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/service_levels/4"
},
"relationships": {
"production_task": {
"data": {
"id": "2",
"type": "production_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
"self": "https://api.COMPANY.brmbl.io/v1/service_levels/4/relationships/production_task"
}
}
},
"type": "service_levels"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The id of the Service Level. | string | true | |
type |
always "service_levels" | string | true | |
attributes.date |
Which day was this score given? | string | date | false |
attributes.inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
attributes.note |
An optional note. | string | false | |
attributes.score |
A percentage (as a floating point number between 0 and 1) rating a production task's service level for this date. | number | float | false |
attributes.updated_at |
The last updated timestamp of this resource. | string | date-time | false |
relationships.production_task.data.id |
The unique identifier | string | true | |
relationships.production_task.data.type |
string | true | ||
relationships.production_task.links.related |
Link for the relationship itself | string | uri | false |
relationships.production_task.links.self |
Link for the relationship itself | string | uri | false |
UserPlan
This is a way to record a user plan for a week, and also allows user to set how much contribution they plan on doing.
{
"attributes": {
"contribution": 0.95,
"from": "2023-12-18",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"until": "2023-12-24",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "23",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plans/4"
},
"relationships": {
"group": {
"data": {
"id": "2",
"type": "groups"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/groups/2",
"self": "https://api.COMPANY.brmbl.io/v1/user_plans/4/relationships/group"
}
},
"user": {
"data": {
"id": "2",
"type": "users"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/users/2",
"self": "https://api.COMPANY.brmbl.io/v1/user_plans/4/relationships/user"
}
}
},
"type": "user_plans"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The id of the user plan. | string | true | |
type |
value is always "user_plans" | string | true | |
attributes.contribution |
A percentage (as a floating point number between 0 and 1) rating the persons contribution on the given week | number | float | false |
attributes.from |
The first date covered by the user plan | string | date | false |
attributes.inserted_at |
Insertion time-stamp. | string | date-time | false |
attributes.until |
The last date covered by the user plan | string | date | false |
attributes.updated_at |
Update time-stamp. | string | date-time | false |
attributes.week_number |
The week number according to ISO-8601 standard | integer | int32 | false |
attributes.year |
The year of the where | integer | false | |
relationships.group.data.id |
The unique identifier | string | true | |
relationships.group.data.type |
string | true | ||
relationships.group.links.related |
Link for the relationship itself | string | uri | false |
relationships.group.links.self |
Link for the relationship itself | string | uri | false |
relationships.user.data.id |
The unique identifier | string | true | |
relationships.user.data.type |
string | true | ||
relationships.user.links.related |
Link for the relationship itself | string | uri | false |
relationships.user.links.self |
Link for the relationship itself | string | uri | false |
QualityScore
The overall score of the quality of a user's work on the given date. If your organization has a quality framework in place, your Front-line managers are usually responsible for measuring quality scores for IC's on a regular basis. This API allows Bramble to receive these quality scores from an external system.
{
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"note": null,
"score": 0.95,
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "281",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4"
},
"relationships": {
"production_task": {
"data": {
"id": "2",
"type": "production_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
"self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4/relationships/production_task"
}
},
"user": {
"data": {
"id": "2",
"type": "users"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/users/2",
"self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4/relationships/user"
}
}
},
"type": "quality_scores"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The id of the Quality Score. | string | true | |
type |
always "quality_scores" | string | true | |
attributes.date |
The date for which this score was given | string | date | false |
attributes.note |
An optional note. | string | false | |
attributes.score |
A percentage (as a floating point number between 0 and 1) rating the persons performance on the given day | number | float | false |
relationships.agent_queue_metrics.data.id |
The unique identifier | string | true | |
relationships.agent_queue_metrics.data.type |
string | true | ||
relationships.agent_queue_metrics.links.related |
Link for the relationship itself | string | uri | false |
relationships.agent_queue_metrics.links.self |
Link for the relationship itself | string | uri | false |
relationships.production_task.data.id |
The unique identifier | string | true | |
relationships.production_task.data.type |
string | true | ||
relationships.production_task.links.related |
Link for the relationship itself | string | uri | false |
relationships.production_task.links.self |
Link for the relationship itself | string | uri | false |
relationships.user.data.id |
The unique identifier | string | true | |
relationships.user.data.type |
string | true | ||
relationships.user.links.related |
Link for the relationship itself | string | uri | false |
relationships.user.links.self |
Link for the relationship itself | string | uri | false |
CheckpointItem
Checkpoint items are used to calculate the balance on a certain day for a certain production task. The sum of the amounts of the CheckpointItems for the day for a production task will define the balance for a Checkpoint on that day
{
"attributes": {
"amount": 5,
"date": "2024-04-09",
"inserted_at": "2024-04-09T00:00:00.000000Z",
"updated_at": "2024-04-09T00:00:00.000000Z"
},
"id": "281",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/281"
},
"relationships": {
"checkpoint": {
"data": {
"id": "3",
"type": "checkpoints"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoints/3",
"self": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/281/relationships/checkpoint"
}
},
"production_task": {
"data": {
"id": "2",
"type": "production_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
"self": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/281/relationships/production_task"
}
}
},
"type": "checkpoint_items"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The id of the Checkpoint Item. | string | true | |
type |
always "checkpoint_items" | string | true | |
attributes.amount |
The amount of the checkpoint item to adjust the checkpoint by. A positive integer. | integer | int32 | false |
attributes.date |
When did this checkpoint item event happen? | string | date | false |
attributes.inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
attributes.updated_at |
The last updated timestamp of this resource. | string | date-time | false |
relationships.checkpoint.data.id |
The unique identifier | string | true | |
relationships.checkpoint.data.type |
string | true | ||
relationships.checkpoint.links.related |
Link for the relationship itself | string | uri | false |
relationships.checkpoint.links.self |
Link for the relationship itself | string | uri | false |
relationships.production_task.data.id |
The unique identifier | string | true | |
relationships.production_task.data.type |
string | true | ||
relationships.production_task.links.related |
Link for the relationship itself | string | uri | false |
relationships.production_task.links.self |
Link for the relationship itself | string | uri | false |
SupportingTask
Supporting Tasks are regular (often planned) business activities that may only indirectly contribute to business outcomes.
{
"category": "meeting",
"id": "32",
"inserted_at": "2023-06-14T06:00:47Z",
"name": "Test supporting task",
"state": "active",
"type": "supporting_tasks",
"updated_at": "2023-06-14T06:00:47Z"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
category |
supporting task's category | string | false | |
id |
Bramble internal supporting task id | string | false | |
inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
name |
The supporting task's name. | string | false | |
state |
The supporting task's state. | string | false | |
type |
always "supporting_tasks" | string | false | |
updated_at |
The last updated timestamp of this resource. | string | date-time | false |
AgentQueueMetrics
Contact center data for one agent on one day by queue.
{}
Property | Description | Type | Format | Required |
---|---|---|---|---|
after_call_work_seconds |
Total amount of time the agent spent completing after-call work. | integer | false | |
conversations |
Count of Automatic Call Distributor (ACD) conversations. | integer | true | |
date |
The date of the day that this data is for. | string | date | true |
entry_id |
Bramble CheckinItem(Entry) ID of the CheckinItem that this data is for. | integer | false | |
handle_seconds |
Total time of all conversations, including talk, hold and after call work time | integer | false | |
hold_seconds |
Total time that conversations were placed on hold. | integer | false | |
inserted_at |
Insertion time-stamp. | string | date-time | false |
production_task_id |
Bramble production task ID of the queue that this data is for. | integer | true | |
quality |
Call quality percentage, expressed as a fraction between 0 and 1. The quality represents a score without creating an explicit quality_score entity. | number | float | false |
quality_score_id |
Bramble quality score ID of the quality score that this data is for. The quality_score entity is used to represent the achieved quality score. | integer | false | |
talk_seconds |
Total Time spent actively interacting. | integer | false | |
user_id |
Bramble user ID of the agent that this data is for. | integer | true |
AgentDailyMetrics
Contact center summary data for one agent on one day.
{}
Property | Description | Type | Format | Required |
---|---|---|---|---|
after_call_work_seconds |
Total amount of time the agent spent completing after-call work. | integer | false | |
aux_seconds |
The total amount of time the agent spent in non-ACD work e.g. breaks, training, meetings etc | integer | false | |
available_seconds |
The total time that the agent was available to take ACD calls | integer | false | |
conversations |
Count of Automatic Call Distributor (ACD) conversations. | integer | false | |
date |
The date of the day that this data is for. | string | date | true |
handle_seconds |
Total time of all conversations, including talk, hold and after call work time | integer | false | |
hold_seconds |
Total time that conversations were placed on hold. | integer | false | |
idle_seconds |
Total idle time. | integer | false | |
inserted_at |
Insertion time-stamp. | string | date-time | false |
staffed_seconds |
The total amount of time the agent spent logged into the ACD system. | integer | false | |
talk_seconds |
Total Time spent actively interacting. | integer | false | |
user_id |
Bramble user ID of the agent that this data is for. | integer | true |
Checkpoint
Checkpoint tracks known balances for a given day+task
{
"attributes": {
"balance": 10,
"date": "2024-04-09",
"inserted_at": "2024-04-09T00:00:00.000000Z",
"updated_at": "2024-04-09T00:00:00.000000Z"
},
"id": "281",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoints/281"
},
"relationships": {
"production_task": {
"data": {
"id": "2",
"type": "production_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
"self": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoints/281/relationships/production_task"
}
}
},
"type": "checkpoints"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The id of the Checkpoint. | string | true | |
type |
always "checkpoints" | string | true | |
attributes.balance |
The balance of the checkpoint. A positive integer. | integer | int32 | false |
attributes.date |
What date is this balance for? | string | date | false |
attributes.inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
attributes.updated_at |
The last updated timestamp of this resource. | string | date-time | false |
relationships.production_task.data.id |
The unique identifier | string | true | |
relationships.production_task.data.type |
string | true | ||
relationships.production_task.links.related |
Link for the relationship itself | string | uri | false |
relationships.production_task.links.self |
Link for the relationship itself | string | uri | false |
Page
{
"number": 2,
"size": 100
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
number |
Page number to retrieve | integer | int32 | false |
size |
Number of items per page | integer | int32 | false |
Meta
Metadata about the response
{
"pagination": {
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
pagination.count |
Number of records in the current page | integer | int64 | false |
pagination.current_page |
Current page number | integer | int64 | false |
pagination.per_page |
Number of records per page | integer | int64 | false |
pagination.total |
Total number of records | integer | int64 | false |
pagination.total_pages |
Total number of pages | integer | int64 | false |
QueueDailyMetrics
Contact center data for one queue on one day.
{}
Property | Description | Type | Format | Required |
---|---|---|---|---|
after_call_work_seconds |
Total amount of time the agent spent completing after-call work. | integer | false | |
conversations |
Count of Automatic Call Distributor (ACD) conversations. | integer | true | |
date |
The date of the day that this data is for. | string | date | true |
handle_seconds |
Total time of all conversations, including talk, hold and after call work time | integer | false | |
hold_seconds |
Total time that conversations were placed on hold. | integer | false | |
inserted_at |
Insertion time-stamp. | string | date-time | false |
production_task_id |
Bramble production task ID of the queue that this data is for. | integer | true | |
service_level |
Service level percentage, expressed as a fraction between 0 and 1. | number | float | false |
talk_seconds |
Total Time spent actively interacting. | integer | false |
Group
Groups are teams of users in Bramble. Groups are arranged in a tree hierarchy (using parent_group_id).
{
"attributes": {
"inserted_at": "1970-01-01T00:00:00.000000Z",
"name": "North America",
"state": "active",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "54",
"relationships": {
"parent": {
"data": {
"id": "2",
"type": "groups"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/groups/4/relationships/parent"
}
}
},
"type": "groups"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The id of the group. | string | true | |
type |
value is always "groups" | string | true | |
attributes.inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
attributes.name |
The name of the group | string | false | |
attributes.state |
The current status | string | false | |
attributes.updated_at |
The last updated timestamp of this resource. | string | date-time | false |
relationships.parent.data.id |
The unique identifier | string | true | |
relationships.parent.data.type |
string | true | ||
relationships.parent.links.self |
Link for the relationship itself | string | uri | false |
UserPlanEntry
User plan entry is a way to record how someone plans to spend their day.
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The unique ID of the user plan entry. | string | true | |
type |
value is always "user_plan_entries" | string | true | |
attributes.date |
When was this planned to happen? | string | date | false |
attributes.inserted_at |
Insertion time-stamp. | string | date-time | false |
attributes.minutes |
The amount of time spent. Usually a positive integer, but negative values are permitted. | integer | int32 | false |
attributes.type |
Is it a base time, leave or a supporting task? | string | false | |
attributes.updated_at |
Update time-stamp. | string | date-time | false |
relationships.group.data.id |
The unique identifier | string | true | |
relationships.group.data.type |
string | true | ||
relationships.group.links.related |
Link for the relationship itself | string | uri | false |
relationships.group.links.self |
Link for the relationship itself | string | uri | false |
relationships.leave_type.data.id |
The unique identifier | string | true | |
relationships.leave_type.data.type |
string | true | ||
relationships.leave_type.links.related |
Link for the relationship itself | string | uri | false |
relationships.leave_type.links.self |
Link for the relationship itself | string | uri | false |
relationships.supporting_task.data.id |
The unique identifier | string | true | |
relationships.supporting_task.data.type |
string | true | ||
relationships.supporting_task.links.related |
Link for the relationship itself | string | uri | false |
relationships.supporting_task.links.self |
Link for the relationship itself | string | uri | false |
relationships.user.data.id |
The unique identifier | string | true | |
relationships.user.data.type |
string | true | ||
relationships.user.links.related |
Link for the relationship itself | string | uri | false |
relationships.user.links.self |
Link for the relationship itself | string | uri | false |
relationships.user_plan.data.id |
The unique identifier | string | true | |
relationships.user_plan.data.type |
string | true | ||
relationships.user_plan.links.related |
Link for the relationship itself | string | uri | false |
relationships.user_plan.links.self |
Link for the relationship itself | string | uri | false |
CostCategory
Cost Categories provide additional insight and delineation of organizational production costs i.e how much it's costing to complete work for Category 'X' versus 'Y'.
{
"attributes": {
"description": "sample description",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"name": "Auto",
"state": "active",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "54",
"type": "cost_categories"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The id of the cost category. | string | true | |
type |
value is always "cost_categories" | string | true | |
attributes.description |
The description of the cost category | string | false | |
attributes.inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
attributes.name |
The name of the cost category | string | false | |
attributes.state |
The current state | string | false | |
attributes.updated_at |
The last updated timestamp of this resource. | string | date-time | false |
FrictionType
Friction is defined as any obstacle, process, task or system that does not add value in the eyes of the customer.
{
"category": "downtime",
"id": "32",
"inserted_at": "2023-08-01T06:00:47Z",
"name": "Computer issues",
"state": "active",
"type": "friction_types",
"updated_at": "2023-08-01T06:00:47Z"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
category |
Friction category | string | false | |
id |
Bramble internal friction type id | string | false | |
inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
name |
The friction type's name. | string | false | |
state |
The friction type's state. | string | false | |
type |
always "friction_types" | string | false | |
updated_at |
The last updated timestamp of this resource. | string | date-time | false |
CheckinItem
Checkin items are a way to record how a user spends their time during the course of the day.
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The id of the checkin item. | string | true | |
type |
value is always "checkin_items" | string | true | |
attributes.date |
When did this checkin item happen? | string | date | false |
attributes.inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
attributes.minutes |
The amount of time spent on a task or friction type. | number | false | |
attributes.updated_at |
The last updated timestamp of this resource. | string | date-time | false |
attributes.volume |
The number of times a production task was completed. | integer | int32 | false |
relationships.checkin.data.id |
The unique identifier | string | true | |
relationships.checkin.data.type |
string | true | ||
relationships.checkin.links.related |
Link for the relationship itself | string | uri | false |
relationships.checkin.links.self |
Link for the relationship itself | string | uri | false |
relationships.cost_category.data.id |
The unique identifier | string | true | |
relationships.cost_category.data.type |
string | true | ||
relationships.cost_category.links.related |
Link for the relationship itself | string | uri | false |
relationships.cost_category.links.self |
Link for the relationship itself | string | uri | false |
relationships.friction_type.data.id |
The unique identifier | string | true | |
relationships.friction_type.data.type |
string | true | ||
relationships.friction_type.links.related |
Link for the relationship itself | string | uri | false |
relationships.friction_type.links.self |
Link for the relationship itself | string | uri | false |
relationships.leave_type.data.id |
The unique identifier | string | true | |
relationships.leave_type.data.type |
string | true | ||
relationships.leave_type.links.related |
Link for the relationship itself | string | uri | false |
relationships.leave_type.links.self |
Link for the relationship itself | string | uri | false |
relationships.production_task.data.id |
The unique identifier | string | true | |
relationships.production_task.data.type |
string | true | ||
relationships.production_task.links.related |
Link for the relationship itself | string | uri | false |
relationships.production_task.links.self |
Link for the relationship itself | string | uri | false |
relationships.supporting_task.data.id |
The unique identifier | string | true | |
relationships.supporting_task.data.type |
string | true | ||
relationships.supporting_task.links.related |
Link for the relationship itself | string | uri | false |
relationships.supporting_task.links.self |
Link for the relationship itself | string | uri | false |
relationships.user.data.id |
The unique identifier | string | true | |
relationships.user.data.type |
string | true | ||
relationships.user.links.related |
Link for the relationship itself | string | uri | false |
relationships.user.links.self |
Link for the relationship itself | string | uri | false |
ProductionTask
A Production Task represents the primary, measurable, unit of work in a Process
{
"entry_mode": "MANUAL",
"group_id": 1,
"id": 34,
"improvement_category": "rpa",
"inserted_at": "2023-06-14T06:00:47Z",
"name": "Test Task",
"process_id": 1,
"state": "active",
"type": "production_tasks",
"updated_at": "2023-06-14T06:00:47Z"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
entry_mode |
The production task's entry mode. | string | false | |
group_id |
Bramble group identifier. | integer | false | |
id |
Bramble internal production task id | integer | false | |
improvement_category |
production task's CI(continous improvement) category | string | false | |
inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
name |
The production task's name. | string | false | |
process_id |
Bramble process identifier. | integer | false | |
state |
The production task's state. | string | false | |
type |
always "production_tasks" | string | false | |
updated_at |
The last updated timestamp of this resource. | string | date-time | false |
LeaveType
Leave is a period, planned or unplanned, where an employee is not working.
{
"category": "planned_paid",
"id": "42",
"inserted_at": "2023-08-03T07:00:47Z",
"name": "Winter Holiday",
"state": "active",
"type": "leave_types",
"updated_at": "2023-08-03T07:00:47Z"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
category |
Leave category | string | false | |
id |
Bramble internal leave type id | string | false | |
inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
name |
The leave type's name. | string | false | |
state |
The leave type's state. | string | false | |
type |
always "leave_types" | string | false | |
updated_at |
The last updated timestamp of this resource. | string | date-time | false |
User
A user in Bramble, often an Individual Contributor (IC) or Manager. Can also be other system users like Account Owners/Admins. Non-owners/admins are associated with one Group.
{
"attributes": {
"email": "jane-doe12@brmbl.io",
"full_name": "Jane Doe",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"preferred_first_name": "Jane",
"state": "active",
"team_role": "team_contributor",
"timezone": "Africa/Abidjan",
"type": "users",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "23",
"relationships": {
"parent": {
"data": {
"id": "2",
"type": "groups"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/users/4/relationships/group"
}
}
},
"type": "users"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
id |
The id of the user. | string | true | |
type |
value is always "users" | string | true | |
attributes.account_role |
Account-level role | string | false | |
attributes.email |
A user's email. This is a unique value and can be used to find a user via the api/users endpoint. | string | false | |
attributes.full_name |
The user's first and last name. | string | false | |
attributes.inserted_at |
The timestamp of when this resource was created. | string | date-time | false |
attributes.preferred_first_name |
The user's preferred name. | string | false | |
attributes.state |
The current status | string | false | |
attributes.team_role |
Team-level role | string | false | |
attributes.timezone |
The user's preferred timezone. | string | false | |
attributes.type |
value is always "users" | string | false | |
attributes.updated_at |
The last updated timestamp of this resource. | string | date-time | false |
relationships.group.data.id |
The unique identifier | string | true | |
relationships.group.data.type |
string | true | ||
relationships.group.links.self |
Link for the relationship itself | string | uri | false |
Error Models
NotFoundError
{
"errors": [
{
"detail": "The requested resource does not exist.",
"status": 404,
"title": "Resource Not Found"
}
]
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
errors |
array(any) | true |
ConflictError
{
"errors": [
{
"detail": "Must be unique: production_task_id + date",
"source": {
"pointer": "/production_task_id"
},
"title": "Validation Failed"
}
]
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
errors |
array(any) | true |
AuthenticationError
{
"errors": [
{
"detail": "Please check your client id and secret key, and make sure your credentials are active.",
"source": {
"pointer": "header: authorization => id, mac"
},
"title": "Authentication Failed",
"type": "AUTHENTICATION_FAILED"
}
]
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
errors |
array(any) | true |
InternalServerError
{
"errors": [
{
"detail": "Server Error: we could not complete your request",
"title": "Unexpected Server Error",
"type": "UNEXPECTED_ERROR"
}
]
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
errors |
array(any) | true |
IgnoreError
{
"errors": [
{
"detail": "The identity we found is set to be ignored",
"source": {
"pointer": "/source_id/value"
},
"title": "Ignored"
}
]
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
errors |
array(any) | true |
Request Models
AgentQueueMetricsParams
Input parameters for Agent Queue Metrics.
{
"conversations": 3,
"date": "2022-12-13",
"quality_score": 0.8,
"user_id": 3
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
after_call_work_seconds |
Total amount of time the agent spent completing after-call work. | integer | false | |
conversations |
Count of Automatic Call Distributor (ACD) conversations. | integer | true | |
date |
The date of the day that this data is for. | string | date | true |
entry_id |
Bramble CheckinItem(Entry) ID of the CheckinItem that this data is for. | integer | false | |
handle_seconds |
Total time of all conversations, including talk, hold and after call work time | integer | false | |
hold_seconds |
Total time that conversations were placed on hold. | integer | false | |
production_task_id |
Bramble production task ID of the queue that this data is for. | integer | false | |
quality_score |
Call quality percentage, expressed as a fraction between 0 and 1. The quality represents a score without creating an explicit quality_score entity. | number | float | false |
quality_score_id |
Bramble quality score ID of the quality score that this data is for. The quality_score entity is used to represent the achieved quality score. | integer | false | |
talk_seconds |
Total Time spent actively interacting. | integer | false | |
user_id |
Bramble user ID of the agent that this data is for. | integer | true |
SupportingTaskCheckinItemParams
Input parameters for Supporting Task Entries
{
"checkin_id": "1",
"date": "2022-02-23",
"minutes": 450,
"supporting_task_id": 432,
"user_id": "234"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
checkin_id |
The id of the checkin. | string | true | |
date |
When did this checkin item happen? | string | date | true |
minutes |
The amount of time spent on a task or friction type. | number | true | |
supporting_task_id |
Bramble internal supporting task id | string | true | |
user_id |
The id of the user. | string | true |
UserPlanParams
Input parameters for User Plan.
{
"user_id": "3",
"week_number": 1,
"year": 2024
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
contribution |
A percentage (as a floating point number between 0 and 1) rating the persons contribution on the given week | number | float | false |
user_id |
The id of the user. | string | true | |
week_number |
The week number according to ISO-8601 standard | integer | int32 | true |
year |
The year of the where | integer | true |
CheckpointItemParams
CheckpointItem parameters for Inventory Checkpoint Items
{
"amount": 10,
"date": "2024-04-09",
"production_task_id": "432"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
amount |
The amount of the checkpoint item to adjust the checkpoint by. A positive integer. | integer | int32 | true |
date |
When did this checkpoint item event happen? | string | date | true |
production_task_id |
Bramble internal production task id | integer | true |
UserPlanLeaveTypeEntryParams
Input parameters for User Plan Leave Type Entries
{
"date": "2025-05-23",
"leave_type_id": "432",
"minutes": 450,
"type": "leave_type",
"user_id": "234"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
date |
When was this planned to happen? | string | date | true |
leave_type_id |
Bramble internal leave type id | string | true | |
minutes |
The amount of time spent. Usually a positive integer, but negative values are permitted. | integer | int32 | true |
note |
Text notes for the entry | string | false | |
type |
value is always true "leave_type" | string | true | |
user_id |
The id of the user. | string | true |
CheckinItemsParams
Input parameters for Checkin Items, can be either a production task, supporting task, leave type or friction type parameters
{
"oneOf": [
{
"$ref": "#/components/schemas/ProductionTaskCheckinItemParams"
},
{
"$ref": "#/components/schemas/SupportingTaskCheckinItemParams"
},
{
"$ref": "#/components/schemas/FrictionTypeCheckinItemParams"
},
{
"$ref": "#/components/schemas/LeaveTypeCheckinItemParams"
}
]
}
QueueDailyMetricsParams
Input parameters for Queue Daily Metrics.
{
"conversations": 3,
"date": "2022-12-13",
"production_task_id": 3,
"service_level": 0.6
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
after_call_work_seconds |
Total amount of time the agent spent completing after-call work. | integer | false | |
conversations |
Count of Automatic Call Distributor (ACD) conversations. | integer | true | |
date |
The date of the day that this data is for. | string | date | true |
handle_seconds |
Total time of all conversations, including talk, hold and after call work time | integer | false | |
hold_seconds |
Total time that conversations were placed on hold. | integer | false | |
production_task_id |
Bramble production task ID of the queue that this data is for. | integer | true | |
service_level |
Service level percentage, expressed as a fraction between 0 and 1. | number | float | false |
talk_seconds |
Total Time spent actively interacting. | integer | false |
CheckinParams
Input parameters for Checkin
{
"date": "2022-02-23",
"user_id": 432
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
date |
Which day was this checkin created? | string | date | true |
user_id |
The id of the user. | string | true | |
work_location |
where the work is done. | string | false |
LeaveTypeCheckinItemParams
Input parameters for Leave Type Entries
{
"checkin_id": "1",
"date": "2022-02-23",
"leave_type_id": 10,
"minutes": 450,
"user_id": "234"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
checkin_id |
The id of the checkin. | string | true | |
date |
When did this checkin item happen? | string | date | true |
leave_type_id |
Bramble internal leave type id | string | true | |
minutes |
The amount of time spent on a task or friction type. | number | true | |
user_id |
The id of the user. | string | true |
AgentDailyMetricsParams
Input parameters for Agent Daily Metrics.
{
"conversations": 3,
"date": "2022-12-13",
"user_id": 3
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
after_call_work_seconds |
Total amount of time the agent spent completing after-call work. | integer | false | |
aux_seconds |
The total amount of time the agent spent in non-ACD work e.g. breaks, training, meetings etc | integer | false | |
available_seconds |
The total time that the agent was available to take ACD calls | integer | false | |
conversations |
Count of Automatic Call Distributor (ACD) conversations. | integer | false | |
date |
The date of the day that this data is for. | string | date | true |
handle_seconds |
Total time of all conversations, including talk, hold and after call work time | integer | false | |
hold_seconds |
Total time that conversations were placed on hold. | integer | false | |
idle_seconds |
Total idle time. | integer | false | |
staffed_seconds |
The total amount of time the agent spent logged into the ACD system. | integer | false | |
talk_seconds |
Total Time spent actively interacting. | integer | false | |
user_id |
Bramble user ID of the agent that this data is for. | integer | true |
UserPlanBaseTimeEntryParams
Input parameters for User Plan Supporting Task Entries
{
"date": "2022-02-23",
"minutes": 450,
"type": "base_time",
"user_id": "234"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
date |
When was this planned to happen? | string | date | true |
minutes |
The amount of time spent. Usually a positive integer, but negative values are permitted. | integer | int32 | true |
type |
value is always true "base_time" | string | true | |
user_id |
The id of the user. | string | true |
QualityScoreParams
Input params for Quality Score
{
"date": "2022-02-23",
"production_task_id": "456",
"score": 0.95,
"user_id": "234"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
date |
The date for which this score was given | string | date | true |
note |
An optional note. | string | false | |
production_task_id |
Bramble internal production task id | integer | false | |
score |
A percentage (as a floating point number between 0 and 1) rating the persons performance on the given day | number | float | true |
user_id |
The id of the user. | string | true |
UserPlanEntryParams
Input parameters for User Plan Entries, can be either a base time or supporting task parameters
{
"oneOf": [
{
"$ref": "#/components/schemas/UserPlanBaseTimeEntryParams"
},
{
"$ref": "#/components/schemas/UserPlanLeaveTypeEntryParams"
},
{
"$ref": "#/components/schemas/UserPlanSupportingTaskEntryParams"
}
]
}
FrictionTypeCheckinItemParams
Input parameters for Friction Type Entries
{
"checkin_id": "1",
"date": "2022-02-23",
"friction_type_id": 10,
"minutes": 450,
"user_id": "234"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
checkin_id |
The id of the checkin. | string | true | |
date |
When did this checkin item happen? | string | date | true |
friction_type_id |
Bramble internal friction type id | string | true | |
minutes |
The amount of time spent on a task or friction type. | number | true | |
user_id |
The id of the user. | string | true |
ProductionTaskCheckinItemParams
Input parameters for Production Task Entries
{
"checkin_id": "1",
"date": "2022-02-23",
"production_task_id": 432,
"user_id": "234",
"volume": 1
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
checkin_id |
The id of the checkin. | string | true | |
cost_category_id |
The id of the cost category. | string | false | |
date |
When did this checkin item happen? | string | date | true |
production_task_id |
Bramble internal production task id | integer | true | |
user_id |
The id of the user. | string | true | |
volume |
The number of times a production task was completed. | integer | int32 | true |
ServiceLevelParams
Input params for a Service Level
{
"date": "2022-02-23",
"production_task_id": "34",
"score": 0.55
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
date |
Which day was this score given? | string | date | true |
note |
An optional note. | string | false | |
production_task_id |
Bramble internal production task id | integer | true | |
score |
A percentage (as a floating point number between 0 and 1) rating a production task's service level for this date. | number | float | true |
UserPlanSupportingTaskEntryParams
Input parameters for User Plan Supporting Task Entries
{
"date": "2022-02-23",
"minutes": 450,
"supporting_task_id": "432",
"type": "supporting_task",
"user_id": "234"
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
date |
When was this planned to happen? | string | date | true |
minutes |
The amount of time spent. Usually a positive integer, but negative values are permitted. | integer | int32 | true |
supporting_task_id |
Bramble internal supporting task id | string | true | |
type |
value is always true "supporting_task" | string | true | |
user_id |
The id of the user. | string | true |
Response Models
LeaveTypesResponse
Leave Type List Response
{
"data": [
{
"category": "planned_paid",
"id": "42",
"inserted_at": "2023-08-03T07:00:47Z",
"name": "Winter Holiday",
"state": "active",
"type": "leave_types",
"updated_at": "2023-08-03T07:00:47Z"
}
],
"meta": {
"pagination": {
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Generic Data Wrapper | array(any) | false | |
meta.pagination.count |
Number of records in the current page | integer | int64 | false |
meta.pagination.current_page |
Current page number | integer | int64 | false |
meta.pagination.per_page |
Number of records per page | integer | int64 | false |
meta.pagination.total |
Total number of records | integer | int64 | false |
meta.pagination.total_pages |
Total number of pages | integer | int64 | false |
ProductionTaskResponse
Production Task Response
{
"data": {
"attributes": {
"entry_mode": "MANUAL",
"improvement_category": "rpa",
"inserted_at": "2023-06-14T06:00:47Z",
"name": "Test Task",
"state": "active",
"updated_at": "2023-06-14T06:00:47Z"
},
"id": "14150",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/production_tasks/14150"
},
"relationships": {},
"type": "production_tasks"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/production_tasks/14150"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
ProductionTask | false |
UsersResponse
User List Response
{
"data": [
{
"attributes": {
"email": "jane-doe12@brmbl.io",
"full_name": "Jane Doe",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"preferred_first_name": "Jane",
"state": "active",
"team_role": "team_contributor",
"timezone": "Africa/Abidjan",
"type": "users",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "23",
"relationships": {
"parent": {
"data": {
"id": "2",
"type": "groups"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/users/4/relationships/group"
}
}
},
"type": "users"
}
]
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Generic Data Wrapper | array(any) | false |
UserResponse
User Response
{
"data": {
"attributes": {
"email": "jane-doe12@brmbl.io",
"full_name": "Jane Doe",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"preferred_first_name": "Jane",
"state": "active",
"team_role": "team_contributor",
"timezone": "Africa/Abidjan",
"type": "users",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "23",
"relationships": {
"parent": {
"data": {
"id": "2",
"type": "groups"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/users/4/relationships/group"
}
}
},
"type": "users"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
User | false |
UserPlanResponse
User Plan Response.
{
"data": {
"attributes": {
"contribution": 0.95,
"from": "2023-12-18",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"until": "2023-12-24",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "23",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plans/4"
},
"relationships": {
"group": {
"data": {
"id": "2",
"type": "groups"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/groups/2",
"self": "https://api.COMPANY.brmbl.io/v1/user_plans/4/relationships/group"
}
},
"user": {
"data": {
"id": "2",
"type": "users"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/users/2",
"self": "https://api.COMPANY.brmbl.io/v1/user_plans/4/relationships/user"
}
}
},
"type": "user_plans"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/user_plans/1055"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data.user_plans |
UserPlan | false |
QualityScoresResponse
Quality Score List Response
{
"data": [
{
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"note": null,
"score": 0.95,
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "281",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4"
},
"relationships": {
"production_task": {
"data": {
"id": "2",
"type": "production_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
"self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4/relationships/production_task"
}
},
"user": {
"data": {
"id": "2",
"type": "users"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/users/2",
"self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4/relationships/user"
}
}
},
"type": "quality_scores"
}
],
"meta": {
"pagination": {
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Generic Data Wrapper | array(any) | false | |
meta.pagination.count |
Number of records in the current page | integer | int64 | false |
meta.pagination.current_page |
Current page number | integer | int64 | false |
meta.pagination.per_page |
Number of records per page | integer | int64 | false |
meta.pagination.total |
Total number of records | integer | int64 | false |
meta.pagination.total_pages |
Total number of pages | integer | int64 | false |
CostCategoryResponse
A Bramble Cost Category.
{
"data": {
"attributes": {
"description": "sample description",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"name": "Auto",
"state": "active",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "54",
"type": "cost_categories"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
CostCategory | false |
SupportingTasksResponse
Supporting Task List Response
{
"data": [
{
"category": "meeting",
"id": "32",
"inserted_at": "2023-06-14T06:00:47Z",
"name": "Test supporting task",
"state": "active",
"type": "supporting_tasks",
"updated_at": "2023-06-14T06:00:47Z"
}
],
"meta": {
"pagination": {
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Generic Data Wrapper | array(any) | false | |
meta.pagination.count |
Number of records in the current page | integer | int64 | false |
meta.pagination.current_page |
Current page number | integer | int64 | false |
meta.pagination.per_page |
Number of records per page | integer | int64 | false |
meta.pagination.total |
Total number of records | integer | int64 | false |
meta.pagination.total_pages |
Total number of pages | integer | int64 | false |
AgentDailyMetricsResponse
Agent Daily Metrics Response.
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"aux_seconds": null,
"available_seconds": null,
"conversations": 3,
"date": "2022-12-13",
"handle_seconds": null,
"hold_seconds": null,
"idle_seconds": null,
"staffed_seconds": null,
"talk_seconds": null,
"user_id": 123
},
"id": "755",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/755"
},
"relationships": {},
"type": "agent_daily_metrics"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/755"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data.agent_daily_metrics |
AgentDailyMetrics | false |
SupportingTaskResponse
Supporting Task Response
{
"data": {
"category": "meeting",
"id": "32",
"inserted_at": "2023-06-14T06:00:47Z",
"name": "Test supporting task",
"state": "active",
"type": "supporting_tasks",
"updated_at": "2023-06-14T06:00:47Z"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
SupportingTask | false |
UserPlanSupportingTaskEntryResponse
User Plan Supporting Task Entry Response
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"minutes": 450,
"type": "supporting_task",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "54",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4"
},
"relationships": {
"group": {
"data": {
"id": "1",
"type": "groups"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/group"
}
},
"supporting_task": {
"data": {
"id": "2",
"type": "supporting_tasks"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/supporting_task"
}
},
"user": {
"data": {
"id": "1",
"type": "users"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/user"
}
},
"user_plan": {
"data": {
"id": "1",
"type": "user_plans"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/user_plan"
}
}
},
"type": "user_plan_entries"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
UserPlanEntry | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |
GroupsResponse
Group List Response
{
"data": [
{
"attributes": {
"inserted_at": "1970-01-01T00:00:00.000000Z",
"name": "North America",
"state": "active",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "54",
"relationships": {
"parent": {
"data": {
"id": "2",
"type": "groups"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/groups/4/relationships/parent"
}
}
},
"type": "groups"
}
],
"meta": {
"pagination": {
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Generic Data Wrapper | array(any) | false | |
meta.pagination.count |
Number of records in the current page | integer | int64 | false |
meta.pagination.current_page |
Current page number | integer | int64 | false |
meta.pagination.per_page |
Number of records per page | integer | int64 | false |
meta.pagination.total |
Total number of records | integer | int64 | false |
meta.pagination.total_pages |
Total number of pages | integer | int64 | false |
UserPlanLeaveTypeEntryResponse
User Plan Leave Type Entry Response
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"minutes": 450,
"type": "leave_type",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "54",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4"
},
"relationships": {
"group": {
"data": {
"id": "1",
"type": "groups"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/group"
}
},
"leave_plan": {
"data": {
"id": "2",
"type": "leave_plans"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/leave_plan"
}
},
"user": {
"data": {
"id": "1",
"type": "users"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/user"
}
},
"user_plan": {
"data": {
"id": "1",
"type": "user_plans"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/user_plan"
}
}
},
"type": "user_plan_entries"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
UserPlanEntry | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |
CheckinItemsResponse
Checkin Items List Response
{
"data": [
{
"attributes": {
"date": "2020-04-20",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"minutes": 0,
"updated_at": "1970-01-01T00:00:00.000000Z",
"volume": 0
},
"id": "",
"relationships": {
"checkin": {
"data": {
"id": "123",
"type": "checkins"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/checkins/123",
"self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/checkin"
}
},
"cost_category": {
"data": {
"id": "123",
"type": "cost_categories"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/cost_categories/123",
"self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/cost_category"
}
},
"friction_type": {
"data": {
"id": "123",
"type": "friction_types"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/friction_types/123",
"self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/friction_type"
}
},
"leave_type": {
"data": {
"id": "123",
"type": "leave_types"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/leave_types/123",
"self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/leave_type"
}
},
"production_task": {
"data": {
"id": "123",
"type": "production_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/production_tasks/123",
"self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/production_task"
}
},
"supporting_task": {
"data": {
"id": "123",
"type": "supporting_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/supporting_tasks/123",
"self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/supporting_task"
}
},
"user": {
"data": {
"id": "123",
"type": "users"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/users/123",
"self": "https://api.COMPANY.brmbl.io/checkin_items/1/relationships/user"
}
}
},
"type": "checkin_items"
}
],
"meta": {
"pagination": {
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Generic Data Wrapper | array(any) | false | |
meta.pagination.count |
Number of records in the current page | integer | int64 | false |
meta.pagination.current_page |
Current page number | integer | int64 | false |
meta.pagination.per_page |
Number of records per page | integer | int64 | false |
meta.pagination.total |
Total number of records | integer | int64 | false |
meta.pagination.total_pages |
Total number of pages | integer | int64 | false |
FrictionTypeResponse
Friction Type Response
{
"data": {
"category": "downtime",
"id": "32",
"inserted_at": "2023-08-01T06:00:47Z",
"name": "Computer issues",
"state": "active",
"type": "friction_types",
"updated_at": "2023-08-01T06:00:47Z"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
FrictionType | false |
LeaveTypeCheckinItemResponse
Leave Type Item Response
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"minutes": 30,
"updated_at": "2023-01-01T00:00:00.000000Z",
"volume": null
},
"id": "54",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
},
"relationships": {
"checkin": {
"data": {
"id": "1",
"type": "checkins"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/checkin"
}
},
"leave_type": {
"data": {
"id": "2",
"type": "leave_types"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/leave_type"
}
},
"user": {
"data": {
"id": "1",
"type": "users"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
CheckinItem | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |
CheckinItemResponse
Can either be a Production Task, Supporting Task, Leave Type or Friction Type Item response
{
"oneOf": [
{
"$ref": "#/components/schemas/ProductionTaskCheckinItemResponse"
},
{
"$ref": "#/components/schemas/SupportingTaskCheckinItemResponse"
},
{
"$ref": "#/components/schemas/FrictionTypeCheckinItemResponse"
},
{
"$ref": "#/components/schemas/LeaveTypeCheckinItemResponse"
}
]
}
SupportingTaskCheckinItemResponse
Supporting Task Item Response
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"minutes": 450,
"updated_at": "2023-01-01T00:00:00.000000Z",
"volume": null
},
"id": "54",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
},
"relationships": {
"checkin": {
"data": {
"id": "1",
"type": "checkins"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/checkin"
}
},
"supporting_task": {
"data": {
"id": "2",
"type": "supporting_tasks"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/supporting_task"
}
},
"user": {
"data": {
"id": "1",
"type": "users"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
CheckinItem | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |
UserPlanEntryResponse
Can either be a planned base time, supporting task or leave type entry response
{
"oneOf": [
{
"$ref": "#/components/schemas/UserPlanBaseTimeEntryResponse"
},
{
"$ref": "#/components/schemas/UserPlanSupportingTaskEntryResponse"
},
{
"$ref": "#/components/schemas/UserPlanLeaveTypeEntryResponse"
}
]
}
ServiceLevelsResponse
Service Level List Response
{
"data": [
{
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"note": null,
"score": 0.55,
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "281",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/service_levels/4"
},
"relationships": {
"production_task": {
"data": {
"id": "2",
"type": "production_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
"self": "https://api.COMPANY.brmbl.io/v1/service_levels/4/relationships/production_task"
}
}
},
"type": "service_levels"
}
],
"meta": {
"pagination": {
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Generic Data Wrapper | array(any) | false | |
meta.pagination.count |
Number of records in the current page | integer | int64 | false |
meta.pagination.current_page |
Current page number | integer | int64 | false |
meta.pagination.per_page |
Number of records per page | integer | int64 | false |
meta.pagination.total |
Total number of records | integer | int64 | false |
meta.pagination.total_pages |
Total number of pages | integer | int64 | false |
AgentQueueMetricsResponse
Agent Queue Metrics Response.
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"conversations": 3,
"date": "2022-12-13",
"entry_id": 104181,
"handle_seconds": null,
"hold_seconds": null,
"production_task_id": 25473,
"quality": null,
"talk_seconds": null,
"user_id": 1669
},
"id": "1055",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1055"
},
"relationships": {
"checkin_item": {
"data": {
"id": "107190",
"type": "checkin_items"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/checkin_items/107190",
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1132/relationships/checkin_item"
}
},
"quality_score": {
"data": {
"id": "711",
"type": "quality_scores"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/quality_scores/711",
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1132/relationships/quality_score"
}
}
},
"type": "agent_queue_metrics"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/1055"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data.agent_queue_metrics |
AgentQueueMetrics | false |
UserPlanBaseTimeEntryResponse
User Plan Base Time Entry Response
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"minutes": 450,
"type": "base_time",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "54",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4"
},
"relationships": {
"group": {
"data": {
"id": "1",
"type": "groups"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/group"
}
},
"user": {
"data": {
"id": "1",
"type": "users"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/user"
}
},
"user_plan": {
"data": {
"id": "1",
"type": "user_plans"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4/relationships/user_plan"
}
}
},
"type": "user_plan_entries"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/user_plan_entries/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
UserPlanEntry | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |
JsonErrorResponse
Property | Description | Type | Format | Required |
---|---|---|---|---|
errors |
array(any) | true |
CheckpointItemResponse
Checkpoint Item Response
{
"data": {
"attributes": {
"amount": 5,
"date": "2024-04-09",
"inserted_at": "2024-04-09T00:00:00.000000Z",
"updated_at": "2024-04-09T00:00:00.000000Z"
},
"id": "281",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/281"
},
"relationships": {
"checkpoint": {
"data": {
"id": "3",
"type": "checkpoints"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoints/3",
"self": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/281/relationships/checkpoint"
}
},
"production_task": {
"data": {
"id": "2",
"type": "production_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
"self": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/281/relationships/production_task"
}
}
},
"type": "checkpoint_items"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/inventory/checkpoint_item/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
CheckpointItem | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |
FrictionTypeCheckinItemResponse
Friction Type Item Response
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"minutes": 30,
"updated_at": "2023-01-01T00:00:00.000000Z",
"volume": null
},
"id": "54",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
},
"relationships": {
"checkin": {
"data": {
"id": "1",
"type": "checkins"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/checkin"
}
},
"friction_type": {
"data": {
"id": "2",
"type": "friction_types"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/friction_type"
}
},
"user": {
"data": {
"id": "1",
"type": "users"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
CheckinItem | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |
ServiceLevelResponse
Service Level Response
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"note": null,
"score": 0.55,
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "281",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/service_levels/4"
},
"relationships": {
"production_task": {
"data": {
"id": "2",
"type": "production_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
"self": "https://api.COMPANY.brmbl.io/v1/service_levels/4/relationships/production_task"
}
}
},
"type": "service_levels"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/service_levels/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
ServiceLevel | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |
QueueDailyMetricsResponse
Queue Metrics Response.
{
"data": {
"attributes": {
"after_call_work_seconds": null,
"conversations": 3,
"date": "2022-12-13",
"handle_seconds": null,
"hold_seconds": null,
"queue_id": 25473,
"talk_seconds": null
},
"id": "123",
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/123"
},
"relationships": {
"service_level": {
"data": {
"id": "456",
"type": "service_levels"
},
"links": {
"related": "http://api.COMPANY.brmbl.io/v1/service_levels/456",
"self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/123/relationships/service_level"
}
}
},
"type": "queue_daily_metrics"
},
"included": [],
"links": {
"self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/123"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data.queue_metrics |
QueueDailyMetrics | false |
ProductionTaskCheckinItemResponse
Production Task Entry Response
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"minutes": 60,
"updated_at": "2023-01-01T00:00:00.000000Z",
"volume": 1
},
"id": "54",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
},
"relationships": {
"checkin": {
"data": {
"id": "1",
"type": "checkins"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/checkin"
}
},
"cost_category": {
"data": {
"id": "1",
"type": "cost_categories"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/cost_category"
}
},
"production_task": {
"data": {
"id": "2",
"type": "production_tasks"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/production_task"
}
},
"user": {
"data": {
"id": "1",
"type": "users"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4/relationships/user"
}
}
},
"type": "checkin_items"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkin_items/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
CheckinItem | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |
CheckinResponse
Checkin Response
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"updated_at": "2023-01-01T00:00:00.000000Z",
"work_location": "distributed"
},
"id": "23",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/users/4"
},
"relationships": {
"user": {
"data": {
"id": "2",
"type": "users"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/users/2",
"self": "https://api.COMPANY.brmbl.io/v1/checkins/4/relationships/user"
}
}
},
"type": "checkins"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/checkins/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Checkin | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |
ProductionTasksResponse
Production Task List Response
{
"data": [
{
"entry_mode": "MANUAL",
"group_id": 1,
"id": 34,
"improvement_category": "rpa",
"inserted_at": "2023-06-14T06:00:47Z",
"name": "Test Task",
"process_id": 1,
"state": "active",
"type": "production_tasks",
"updated_at": "2023-06-14T06:00:47Z"
}
],
"meta": {
"pagination": {
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Generic Data Wrapper | array(any) | false | |
meta.pagination.count |
Number of records in the current page | integer | int64 | false |
meta.pagination.current_page |
Current page number | integer | int64 | false |
meta.pagination.per_page |
Number of records per page | integer | int64 | false |
meta.pagination.total |
Total number of records | integer | int64 | false |
meta.pagination.total_pages |
Total number of pages | integer | int64 | false |
CostCategoriesResponse
Cost Categories List Response
{
"data": [
{
"attributes": {
"description": "sample description",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"name": "Auto",
"state": "active",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "54",
"type": "cost_categories"
}
],
"meta": {
"pagination": {
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Generic Data Wrapper | array(any) | false | |
meta.pagination.count |
Number of records in the current page | integer | int64 | false |
meta.pagination.current_page |
Current page number | integer | int64 | false |
meta.pagination.per_page |
Number of records per page | integer | int64 | false |
meta.pagination.total |
Total number of records | integer | int64 | false |
meta.pagination.total_pages |
Total number of pages | integer | int64 | false |
LeaveTypeResponse
Leave Type Response
{
"data": {
"category": "planned_paid",
"id": "42",
"inserted_at": "2023-08-03T07:00:47Z",
"name": "Winter Holiday",
"state": "active",
"type": "leave_types",
"updated_at": "2023-08-03T07:00:47Z"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
LeaveType | false |
FrictionTypesResponse
Friction Type List Response
{
"data": [
{
"category": "downtime",
"id": "32",
"inserted_at": "2023-08-01T06:00:47Z",
"name": "Computer issues",
"state": "active",
"type": "friction_types",
"updated_at": "2023-08-01T06:00:47Z"
}
],
"meta": {
"pagination": {
"count": 2,
"current_page": 1,
"per_page": 2,
"total": 50,
"total_pages": 25
}
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Generic Data Wrapper | array(any) | false | |
meta.pagination.count |
Number of records in the current page | integer | int64 | false |
meta.pagination.current_page |
Current page number | integer | int64 | false |
meta.pagination.per_page |
Number of records per page | integer | int64 | false |
meta.pagination.total |
Total number of records | integer | int64 | false |
meta.pagination.total_pages |
Total number of pages | integer | int64 | false |
GroupResponse
A Bramble Group.
{
"data": {
"attributes": {
"inserted_at": "1970-01-01T00:00:00.000000Z",
"name": "North America",
"state": "active",
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "54",
"relationships": {
"parent": {
"data": {
"id": "2",
"type": "groups"
},
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/groups/4/relationships/parent"
}
}
},
"type": "groups"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
Group | false |
QualityScoreResponse
A User's Quality Score.
{
"data": {
"attributes": {
"date": "2022-02-23",
"inserted_at": "1970-01-01T00:00:00.000000Z",
"note": null,
"score": 0.95,
"updated_at": "2023-01-01T00:00:00.000000Z"
},
"id": "281",
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4"
},
"relationships": {
"production_task": {
"data": {
"id": "2",
"type": "production_tasks"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/production_tasks/2",
"self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4/relationships/production_task"
}
},
"user": {
"data": {
"id": "2",
"type": "users"
},
"links": {
"related": "https://api.COMPANY.brmbl.io/v1/users/2",
"self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4/relationships/user"
}
}
},
"type": "quality_scores"
},
"included": [],
"links": {
"self": "https://api.COMPANY.brmbl.io/v1/quality_scores/4"
}
}
Property | Description | Type | Format | Required |
---|---|---|---|---|
data |
QualityScore | true | ||
included |
Included resource objects (compound documents) | array(any) | false | |
links.self |
Link for the relationship itself | string | uri | false |