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.

You must replace {SUBDOMAIN} with your account subdomain.

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

Not all API endpoints that return collections have support for sorting. Especially endpoints that use marker-based pagination often lack support for sorting the results.

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_iPLNZ25w_kX04LaptJuCYFX03D419Iphv" \
-d @- << EOF

{
  "date": "2022-02-23",
  "user_id": "191503",
  "work_location": null
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:42Z",
      "updated_at": "2024-07-09T03:33:42Z",
      "work_location": null
    },
    "id": "200404",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkins/200404"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "191503",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191503",
          "self": "http://api.COMPANY.brmbl.io/v1/checkins/200404/relationships/user"
        }
      }
    },
    "type": "checkins"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkins/200404"
  }
}

Request: Create a check-in

curl -X POST https://api.COMPANY.brmbl.io/v1/checkins \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_noWekxV1_J8QdFM2k1nWVGHxT10vfBQ9w" \
-d @- << EOF

{
  "date": "2022-02-23",
  "user_id": "191513",
  "work_location": "distributed"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:42Z",
      "updated_at": "2024-07-09T03:33:42Z",
      "work_location": "distributed"
    },
    "id": "200408",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkins/200408"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "191513",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191513",
          "self": "http://api.COMPANY.brmbl.io/v1/checkins/200408/relationships/user"
        }
      }
    },
    "type": "checkins"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkins/200408"
  }
}

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	Unprocessible 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/200398 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_JGd1jNC4_rdG2aQ7Kc8a7TJuzKX3fD2RR" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-07-09T03:33:42Z",
      "updated_at": "2024-07-09T03:33:42Z",
      "work_location": "office"
    },
    "id": "200398",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkins/200398"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "191493",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191493",
          "self": "http://api.COMPANY.brmbl.io/v1/checkins/200398/relationships/user"
        }
      }
    },
    "type": "checkins"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkins/200398"
  }
}

Returns the check-in identified by an internal Bramble ID.

Request

GET /v1/checkins/id/{id}

Parameters

Parameter	Description	In	Type	Required	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	Unprocessible 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/191517/date/2020-01-01 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_hsWUUzKQ_18PFJFRfqGi2iCCOWylsioGW" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-07-09T03:33:42Z",
      "updated_at": "2024-07-09T03:33:42Z",
      "work_location": "office"
    },
    "id": "200410",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkins/200410"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "191517",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191517",
          "self": "http://api.COMPANY.brmbl.io/v1/checkins/200410/relationships/user"
        }
      }
    },
    "type": "checkins"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkins/200410"
  }
}

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	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	Unprocessible 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_8wtxXAcp_VmjJ0LqZDZtE5o2S2YXQI8V3" \
-d @- << EOF

{
  "checkin_id": "200298",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 53282,
  "user_id": "191183",
  "volume": 1
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:36Z",
      "minutes": "10.00",
      "updated_at": "2024-07-09T03:33:36Z",
      "volume": 1
    },
    "id": "343195",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343195"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200298",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200298",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343195/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "53282",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53282",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343195/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "191183",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191183",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343195/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343195"
  }
}

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_djbqQDNv_MGFbgZCbcdbs0AxoEcDJec1s" \
-d @- << EOF

{
  "checkin_id": "200330",
  "cost_category_id": "11730",
  "date": "2022-02-23",
  "production_task_id": 53301,
  "user_id": "191227",
  "volume": 1
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:37Z",
      "minutes": "10.00",
      "updated_at": "2024-07-09T03:33:37Z",
      "volume": 1
    },
    "id": "343220",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343220"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200330",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200330",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343220/relationships/checkin"
        }
      },
      "cost_category": {
        "data": {
          "id": "11730",
          "type": "cost_categories"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/cost_categories/11730",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343220/relationships/cost_category"
        }
      },
      "production_task": {
        "data": {
          "id": "53301",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53301",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343220/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "191227",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191227",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343220/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343220"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Failed to cast value to one of: no schemas validate",
      "source": {
        "pointer": "/"
      },
      "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_AHAWDfyc_Ra0Y8lRDDzYn5bgSa74oXvhA" \
-d @- << EOF

{
  "checkin_id": "200316",
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "34151",
  "user_id": "191208"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:37Z",
      "minutes": "450.00",
      "updated_at": "2024-07-09T03:33:37Z",
      "volume": null
    },
    "id": "343212",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343212"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200316",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200316",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343212/relationships/checkin"
        }
      },
      "supporting_task": {
        "data": {
          "id": "34151",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/34151",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343212/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "191208",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191208",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343212/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343212"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Failed to cast value to one of: no schemas validate",
      "source": {
        "pointer": "/"
      },
      "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_AY8IjUir_XKNP9Ik1lxoeIqKTpjlXQoTx" \
-d @- << EOF

{
  "checkin_id": "200334",
  "date": "2022-02-23",
  "friction_type_id": "22982",
  "minutes": 450,
  "user_id": "191234"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:37Z",
      "minutes": "450.00",
      "updated_at": "2024-07-09T03:33:37Z",
      "volume": null
    },
    "id": "343223",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343223"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200334",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200334",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343223/relationships/checkin"
        }
      },
      "friction_type": {
        "data": {
          "id": "22982",
          "type": "friction_types"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/friction_types/22982",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343223/relationships/friction_type"
        }
      },
      "user": {
        "data": {
          "id": "191234",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191234",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343223/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343223"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Failed to cast value to one of: no schemas validate",
      "source": {
        "pointer": "/"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 409 Conflict

{
  "errors": [
    {
      "detail": "already entered on this day",
      "source": {
        "pointer": ":friction_type_id"
      },
      "title": "Conflict"
    }
  ]
}

Creates user's check-in item for a day, could be a production task, supporting task 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	Unprocessible 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/343191 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_EEh1JCtO_3XqihQO3G5ISkcM7eNnOrntC" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-07-09T03:33:36Z",
      "minutes": "150.00",
      "updated_at": "2024-07-09T03:33:36Z",
      "volume": 15
    },
    "id": "343191",
    "links": {
      "self": "http://company.brmbl.io/v1/checkin_items/343191"
    },
    "relationships": {},
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/checkin_items/343191"
  }
}

Request: Returns a check-in item

curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/343238?include=production_task \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_EFB4G0nA_z37KHtYTUD4QopIyQVwNtjb9" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-07-09T03:33:38Z",
      "minutes": "150.00",
      "updated_at": "2024-07-09T03:33:38Z",
      "volume": 15
    },
    "id": "343238",
    "links": {
      "self": "http://company.brmbl.io/v1/checkin_items/343238"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "53313",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://company.brmbl.io/v1/production_tasks/53313",
          "self": "http://company.brmbl.io/v1/checkin_items/343238/relationships/production_task"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [
    {
      "attributes": {
        "description": "pt-k0vWpiIP",
        "entry_mode": "MANUAL",
        "improvement_category": "rpa",
        "inserted_at": "2024-07-09T03:33:38Z",
        "name": "TaskB",
        "state": "detached",
        "updated_at": "2024-07-09T03:33:38Z"
      },
      "id": "53313",
      "links": {
        "self": "http://company.brmbl.io/v1/production_tasks/53313"
      },
      "relationships": {},
      "type": "production_tasks"
    }
  ],
  "links": {
    "self": "http://company.brmbl.io/v1/checkin_items/343238"
  }
}

