Errors & status codes

Every response from the Lemmy API uses the same envelope, whether the request succeeds or fails. Each response contains:

Checking for success

IsSuccess and the HTTP status code always agree, so you can rely on either:

• IsSuccess: true → HTTP 200 OK, and ErrorMessages is empty.
• IsSuccess: false → HTTP 400 Bad Request, and ErrorMessages explains why.

Always check IsSuccess (or the status code) before using the payload.

A successful response:

1
{
2
  "IsSuccess": true,
3
  "ErrorMessages": [],
4
  "CustomerGroups": [
5
    { "Code": "RETAIL", "Description": "Retail customers", "Active": true }
6
  ]
7
}

A failed response:

1
{
2
  "IsSuccess": false,
3
  "ErrorMessages": [
4
    "x-page-offset header is required"
5
  ]
6
}

Status codes

Common causes of a 400

• Missing x-page-offset or x-page-limit headers on a GET request — see Pagination.
• Missing or invalid required fields in a POST request body.
• Any other validation error — read ErrorMessages for the specifics.

Handling errors

Check IsSuccess before trusting the payload, and surface ErrorMessages when something goes wrong:

1
response = requests.get(url, headers=headers)  # headers include x-api-key and x-company-id
2
body = response.json()
3
4
if not body["IsSuccess"]:
5
    raise RuntimeError("; ".join(body["ErrorMessages"]))
6
7
# Safe to use the payload
8
process(body)