GET
/
api
/
v1
/
custom_fields
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "tenant": "https://example.com/",
      "name": "<string>",
      "fieldType": "<string>",
      "fieldOptions": [
        "<string>"
      ],
      "position": 123,
      "form": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123
      },
      "conditionedField": {},
      "conditionedValue": "<string>",
      "isOnlyAdmin": true
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

page
integer
default:1

The collection page number

pagination
boolean

Enable or disable pagination

tenant
string
tenant[]
string[]
form
string
form[]
string[]
order[position]
enum<string>
default:asc
Available options:
asc,
desc
order[name]
enum<string>
default:asc
Available options:
asc,
desc
order[fieldType]
enum<string>
default:asc
Available options:
asc,
desc
exists[form]
boolean

Response

200
application/ld+json

CustomField collection

The response is of type object.