Request: Returns a check-in item

curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/343239?include=supporting_task \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_EFB4G0nA_z37KHtYTUD4QopIyQVwNtjb9" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-07-09T03:33:38Z",
      "minutes": "60.00",
      "updated_at": "2024-07-09T03:33:38Z",
      "volume": null
    },
    "id": "343239",
    "links": {
      "self": "http://company.brmbl.io/v1/checkin_items/343239"
    },
    "relationships": {
      "supporting_task": {
        "data": {
          "id": "34165",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://company.brmbl.io/v1/supporting_tasks/34165",
          "self": "http://company.brmbl.io/v1/checkin_items/343239/relationships/supporting_task"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [
    {
      "attributes": {
        "category": "meet",
        "description": "GXSJtWEo",
        "inserted_at": "2024-07-09T03:33:37Z",
        "name": "GXSJtWEo",
        "state": "active",
        "updated_at": "2024-07-09T03:33:37Z"
      },
      "id": "34165",
      "links": {
        "self": "http://company.brmbl.io/v1/supporting_tasks/34165"
      },
      "relationships": {},
      "type": "supporting_tasks"
    }
  ],
  "links": {
    "self": "http://company.brmbl.io/v1/checkin_items/343239"
  }
}

Request: Returns a check-in item

curl -X GET https://api.COMPANY.brmbl.io/v1/checkin_items/343240?include=friction_type \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_EFB4G0nA_z37KHtYTUD4QopIyQVwNtjb9" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-07-09T03:33:38Z",
      "minutes": "30.00",
      "updated_at": "2024-07-09T03:33:38Z",
      "volume": null
    },
    "id": "343240",
    "links": {
      "self": "http://company.brmbl.io/v1/checkin_items/343240"
    },
    "relationships": {
      "friction_type": {
        "data": {
          "id": "22986",
          "type": "friction_types"
        },
        "links": {
          "related": "http://company.brmbl.io/v1/friction_types/22986",
          "self": "http://company.brmbl.io/v1/checkin_items/343240/relationships/friction_type"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [
    {
      "attributes": {
        "category": "interruption",
        "description": "AlHZckLJ",
        "inserted_at": "2024-07-09T03:33:38Z",
        "name": "AlHZckLJ",
        "state": "active",
        "updated_at": "2024-07-09T03:33:38Z"
      },
      "id": "22986",
      "links": {
        "self": "http://company.brmbl.io/v1/friction_types/22986"
      },
      "relationships": {},
      "type": "friction_types"
    }
  ],
  "links": {
    "self": "http://company.brmbl.io/v1/checkin_items/343240"
  }
}

You can fetch the details of a single item.

Request

GET /v1/checkin_items/{id}

Parameters

Parameter	Description	In	Type	Required	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	Unprocessible 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_pdowH2HQ_qschq9BJUnlRIIAjwdMA2nr8" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "date": "2020-01-02",
        "volume": 15
      },
      "id": "343176",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343176"
      },
      "relationships": {},
      "type": "checkin_items"
    },
    {
      "attributes": {
        "date": "2020-01-02",
        "volume": 20
      },
      "id": "343177",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343177"
      },
      "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	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	Unprocessible 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/343201 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_GMZIWUNv_m6e8ZWlj7YAjrHyFpZxv0XUC" \
-d @- << EOF

{
  "checkin_id": "200307",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 53287,
  "user_id": "191195",
  "volume": 1
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:36Z",
      "minutes": "10.00",
      "updated_at": "2024-07-09T03:33:36Z",
      "volume": 1
    },
    "id": "343201",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343201"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200307",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200307",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343201/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "53287",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53287",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343201/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "191195",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191195",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343201/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343201"
  }
}

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/343227 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_CsgOIRXY_eP6SLhxUOYMMexf7RQMtJy5i" \
-d @- << EOF

{
  "checkin_id": "200338",
  "cost_category_id": "11732",
  "date": "2022-02-23",
  "production_task_id": 53306,
  "user_id": "191239",
  "volume": 1
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:37Z",
      "minutes": "10.00",
      "updated_at": "2024-07-09T03:33:37Z",
      "volume": 1
    },
    "id": "343227",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343227"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200338",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200338",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343227/relationships/checkin"
        }
      },
      "cost_category": {
        "data": {
          "id": "11732",
          "type": "cost_categories"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/cost_categories/11732",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343227/relationships/cost_category"
        }
      },
      "production_task": {
        "data": {
          "id": "53306",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53306",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343227/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "191239",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191239",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343227/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343227"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Failed to cast value to one of: no schemas validate",
      "source": {
        "pointer": "/"
      },
      "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/343218 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_0nhDg6sG_hdxuW7PthgdibnXigvz46GnN" \
-d @- << EOF

{
  "checkin_id": "200327",
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "34155",
  "user_id": "191222"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:37Z",
      "minutes": "450.00",
      "updated_at": "2024-07-09T03:33:37Z",
      "volume": null
    },
    "id": "343218",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343218"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200327",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200327",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343218/relationships/checkin"
        }
      },
      "supporting_task": {
        "data": {
          "id": "34155",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/34155",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343218/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "191222",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191222",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343218/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343218"
  }
}

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/343232 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_sSkpxpxB_BAu9oYgimGO0ecnNcGQmF5md" \
-d @- << EOF

{
  "checkin_id": "200343",
  "date": "2022-02-23",
  "friction_type_id": "22985",
  "minutes": 450,
  "user_id": "191245"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:37Z",
      "minutes": "450.00",
      "updated_at": "2024-07-09T03:33:37Z",
      "volume": null
    },
    "id": "343232",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343232"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200343",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200343",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343232/relationships/checkin"
        }
      },
      "friction_type": {
        "data": {
          "id": "22985",
          "type": "friction_types"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/friction_types/22985",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343232/relationships/friction_type"
        }
      },
      "user": {
        "data": {
          "id": "191245",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191245",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343232/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343232"
  }
}

Updates user's check-in item for a day, could be a production task, supporting task or friction type.

Request

PATCH /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	Unprocessible Entity
500	Internal Server Error

Upserts a user's production task, supporting task 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_EygrkYhY_YXohg5k0vKWjs4mgwAypWtP2" \
-d @- << EOF

{
  "checkin_id": "200303",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 53285,
  "user_id": "191190",
  "volume": 1
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:36Z",
      "minutes": "10.00",
      "updated_at": "2024-07-09T03:33:36Z",
      "volume": 1
    },
    "id": "343199",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343199"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200303",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200303",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343199/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "53285",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53285",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343199/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "191190",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191190",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343199/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343199"
  }
}

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_f5v3Qejl_A1sGzhDfnfjz3aEYNW3YwyKT" \
-d @- << EOF

