---
title: "List custom field definitions"
method: GET
path: "/fields"
tags: ["Custom fields"]
---

# List custom field definitions

`GET /fields`

## Request

- Base URL: `https://api.rizamo.com/v1`
- URL: `https://api.rizamo.com/v1/fields`
- Auth: HTTP bearer

The team's custom fields, with their keys, types and choices: set them on posts with `fields`, and filter posts and analytics by them.

## Query parameters

- `entity` 'post': Only fields on this kind of object: post, the only kind today.

## Response `200`

OK

- object
  - `items` FieldDefinition[], required
    - `key` string, required
    - `entity` 'post', required
    - `label` string, required
    - `type` 'text' | 'select' | 'multi_select' | 'number' | 'url' | 'date' | 'checkbox', required
    - `options` string[]
    - `description` string

## Other responses

- `400`: `invalid_request`: A field is missing or wrong, or the request cannot be done as asked: the message names the field or says what to change.
- `401`: `unauthorized`: No API key or sign-in, or the key does not work: it was deleted, or it expired.
- `403`: `forbidden`: The caller may not do this: the key or agent lacks the scope (the message names it), or the action needs another role or a fresh sign-in.
- `429`: `rate_limited`: Over one of Rizamo's limits, or a network asked Rizamo to slow down: wait for `Retry-After` seconds, or as long as the message says.
- `500`: `internal`: Our side failed: retry, and send the `requestId` if it keeps failing.
- `503`: `timeout`: The request took too long to work out, most often a report: try again in a moment, or ask a report for a shorter period or one profile.

---

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