Retrieve a custom field

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/custom_fields/cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customFields.getSettingsCustomField('cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customFields->getSettingsCustomField('cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e');
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.custom_fields.custom_fields_dto.CustomFieldsDto.SettingsCustomField;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsCustomField> response = client.customFields().getSettingsCustomField(
        "cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomFields.GetSettingsCustomFieldAsync("cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customFields.getSettingsCustomField(
  'cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.CustomFields().GetSettingsCustomField(context.Background(), "cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "custom_field": {
    "object": "<string>",
    "id": "<string>",
    "status": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "type": "<string>",
    "is_mandatory": true,
    "created_on": "<string>",
    "last_updated_on": "<string>",
    "created_by": "<unknown>",
    "last_updated_by": "<unknown>",
    "version": 123,
    "href": "<string>"
  }
}

GET

settings

custom_fields

{custom_field_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/custom_fields/cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.customFields.getSettingsCustomField('cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->customFields->getSettingsCustomField('cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e');
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.custom_fields.custom_fields_dto.CustomFieldsDto.SettingsCustomField;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<SettingsCustomField> response = client.customFields().getSettingsCustomField(
        "cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.CustomFields.GetSettingsCustomFieldAsync("cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.customFields.getSettingsCustomField(
  'cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.CustomFields().GetSettingsCustomField(context.Background(), "cfld_1e3a5c7e9b2d4f6a8c0e1b3d5f7a9c2e", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "custom_field": {
    "object": "<string>",
    "id": "<string>",
    "status": "<string>",
    "name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "type": "<string>",
    "is_mandatory": true,
    "created_on": "<string>",
    "last_updated_on": "<string>",
    "created_by": "<unknown>",
    "last_updated_by": "<unknown>",
    "version": 123,
    "href": "<string>"
  }
}

Reads a single custom field by its cfld_ id, with its name, display name, type and status.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

custom_field_id

string

required

The custom field's id, which starts with cfld_.

Response

200 - application/json

The custom field, under custom_field.

custom_field

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response