{
  "checkin_id": "200274",
  "cost_category_id": "11716",
  "date": "2022-02-23",
  "production_task_id": 53267,
  "user_id": "191148",
  "volume": 1
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:35Z",
      "minutes": "10.00",
      "updated_at": "2024-07-09T03:33:35Z",
      "volume": 1
    },
    "id": "343169",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343169"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200274",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200274",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343169/relationships/checkin"
        }
      },
      "cost_category": {
        "data": {
          "id": "11716",
          "type": "cost_categories"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/cost_categories/11716",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343169/relationships/cost_category"
        }
      },
      "production_task": {
        "data": {
          "id": "53267",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53267",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343169/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "191148",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191148",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343169/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343169"
  }
}

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_a8Ox9TbN_0n9z8TbpsoPo27Cxmr860RnW" \
-d @- << EOF

{
  "checkin_id": "200353",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 53315,
  "user_id": "191259",
  "volume": 1
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:38Z",
      "minutes": "20.00",
      "updated_at": "2024-07-09T03:33:39Z",
      "volume": 2
    },
    "id": "343244",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343244"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200353",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200353",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343244/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "53315",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53315",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343244/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "191259",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191259",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343244/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343244"
  }
}

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_5eExWJL6_SzPxLhrFd6b2CoL3SAQIA8AI" \
-d @- << EOF

{
  "checkin_id": "200272",
  "cost_category_id": null,
  "date": "2022-02-23",
  "production_task_id": 53266,
  "user_id": "191145",
  "volume": -101
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:35Z",
      "minutes": "1000.00",
      "updated_at": "2024-07-09T03:33:35Z",
      "volume": 100
    },
    "id": "343166",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343166"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200272",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200272",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343166/relationships/checkin"
        }
      },
      "production_task": {
        "data": {
          "id": "53266",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53266",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343166/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "191145",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191145",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343166/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343166"
  }
}

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_OiTl2t5r_WQCjxblic2o5HcmCPMologRL" \
-d @- << EOF

{
  "checkin_id": "200367",
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "34169",
  "user_id": "191277"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:38Z",
      "minutes": "450.00",
      "updated_at": "2024-07-09T03:33:38Z",
      "volume": null
    },
    "id": "343258",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343258"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200367",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200367",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343258/relationships/checkin"
        }
      },
      "supporting_task": {
        "data": {
          "id": "34169",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/34169",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343258/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "191277",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191277",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343258/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343258"
  }
}

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_6VtN0mIz_VCovaPiLf3DI0JCYXJIY09Vu" \
-d @- << EOF

{
  "checkin_id": "200341",
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "34161",
  "user_id": "191243"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:37Z",
      "minutes": "900.00",
      "updated_at": "2024-07-09T03:33:38Z",
      "volume": null
    },
    "id": "343230",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343230"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200341",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200341",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343230/relationships/checkin"
        }
      },
      "supporting_task": {
        "data": {
          "id": "34161",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/34161",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343230/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "191243",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191243",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343230/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343230"
  }
}

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_3k1Qq2yU_64S6EZNhwo6kIOwcAHLG9lAu" \
-d @- << EOF

{
  "checkin_id": "200293",
  "date": "2022-02-23",
  "minutes": -6,
  "supporting_task_id": "34139",
  "user_id": "191174"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:36Z",
      "minutes": "5.00",
      "updated_at": "2024-07-09T03:33:36Z",
      "volume": null
    },
    "id": "343189",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343189"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200293",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200293",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343189/relationships/checkin"
        }
      },
      "supporting_task": {
        "data": {
          "id": "34139",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/34139",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343189/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "191174",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191174",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343189/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343189"
  }
}

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_rVOkrnpB_qdBxPJZZ89kJ3CgC2XPZtDT0" \
-d @- << EOF

{
  "checkin_id": "200309",
  "date": "2022-02-23",
  "friction_type_id": "22979",
  "minutes": 450,
  "user_id": "191197"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:36Z",
      "minutes": "450.00",
      "updated_at": "2024-07-09T03:33:36Z",
      "volume": null
    },
    "id": "343203",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343203"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200309",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200309",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343203/relationships/checkin"
        }
      },
      "friction_type": {
        "data": {
          "id": "22979",
          "type": "friction_types"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/friction_types/22979",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343203/relationships/friction_type"
        }
      },
      "user": {
        "data": {
          "id": "191197",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191197",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343203/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343203"
  }
}

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_w50AR6kb_CQo255LFjlk0Fqsry89KySEO" \
-d @- << EOF

{
  "checkin_id": "200280",
  "date": "2022-02-23",
  "friction_type_id": "22975",
  "minutes": 450,
  "user_id": "191156"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:35Z",
      "minutes": "900.00",
      "updated_at": "2024-07-09T03:33:36Z",
      "volume": null
    },
    "id": "343174",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343174"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200280",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200280",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343174/relationships/checkin"
        }
      },
      "friction_type": {
        "data": {
          "id": "22975",
          "type": "friction_types"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/friction_types/22975",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343174/relationships/friction_type"
        }
      },
      "user": {
        "data": {
          "id": "191156",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191156",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343174/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343174"
  }
}

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_s1WYKFL8_yEsgylfn9mXqgtDTQcraaqtj" \
-d @- << EOF

{
  "checkin_id": "200336",
  "date": "2022-02-23",
  "friction_type_id": "22983",
  "minutes": -6,
  "user_id": "191236"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:37Z",
      "minutes": "5.00",
      "updated_at": "2024-07-09T03:33:37Z",
      "volume": null
    },
    "id": "343225",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343225"
    },
    "relationships": {
      "checkin": {
        "data": {
          "id": "200336",
          "type": "checkins"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkins/200336",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343225/relationships/checkin"
        }
      },
      "friction_type": {
        "data": {
          "id": "22983",
          "type": "friction_types"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/friction_types/22983",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343225/relationships/friction_type"
        }
      },
      "user": {
        "data": {
          "id": "191236",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191236",
          "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343225/relationships/user"
        }
      }
    },
    "type": "checkin_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/checkin_items/343225"
  }
}

Tries to create a user's production task, supporting task 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	Unprocessible 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_MZ9QA60f_mlYOqdNJrjtb04AL7chahsNR" \
-d @- << EOF

{
  "amount": 10,
  "date": "2024-04-09",
  "production_task_id": 53380
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "amount": 10,
      "date": "2024-04-09",
      "external_resource_uri": null,
      "inserted_at": "2024-07-09T03:33:43Z",
      "updated_at": "2024-07-09T03:33:43Z"
    },
    "id": "2603",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2603"
    },
    "relationships": {
      "checkpoint": {
        "data": {
          "id": "8082",
          "type": "checkpoints"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoints/8082",
          "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2603/relationships/checkpoint"
        }
      },
      "production_task": {
        "data": {
          "id": "53380",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53380",
          "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2603/relationships/production_task"
        }
      }
    },
    "type": "checkpoint_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2603"
  }
}

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	Unprocessible 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/2606 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_PT4lPVsb_JKK1mNlPE6UuAKUFs7Q6ezcg" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "amount": 10,
      "date": "2024-01-01",
      "external_resource_uri": null,
      "inserted_at": "2024-07-09T03:33:43Z",
      "updated_at": "2024-07-09T03:33:43Z"
    },
    "id": "2606",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2606"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "53382",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53382",
          "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2606/relationships/production_task"
        }
      }
    },
    "type": "checkpoint_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2606"
  }
}

