---
title: "Get All Custom Fields"
method: GET
path: "/custom-fields"
tags: ["Custom Fields"]
---

# Get All Custom Fields

`GET /custom-fields`

## Request

- Base URL: `https://api.smartroutes.io/v2`
- URL: `https://api.smartroutes.io/v2/custom-fields`
- Auth: none declared

Lists the custom fields set up for the depot your API key belongs to. Use it to look up the `id`s and `name`s you send in `custom_fields` on `POST /orders`, `PUT /orders/{id}`, `POST /customers` and `PUT /customers/{id}`.

Each entry has `id`, `name`, `created` and `updated`. Deleted fields are left out. The list covers this depot only and is returned in full, with no paging. When you create orders, a custom field that matches neither an `id` nor a `name` here is silently skipped, so check against this list if values seem to go missing.

## Response `200`

Successful response

## Other responses

- `400`: Invalid input. The request body failed validation.
- `403`: Forbidden. Returned for rate-limit exhaustion (`name = FORBIDDEN`, with `details.retry_after_seconds` and `Retry-After` header) and permission gate failures (`name = PERMISSION`). Inspect `name` to disambiguate. Send `x-sr-api-features: rate-limit-429` to receive `429 RATE_LIMIT_EXCEEDED` for the rate-limit case instead, leaving `403` to mean permission failures only — see [API Features](#section/Getting-started/API-Features).
- `429`: Rate limit exceeded (`name = RATE_LIMIT_EXCEEDED`). **Only returned to callers that opt in** with the `x-sr-api-features: rate-limit-429` request header; without it the same condition returns `403` with `name = FORBIDDEN` and an otherwise identical body. See [API Features](#section/Getting-started/API-Features).
- `500`: An unexpected server error occurred. The body carries only `name` and `description`: internal details are never returned.

---

[API](https://skmtc.dev/smartroutes/apis/smartroutes-api.md) · [All operations](https://skmtc.dev/smartroutes/apis/smartroutes-api/llms.txt) · [OpenAPI document](https://skmtc.dev/smartroutes/apis/smartroutes-api/revisions/a7ea507afac7?raw)