List Custom Fields

List custom fields.

Scopes: custom_fields:read custom_fields:write

GET /v1/custom-fields

PHP (SDK)

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;
use Spaire\Models\Operations;

$sdk = Spaire\Spaire::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Operations\CustomFieldsListRequest(
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
);

$responses = $sdk->customFields->list(
    request: $request
);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

200

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "metadata": {},
      "type": "<string>",
      "slug": "<string>",
      "name": "<string>",
      "organization_id": "<string>",
      "properties": {
        "form_label": "<string>",
        "form_help_text": "<string>",
        "form_placeholder": "<string>",
        "textarea": true,
        "min_length": 1073741823,
        "max_length": 1073741823
      }
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

Authorization · string · header · required

You can generate an Organization Access Token from your organization's settings.

Query Parameters

organization_id · string<uuid4> string<uuid4>[]

Filter by organization ID. The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

query · string | null

Filter by custom field name or slug.

type · enum<string> enum<string>[]

Filter by custom field type.

Available options: text, number, date, checkbox, select

page · integer · default: 1

Page number, defaults to 1.

limit · integer · default: 10

Size of a page, defaults to 10. Maximum is 100.

sorting · enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Available options: created_at, -created_at, slug, -slug, name, -name, type, -type

Response

200

application/json

Successful Response

items · (CustomFieldText · object | CustomFieldNumber · object | CustomFieldDate · object | CustomFieldCheckbox · object | CustomFieldSelect · object)[] · required

Schema for a custom field of type text.

CustomFieldText

CustomFieldNumber

CustomFieldDate

CustomFieldCheckbox

CustomFieldSelect

Show child attributes

pagination · Pagination · object · required

Show child attributes