(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	Unprocessible 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/2605 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_Dulca2xT_cDF8i80qCDfrCRLpRXttWc9T" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "amount": 30,
      "date": "2024-01-01",
      "external_resource_uri": null,
      "inserted_at": "2024-07-09T03:33:43Z",
      "updated_at": "2024-07-09T03:33:43Z"
    },
    "id": "2605",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2605"
    },
    "relationships": {
      "checkpoint": {
        "data": {
          "id": "8085",
          "type": "checkpoints"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoints/8085",
          "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2605/relationships/checkpoint"
        }
      },
      "production_task": {
        "data": {
          "id": "53381",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53381",
          "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2605/relationships/production_task"
        }
      }
    },
    "type": "checkpoint_items"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/inventory/checkpoint_items/2605"
  }
}

You can fetch the details of a single Checkpoint Item.

Request

GET /v1/inventory/checkpoint_items/{id}

Parameters

Parameter	Description	In	Type	Required	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	Unprocessible 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_gdvKyK4e_HG4bH8XiIJxDIdS5kuJfwhfA" \
-d @- << EOF

{
  "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": 191549
}


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": 191549
    },
    "id": "2889",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/2889"
    },
    "relationships": {},
    "type": "agent_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/2889"
  }
}

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	Unprocessible 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_zioj0ym5_uUmLQOjKoqeuPCGwDAYEfwdC" \
-d @- << EOF

{
  "after_call_work_seconds": null,
  "conversations": 3,
  "date": "2022-12-13",
  "handle_seconds": null,
  "hold_seconds": null,
  "production_task_id": 53387,
  "quality_score": 0.8,
  "talk_seconds": null,
  "user_id": 191587
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "conversations": 3,
      "date": "2022-12-13",
      "entry_id": 343292,
      "handle_seconds": null,
      "hold_seconds": null,
      "production_task_id": 53387,
      "talk_seconds": null,
      "user_id": 191587
    },
    "id": "4580",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/4580"
    },
    "relationships": {
      "checkin_item": {
        "data": {
          "id": "343292",
          "type": "checkin_items"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/checkin_items/343292",
          "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/4580/relationships/checkin_item"
        }
      },
      "quality_score": {
        "data": {
          "id": "10352",
          "type": "quality_scores"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/quality_scores/10352",
          "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/4580/relationships/quality_score"
        }
      }
    },
    "type": "agent_queue_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/agent_queue_metrics/4580"
  }
}

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	Unprocessible 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_UEFFsa87_0imPkOATXaDIUkH7t3U0wJQL" \
-d @- << EOF

{
  "after_call_work_seconds": null,
  "conversations": 3,
  "date": "2022-12-13",
  "handle_seconds": null,
  "hold_seconds": null,
  "production_task_id": 53349,
  "service_level": 0.6,
  "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": 53349,
      "talk_seconds": null
    },
    "id": "3100",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/3100"
    },
    "relationships": {
      "service_level": {
        "data": {
          "id": "5525",
          "type": "service_levels"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/service_levels/5525",
          "self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/3100/relationships/service_level"
        }
      }
    },
    "type": "queue_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/queue_daily_metrics/3100"
  }
}

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	Unprocessible 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/2890 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_jxaPzoSV_BzuIjF7E5aIj6nBtzpRk0JsR" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "aux_seconds": null,
      "available_seconds": null,
      "conversations": 513,
      "date": "2024-07-09",
      "handle_seconds": null,
      "hold_seconds": null,
      "idle_seconds": null,
      "staffed_seconds": null,
      "talk_seconds": null,
      "user_id": 191553
    },
    "id": "2890",
    "links": {
      "self": "http://company.brmbl.io/v1/agent_daily_metrics/2890"
    },
    "relationships": {},
    "type": "agent_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/agent_daily_metrics/2890"
  }
}

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	Unprocessible 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/4581 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_OhTutTr7_I2FkcRWsoJJmlR89LGtlJgsx" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "conversations": 11,
      "date": "2024-07-08",
      "entry_id": 343293,
      "handle_seconds": null,
      "hold_seconds": null,
      "production_task_id": 53388,
      "talk_seconds": 500,
      "user_id": 191589
    },
    "id": "4581",
    "links": {
      "self": "http://company.brmbl.io/v1/agent_queue_metrics/4581"
    },
    "relationships": {},
    "type": "agent_queue_metrics"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/agent_queue_metrics/4581"
  }
}

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	Unprocessible 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/3097 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_tGG7h3LD_VYqSgZCzoov9yd8EDORVViPv" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "after_call_work_seconds": null,
      "conversations": 266,
      "date": "2024-07-09",
      "handle_seconds": null,
      "hold_seconds": null,
      "queue_id": 53347,
      "talk_seconds": null
    },
    "id": "3097",
    "links": {
      "self": "http://company.brmbl.io/v1/queue_daily_metrics/3097"
    },
    "relationships": {},
    "type": "queue_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/queue_daily_metrics/3097"
  }
}

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	Unprocessible 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_e0CLakbI_ZCSXPKOzv0QcRJRBiLZzCcu3" \
-d @- << EOF

{
  "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": 191555
}


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": 191555
    },
    "id": "2891",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/2891"
    },
    "relationships": {},
    "type": "agent_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/2891"
  }
}

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_s7y7cPH5_EmrgRdlz5C9pwqx5trzE94Eu" \
-d @- << EOF

{
  "after_call_work_seconds": null,
  "aux_seconds": null,
  "available_seconds": null,
  "conversations": null,
  "date": "2022-12-13",
  "handle_seconds": null,
  "hold_seconds": null,
  "idle_seconds": null,
  "staffed_seconds": 60,
  "talk_seconds": null,
  "user_id": 191541
}


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": 191541
    },
    "id": "2882",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/2882"
    },
    "relationships": {},
    "type": "agent_daily_metrics"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/agent_daily_metrics/2882"
  }
}

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	Unprocessible 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/11746 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_8AzKTjFW_JrXu1VimMGBu6Ycm34qVVzcP" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "description": "pt-EofdBVmk",
      "inserted_at": "2024-07-09T03:33:44Z",
      "name": "Auto",
      "state": "active",
      "updated_at": "2024-07-09T03:33:44Z"
    },
    "id": "11746",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/cost_categories/11746"
    },
    "relationships": {},
    "type": "cost_categories"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/cost_categories/11746"
  }
}

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	Unprocessible 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_0uVqpCkW_aO6VD6iiTyeU97ZlGsScWGEI" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "name": "Auto",
        "state": "active"
      },
      "id": "11744",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/cost_categories/11744"
      },
      "relationships": {},
      "type": "cost_categories"
    },
    {
      "attributes": {
        "name": "Property",
        "state": "active"
      },
      "id": "11745",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/cost_categories/11745"
      },
      "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	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	Unprocessible 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/23004 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_Xy4VwXTb_g9BgoLn7xkWgqzUzuicqBXHJ" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "category": "downtime",
      "description": "hlqsXvhe",
      "inserted_at": "2024-07-09T03:33:44Z",
      "name": "Power Outage",
      "state": "active",
      "updated_at": "2024-07-09T03:33:44Z"
    },
    "id": "23004",
    "links": {
      "self": "http://www.example.com/v1/friction_types/23004"
    },
    "relationships": {},
    "type": "friction_types"
  },
  "included": [],
  "links": {
    "self": "http://www.example.com/v1/friction_types/23004"
  }
}

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	Unprocessible 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_ScXdxieG_7bqXrfti0wZDlkWOYo7AfW1L" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "category": "downtime",
        "description": "tZ7DWWrA",
        "inserted_at": "2024-07-09T03:33:44Z",
        "name": "Power Outage",
        "state": "active",
        "updated_at": "2024-07-09T03:33:44Z"
      },
      "id": "22994",
      "links": {
        "self": "http://www.example.com/v1/friction_types/22994"
      },
      "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	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	Unprocessible Entity
