Get a record | Beezr API

Skip to content

POST/api/v4/records/get

Returns one record by its id.

Auth: X-API-Key
Counts as: 1 request
Idempotency: not supported

Headers

X-API-Keystringrequired: Read from your server environment.
Content-Typestringrequired: application/json.

Body parameters

modulestringrequired: The module's table name, shown under the module name on its card in Beezr Designer (for example cm_equipment_requests_base).
idintegerrequired: Minimum 1.
fieldsarray of stringoptional: Return only these fields (id always comes back)

Returns

HTTP 200. The record.

successbooleanoptional: —
dataobjectoptional: A record. id is the record id; every other property is a field keyed by its System name.
data.idintegeroptional: —

Field values come back in the same form the Designer shows them.

File fields contain references in v4. Read fileExtension as returned.

Errors

HTTP	Code	What to do
400	`MISSING_REQUIRED_FIELD`	Send the required body fields.
400	`KEY_FIELD_UNRESOLVED`	Check the module key field.
401	`AUTHENTICATION_FAILED`	Check the API key.
404	`MODULE_NOT_FOUND`	Copy the module table name.
404	`NOT_FOUND`	Check the record id.
429	`RATE_LIMIT_EXCEEDED`	Wait for the rate-limit reset.
429	`TOO_MANY_CONCURRENT_REQUESTS`	Wait; keep at most 2 in flight.
429	`MONTHLY_QUOTA_EXCEEDED`	Stop retries until the 1st.
500	`FIELD_LOAD_FAILED`	Retry later.
500	`INTERNAL_ERROR`	Retry later.

curl --fail-with-body --silent --show-error \
  'https://services.beezr.io/generic/api/v4/records/get' \
  -H "X-API-Key: $BEEZR_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "module": "cm_equipment_requests_base",
  "id": 482913
}'

const response = await fetch("https://services.beezr.io/generic/api/v4/records/get", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.BEEZR_API_KEY,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "module": "cm_equipment_requests_base",
    "id": 482913
  })
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

import os
import requests

response = requests.post(
    "https://services.beezr.io/generic/api/v4/records/get",
    headers={"X-API-Key": os.environ["BEEZR_API_KEY"]},
    json={
      "module": "cm_equipment_requests_base",
      "id": 482913
    }
)
response.raise_for_status()
print(response.json())

{
  "success": true,
  "data": {"id":482913,"title":"Laptop"}
}

{"success":false,"error":{"code":"AUTHENTICATION_FAILED","message":"Invalid or missing API key"}}