500	Internal Server Error

Groups

Retrieve a group

Request: Returns a group

curl -X GET https://api.COMPANY.brmbl.io/v1/groups/177051?include=users \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_o3BAmOol_fmXchFe84svhdsPRJeKm2dnP" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "inserted_at": "2024-07-09T03:33:41Z",
      "name": "Sales",
      "state": "active",
      "updated_at": "2024-07-09T03:33:41Z"
    },
    "id": "177051",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/groups/177051"
    },
    "relationships": {
      "users": {
        "data": [
          {
            "id": "191438",
            "type": "users"
          }
        ],
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users",
          "self": "http://api.COMPANY.brmbl.io/v1/groups/177051/relationships/users"
        }
      }
    },
    "type": "groups"
  },
  "included": [
    {
      "attributes": {
        "account_role": null,
        "email": "dianna.wolf@osinski.org",
        "full_name": "Some User",
        "inserted_at": "2024-07-09T03:33:41Z",
        "preferred_first_name": "Some",
        "state": "new",
        "team_role": "team_contributor",
        "timezone": "Etc/UTC",
        "updated_at": "2024-07-09T03:33:41Z"
      },
      "id": "191438",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/users/191438"
      },
      "relationships": {},
      "type": "users"
    }
  ],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/groups/177051"
  }
}

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	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	Unprocessible 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=177052&page[number]=1&page[size]=2&sort=name&fields[groups]=name,state \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_4HCxYR1j_hnu5y3Ti67Na81ey83OhbeKW" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "name": "division",
        "state": "active"
      },
      "id": "177053",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/groups/177053"
      },
      "relationships": {},
      "type": "groups"
    },
    {
      "attributes": {
        "name": "root",
        "state": "active"
      },
      "id": "177052",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/groups/177052"
      },
      "relationships": {},
      "type": "groups"
    }
  ],
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/groups?ancestors_id=177052&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	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	Unprocessible 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/13244 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_yFwaMj9w_5MRXpR8DesJ09Yb8HrDbEYdg" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "category": "unplanned_paid",
      "description": "fUL0D+Vm",
      "inserted_at": "2024-07-09T03:33:43Z",
      "name": "Kid Sickness",
      "state": "active",
      "updated_at": "2024-07-09T03:33:43Z"
    },
    "id": "13244",
    "links": {
      "self": "http://www.example.com/v1/leave_types/13244"
    },
    "relationships": {},
    "type": "leave_types"
  },
  "included": [],
  "links": {
    "self": "http://www.example.com/v1/leave_types/13244"
  }
}

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	Unprocessible 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_1W77uaDJ_i1OH8n7DrHbusDgNCiRp1QnP" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "category": "unplanned_paid",
        "description": "h8s4un0u",
        "inserted_at": "2024-07-09T03:33:43Z",
        "name": "Kid Sickness",
        "state": "active",
        "updated_at": "2024-07-09T03:33:43Z"
      },
      "id": "13234",
      "links": {
        "self": "http://www.example.com/v1/leave_types/13234"
      },
      "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	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	Unprocessible 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/53369 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_KOscU72L_x4tSfxxFIH2IqDmneDss8z5v" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "description": "pt-snw9n2/c",
      "entry_mode": "MANUAL",
      "improvement_category": "rpa",
      "inserted_at": "2024-07-09T03:33:42Z",
      "name": "Customer Outreach",
      "state": "active",
      "updated_at": "2024-07-09T03:33:42Z"
    },
    "id": "53369",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/production_tasks/53369"
    },
    "relationships": {},
    "type": "production_tasks"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/production_tasks/53369"
  }
}

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	Unprocessible 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=core \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_7RaUMKMm_90Zi2rtvJ8ciF4wfYAopayNH" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "description": "pt-QTAlBkqc",
        "entry_mode": "MANUAL",
        "improvement_category": "core",
        "inserted_at": "2024-07-09T03:33:42Z",
        "name": "Lodge Claim",
        "state": "active",
        "updated_at": "2024-07-09T03:33:42Z"
      },
      "id": "53359",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/production_tasks/53359"
      },
      "relationships": {
        "process": {
          "data": {
            "id": "29335",
            "type": "process"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/process/29335",
            "self": "http://api.COMPANY.brmbl.io/v1/production_tasks/53359/relationships/process"
          }
        }
      },
      "type": "production_tasks"
    }
  ],
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/production_tasks?improvement_category=core"
  },
  "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	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	core,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	Unprocessible 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_jHvktr62_L1I1mTwFp3QwSwLJGnboJJdG" \
-d @- << EOF

{
  "date": "2022-02-23",
  "note": null,
  "production_task_id": null,
  "score": 0.95,
  "user_id": "191470"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:42Z",
      "note": null,
      "score": 0.95,
      "updated_at": "2024-07-09T03:33:42Z"
    },
    "id": "10335",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10335"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "191470",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191470",
          "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10335/relationships/user"
        }
      }
    },
    "type": "quality_scores"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10335"
  }
}

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_f67tfLYo_UERHqCr2G1rpZKihpejAcYRZ" \
-d @- << EOF

{
  "date": "2022-02-23",
  "note": null,
  "production_task_id": 53356,
  "score": 0.95,
  "user_id": "191460"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:42Z",
      "note": null,
      "score": 0.95,
      "updated_at": "2024-07-09T03:33:42Z"
    },
    "id": "10327",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10327"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "53356",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53356",
          "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10327/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "191460",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191460",
          "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10327/relationships/user"
        }
      }
    },
    "type": "quality_scores"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10327"
  }
}

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	Unprocessible 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/10322 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_otRzrn94_ucbpZlb5KN27WuceThFOYuGb" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2024-07-09",
      "inserted_at": "2024-07-09T03:33:41Z",
      "note": null,
      "score": 0.5,
      "updated_at": "2024-07-09T03:33:41Z"
    },
    "id": "10322",
    "links": {
      "self": "http://company.brmbl.io/v1/quality_scores/10322"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "53354",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://company.brmbl.io/v1/production_tasks/53354",
          "self": "http://company.brmbl.io/v1/quality_scores/10322/relationships/production_task"
        }
      },
      "user": {
        "data": {
          "id": "191454",
          "type": "users"
        },
        "links": {
          "related": "http://company.brmbl.io/v1/users/191454",
          "self": "http://company.brmbl.io/v1/quality_scores/10322/relationships/user"
        }
      }
    },
    "type": "quality_scores"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/quality_scores/10322"
  }
}

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	Unprocessible 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/10341 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_lrgkHeJ0_Lxb3iRXuZZLv5F1yKRBohomy" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2023-01-01",
      "inserted_at": "2024-07-09T03:33:42Z",
      "note": null,
      "score": 0.5,
      "updated_at": "2024-07-09T03:33:42Z"
    },
    "id": "10341",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10341"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "191479",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191479",
          "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10341/relationships/user"
        }
      }
    },
    "type": "quality_scores"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10341"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "Could not find quality score with id: 10335",
      "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	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	Unprocessible 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_gZvx1Tty_C8hB7VQuQN6QqAUZC6ZjF5nE" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "date": "2023-01-02",
        "score": 0.25
      },
      "id": "10336",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10336"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "191472",
            "type": "users"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/users/191472",
            "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10336/relationships/user"
          }
        }
      },
      "type": "quality_scores"
    },
    {
      "attributes": {
        "date": "2023-01-02",
        "score": 0.5
      },
      "id": "10337",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10337"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "191473",
            "type": "users"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/users/191473",
            "self": "http://api.COMPANY.brmbl.io/v1/quality_scores/10337/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	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	Unprocessible 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_02u9ghWu_8kBSEcwRuB45Pyczmfpxv78f" \
-d @- << EOF

{
  "date": "2022-02-23",
  "note": null,
  "production_task_id": 53334,
  "score": 0.55
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:38Z",
      "note": null,
      "score": 0.55,
      "updated_at": "2024-07-09T03:33:38Z"
    },
    "id": "5507",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5507"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "53334",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53334",
          "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5507/relationships/production_task"
        }
      }
    },
    "type": "service_levels"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5507"
  }
}

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_cxvCQNLH_d4T4N1fi2H3YJntrmFV7Iugc" \
-d @- << EOF

{
  "date": "2022-02-23",
  "note": null,
  "production_task_id": 53337,
  "score": 0.55
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:38Z",
      "note": null,
      "score": 0.55,
      "updated_at": "2024-07-09T03:33:38Z"
    },
    "id": "5512",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5512"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "53337",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53337",
          "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5512/relationships/production_task"
        }
      }
    },
    "type": "service_levels"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5512"
  }
}

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	Unprocessible 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/5519 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_VTd9W3MI_RZRuhLSWmcGDaarQgqI9YPsY" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-07-09T03:33:39Z",
      "note": null,
      "score": 0.1,
      "updated_at": "2024-07-09T03:33:39Z"
    },
    "id": "5519",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5519"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "53343",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53343",
          "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5519/relationships/production_task"
        }
      }
    },
    "type": "service_levels"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5519"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "Could not find service level with id: 5496",
      "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	Unprocessible 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/5514 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_s2EQDPOL_lsdfn8NcbLWmSafzUR2NUfgt" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2020-01-01",
      "inserted_at": "2024-07-09T03:33:38Z",
      "note": null,
      "score": 0.1,
      "updated_at": "2024-07-09T03:33:38Z"
    },
    "id": "5514",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5514"
    },
    "relationships": {
      "production_task": {
        "data": {
          "id": "53339",
          "type": "production_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53339",
          "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5514/relationships/production_task"
        }
      }
    },
    "type": "service_levels"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5514"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "Could not find service level with id: 5507",
      "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	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	Unprocessible 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_mlf4JFUY_rNll5vNPojls0fgFYeoWcmDI" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "score": 0.9
      },
      "id": "5509",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5509"
      },
      "relationships": {
        "production_task": {
          "data": {
            "id": "53336",
            "type": "production_tasks"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53336",
            "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5509/relationships/production_task"
          }
        }
      },
      "type": "service_levels"
    },
    {
      "attributes": {
        "score": 0.5
      },
      "id": "5508",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5508"
      },
      "relationships": {
        "production_task": {
          "data": {
            "id": "53335",
            "type": "production_tasks"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/production_tasks/53335",
            "self": "http://api.COMPANY.brmbl.io/v1/service_levels/5508/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	Example
`date`	Filter results scored for this date	query	array	false	2022-02-28,2022-02-29
`fields`	Comma separated list of fields to return.	query	object	false
`include`	Comma separated list of relationships to include.	query	array	false	production_task
`page`		query	Page	false
`production_task_id`	Filter results by task id	query	array	false	12
`sort`	Comma separated list of fields to sort by. Prefixing a field with a minus sign (-) sorts descending.	query	array	false	-date,-score

Responses

Status	Description	Schema
200	Service Levels
401	Authentication Error
410	Ignored
422	Unprocessible 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/34186 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_IX7sj5jn_RA1BOZRM96HddbkMjhTiM1uy" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "category": "train",
      "description": "ZKiVsKkH",
      "inserted_at": "2024-07-09T03:33:41Z",
      "name": "Compliance Training",
      "state": "active",
      "updated_at": "2024-07-09T03:33:41Z"
    },
    "id": "34186",
    "links": {
      "self": "http://www.example.com/v1/supporting_tasks/34186"
    },
    "relationships": {},
    "type": "supporting_tasks"
  },
  "included": [],
  "links": {
    "self": "http://www.example.com/v1/supporting_tasks/34186"
  }
}

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	Unprocessible 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_6JBgLhgh_WUmEO3sZc4iyz0veuucglJ1v" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "category": "train",
        "description": "I00qUEKq",
        "inserted_at": "2024-07-09T03:33:40Z",
        "name": "Compliance Training",
        "state": "active",
        "updated_at": "2024-07-09T03:33:40Z"
      },
      "id": "34176",
      "links": {
        "self": "http://www.example.com/v1/supporting_tasks/34176"
      },
      "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	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	Unprocessible 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/102453 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_J2JLGgU8_dIkOpg6Ixj8pfV1CNezyq4KT" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2024-07-15",
      "inserted_at": "2024-07-09T03:33:39Z",
      "minutes": "450",
      "type": "base_time",
      "updated_at": "2024-07-09T03:33:39Z"
    },
    "id": "102453",
    "links": {
      "self": "http://company.brmbl.io/v1/user_plan_entries/102453"
    },
    "relationships": {},
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "http://company.brmbl.io/v1/user_plan_entries/102453"
  }
}

Request: Returns a user plan entry

curl -X GET https://api.COMPANY.brmbl.io/v1/user_plan_entries/102466?include=user_plan \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_JaUWlzTf_3TyeRSl6J8l988GkNAUJVtoi" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2024-07-15",
      "inserted_at": "2024-07-09T03:33:39Z",
      "minutes": "450",
      "type": "base_time",
      "updated_at": "2024-07-09T03:33:39Z"
    },
    "id": "102466",
    "links": {
      "self": "http://company.brmbl.io/v1/user_plan_entries/102466"
    },
    "relationships": {
      "user_plan": {
        "data": {
          "id": "19958",
          "type": "user_plans"
        },
        "links": {
          "related": "http://company.brmbl.io/v1/user_plans/19958",
          "self": "http://company.brmbl.io/v1/user_plan_entries/102466/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [
    {
      "attributes": {
        "contribution": 0.33,
        "from": "2024-07-15",
        "inserted_at": "2024-07-09T03:33:39Z",
        "until": "2024-07-21",
        "updated_at": "2024-07-09T03:33:40Z",
        "week_number": 29,
        "year": 2024
      },
      "id": "19958",
      "links": {
        "self": "http://company.brmbl.io/v1/user_plans/19958"
      },
      "relationships": {},
      "type": "user_plans"
    }
  ],
  "links": {
    "self": "http://company.brmbl.io/v1/user_plan_entries/102466"
  }
}

You can fetch the details of a single user plan entry.

Request

GET /v1/user_plan_entries/{id}

Parameters

Parameter	Description	In	Type	Required	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	Unprocessible 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/19952/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_A6xzDlKX_xqA7MVK1Ai6njaO5SjjaVQVL" \
-d @- << EOF

{
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "34172",
  "type": "supporting_task",
  "user_id": "191334"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:39Z",
      "minutes": "450",
      "type": "supporting_task",
      "updated_at": "2024-07-09T03:33:39Z"
    },
    "id": "102452",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102452"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176946",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176946",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102452/relationships/group"
        }
      },
      "supporting_task": {
        "data": {
          "id": "34172",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/34172",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102452/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "191334",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191334",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102452/relationships/user"
        }
      },
      "user_plan": {
        "data": {
          "id": "19952",
          "type": "user_plans"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/user_plans/19952",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102452/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102452"
  }
}

Request: Update a user plan supporting task entry

curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/19946/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_goUqc8lO_K9jvO1gkwM1YhEpAQIRAMP79" \
-d @- << EOF

{
  "date": "2022-02-23",
  "minutes": 450,
  "supporting_task_id": "34170",
  "type": "supporting_task",
  "user_id": "191322"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:39Z",
      "minutes": "900",
      "type": "supporting_task",
      "updated_at": "2024-07-09T03:33:40Z"
    },
    "id": "102446",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102446"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176934",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176934",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102446/relationships/group"
        }
      },
      "supporting_task": {
        "data": {
          "id": "34170",
          "type": "supporting_tasks"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/supporting_tasks/34170",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102446/relationships/supporting_task"
        }
      },
      "user": {
        "data": {
          "id": "191322",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191322",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102446/relationships/user"
        }
      },
      "user_plan": {
        "data": {
          "id": "19946",
          "type": "user_plans"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/user_plans/19946",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102446/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102446"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Failed to cast value to one of: no schemas validate",
      "source": {
        "pointer": "/"
      },
      "title": "Invalid value"
    }
  ]
}

Request: Create a user plan base time entry

curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/19948/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_dJkKNiIv_85F7rky2Rg4m6hRgPMlCjNzI" \
-d @- << EOF

{
  "date": "2022-02-23",
  "minutes": 450,
  "type": "base_time",
  "user_id": "191326"
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:39Z",
      "minutes": "450",
      "type": "base_time",
      "updated_at": "2024-07-09T03:33:39Z"
    },
    "id": "102449",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102449"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176938",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176938",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102449/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "191326",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191326",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102449/relationships/user"
        }
      },
      "user_plan": {
        "data": {
          "id": "19948",
          "type": "user_plans"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/user_plans/19948",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102449/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102449"
  }
}

Request: Update a user plan supporting task entry

curl -X PUT https://api.COMPANY.brmbl.io/v1/user_plans/19955/user_plan_entry \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_F00m7cpg_1n5Obia0F7r3BgfvdGP5ThWn" \
-d @- << EOF

{
  "date": "2022-02-23",
  "minutes": 450,
  "type": "base_time",
  "user_id": "191340"
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "date": "2022-02-23",
      "inserted_at": "2024-07-09T03:33:39Z",
      "minutes": "900",
      "type": "base_time",
      "updated_at": "2024-07-09T03:33:40Z"
    },
    "id": "102463",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102463"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176952",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176952",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102463/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "191340",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191340",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102463/relationships/user"
        }
      },
      "user_plan": {
        "data": {
          "id": "19955",
          "type": "user_plans"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/user_plans/19955",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102463/relationships/user_plan"
        }
      }
    },
    "type": "user_plan_entries"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plan_entries/102463"
  }
}

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	Unprocessible 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_VGnc1XmD_onqsdbX5ybbNHRjV1Leojej7" \
-d @- << EOF

{
  "contribution": null,
  "user_id": "191370",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "contribution": 0.5,
      "from": "2024-01-01",
      "inserted_at": "2024-07-09T03:33:40Z",
      "until": "2024-01-07",
      "updated_at": "2024-07-09T03:33:40Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "19960",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19960"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176978",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176978",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19960/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "191370",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191370",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19960/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19960"
  }
}

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_w2fp5Nte_ghvp43mMBE445b3xRfnVvD8H" \
-d @- << EOF

{
  "contribution": 0.6,
  "user_id": "191384",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "contribution": 0.6,
      "from": "2024-01-01",
      "inserted_at": "2024-07-09T03:33:40Z",
      "until": "2024-01-07",
      "updated_at": "2024-07-09T03:33:40Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "19968",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19968"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176992",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176992",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19968/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "191384",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191384",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19968/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19968"
  }
}

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_qdYX4WAj_Dv2pqdQgwbKSFFGpVLgl0hQD" \
-d @- << EOF

{
  "contribution": null,
  "user_id": "191372",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "contribution": 0.5,
      "from": "2024-01-01",
      "inserted_at": "2024-07-09T03:33:40Z",
      "until": "2024-01-07",
      "updated_at": "2024-07-09T03:33:40Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "19961",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19961"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176980",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176980",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19961/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "191372",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191372",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19961/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19961"
  }
}

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_ygqyJgiI_UvXl9kLq1NMHJhBANvzioVla" \
-d @- << EOF

{
  "contribution": null,
  "user_id": "191378",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "contribution": 0.8,
      "from": "2024-01-01",
      "inserted_at": "2024-07-09T03:33:40Z",
      "until": "2024-01-07",
      "updated_at": "2024-07-09T03:33:40Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "19965",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19965"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176986",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176986",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19965/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "191378",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191378",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19965/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19965"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid number. Got: string",
      "source": {
        "pointer": "/week_number"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid number. 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	Unprocessible 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_DGvvVIvM_lVFPS2mlUUYzAnAwpL2Yyr8X" \
-d @- << EOF

{
  "contribution": null,
  "user_id": "191380",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "contribution": 0.5,
      "from": "2024-01-01",
      "inserted_at": "2024-07-09T03:33:40Z",
      "until": "2024-01-07",
      "updated_at": "2024-07-09T03:33:40Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "19966",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19966"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176988",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176988",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19966/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "191380",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191380",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19966/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19966"
  }
}

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_hrumfRT4_S6lJD7vILp4pY0ZdOljfIPJz" \
-d @- << EOF

{
  "contribution": 0.6,
  "user_id": "191392",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 201 Created

{
  "data": {
    "attributes": {
      "contribution": 0.6,
      "from": "2024-01-01",
      "inserted_at": "2024-07-09T03:33:40Z",
      "until": "2024-01-07",
      "updated_at": "2024-07-09T03:33:40Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "19972",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19972"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "177000",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/177000",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19972/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "191392",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191392",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19972/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19972"
  }
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid number. Got: string",
      "source": {
        "pointer": "/week_number"
      },
      "title": "Invalid value"
    }
  ]
}

Response: 422 Unprocessable Entity

{
  "errors": [
    {
      "detail": "Invalid number. 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_hJhWdbjB_td1ILyS3jV2t8Lp5fa1Rbs2m" \
-d @- << EOF

{
  "contribution": null,
  "user_id": "191386",
  "week_number": 1,
  "year": 2024
}


EOF

Response: 200 OK

{
  "data": {
    "attributes": {
      "contribution": 0.5,
      "from": "2024-01-01",
      "inserted_at": "2024-07-09T03:33:40Z",
      "until": "2024-01-07",
      "updated_at": "2024-07-09T03:33:40Z",
      "week_number": 1,
      "year": 2024
    },
    "id": "19969",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19969"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176994",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176994",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19969/relationships/group"
        }
      },
      "user": {
        "data": {
          "id": "191386",
          "type": "users"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/users/191386",
          "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19969/relationships/user"
        }
      }
    },
    "type": "user_plans"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/user_plans/19969"
  }
}

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	Unprocessible 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_WB941UqL_FtyX8fK7MeIO3FnIOh04xDGE" \

Response: 200 OK

{
  "data": [
    {
      "attributes": {
        "account_role": null,
        "email": "frank@foo.com",
        "full_name": "Frank Furter",
        "inserted_at": "2024-07-09T03:33:40Z",
        "preferred_first_name": "Frank",
        "state": "invited",
        "team_role": "team_owner",
        "timezone": "America/Los_Angeles",
        "updated_at": "2024-07-09T03:33:40Z"
      },
      "id": "191350",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/users/191350"
      },
      "relationships": {
        "group": {
          "data": {
            "id": "176962",
            "type": "groups"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/groups/176962",
            "self": "http://api.COMPANY.brmbl.io/v1/users/191350/relationships/group"
          }
        }
      },
      "type": "users"
    },
    {
      "attributes": {
        "account_role": "account_owner",
        "email": "bob@foo.com",
        "full_name": "Bob Owner",
        "inserted_at": "2024-07-09T03:33:40Z",
        "preferred_first_name": "Bob",
        "state": "new",
        "team_role": null,
        "timezone": "Etc/UTC",
        "updated_at": "2024-07-09T03:33:40Z"
      },
      "id": "191349",
      "links": {
        "self": "http://api.COMPANY.brmbl.io/v1/users/191349"
      },
      "relationships": {
        "group": {
          "data": {
            "id": "176961",
            "type": "groups"
          },
          "links": {
            "related": "http://api.COMPANY.brmbl.io/v1/groups/176961",
            "self": "http://api.COMPANY.brmbl.io/v1/users/191349/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	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	Unprocessible 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/191365 \
-H "Content-type: application/json" \
-H "Authorization: Bearer bramble_uFBshbZU_woMOXD4OU8WUQ17u9qwFk2DD" \

Response: 200 OK

{
  "data": {
    "attributes": {
      "account_role": null,
      "email": "claudine1965@reinger.net",
      "full_name": "Jane Doe",
      "inserted_at": "2024-07-09T03:33:40Z",
      "preferred_first_name": "Something",
      "state": "invited",
      "team_role": "team_owner",
      "timezone": "Africa/Abidjan",
      "updated_at": "2024-07-09T03:33:40Z"
    },
    "id": "191365",
    "links": {
      "self": "http://api.COMPANY.brmbl.io/v1/users/191365"
    },
    "relationships": {
      "group": {
        "data": {
          "id": "176974",
          "type": "groups"
        },
        "links": {
          "related": "http://api.COMPANY.brmbl.io/v1/groups/176974",
          "self": "http://api.COMPANY.brmbl.io/v1/users/191365/relationships/group"
        }
      }
    },
    "type": "users"
  },
  "included": [],
  "links": {
    "self": "http://api.COMPANY.brmbl.io/v1/users/191365"
  }
}

Response: 404 Not Found

{
  "errors": [
    {
      "code": "40401",
      "detail": "Could not find user with id: 191458",
      "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	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	Unprocessible Entity
500	Internal Server Error

Models

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

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 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.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

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

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
`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_score`	Call quality percentage, expressed as a fraction between 0 and 1.	number	float	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

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

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

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

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

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

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

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

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.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

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

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

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

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

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

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

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	number	int32	false
`attributes.year`	The year of the where	number	int32	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

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

Error Models

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

NotFoundError

{
  "errors": [
    {
      "detail": "The requested resource does not exist.",
      "status": 404,
      "title": "Resource Not Found"
    }
  ]
}

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

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

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

Request Models

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

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

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	number	int32	true
`year`	The year of the where	number	int32	true

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
`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.	number	float	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

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

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

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/UserPlanSupportingTaskEntryParams"
    }
  ]
}

UserPlanBaseTimeEntryParams
UserPlanSupportingTaskEntryParams

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

CheckinItemsParams

Input parameters for Checkin Items, can be either a production task, supporting task, or friction type parameters

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/ProductionTaskCheckinItemParams"
    },
    {
      "$ref": "#/components/schemas/SupportingTaskCheckinItemParams"
    },
    {
      "$ref": "#/components/schemas/FrictionTypeCheckinItemParams"
    }
  ]
}

ProductionTaskCheckinItemParams
SupportingTaskCheckinItemParams
FrictionTypeCheckinItemParams

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

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

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

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

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

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

Response Models

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

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

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

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

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

JsonErrorResponse

Property	Description	Type	Format	Required
`errors`		array(any)		true

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"
          }
        },
        "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

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

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

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

UserPlanEntryResponse

Can either be a planned base time or supporting task entry response

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/UserPlanBaseTimeEntryResponse"
    },
    {
      "$ref": "#/components/schemas/UserPlanSupportingTaskEntryResponse"
    }
  ]
}

UserPlanBaseTimeEntryResponse
UserPlanSupportingTaskEntryResponse

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

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

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

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

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

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

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

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

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

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

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

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

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

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,
      "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

CheckinItemResponse

Can either be a Production Task, Supporting Task, or Friction Type Item response

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/ProductionTaskCheckinItemResponse"
    },
    {
      "$ref": "#/components/schemas/SupportingTaskCheckinItemResponse"
    },
    {
      "$ref": "#/components/schemas/FrictionTypeCheckinItemResponse"
    }
  ]
}

ProductionTaskCheckinItemResponse
SupportingTaskCheckinItemResponse
FrictionTypeCheckinItemResponse

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

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

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

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

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

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

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

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