Get a custom field

GET

/space/custom_field/{id}

curl --request GET \
  --url https://api.aelyst.ai/v1/space/custom_field/example \
  --header 'Authorization: Bearer <token>'

• Production

Get more information about a custom field.

You would need to provide the unique custom field ID.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

ID of the contact field

Responses

200

Media typeapplication/json

object

id

required

Custom field ID.

integer

name

required

Name of the custom field.

string

description

required

string

dataType

required

Type of the data stored in this custom field.

string

Allowed values: text list checkbox email number url date time

allowedValues

List of enum values allowed to be stored in this field. This property is applicable only if the dataType is list.

Array<string>

Example

{
  "id": 123,
  "name": "customer_id",
  "description": "Customer ID",
  "dataType": "text"
}

400

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 400,
  "message": "Validation error."
}

401

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 401,
  "message": "UN_AUTHORIZED"
}

429

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 429,
  "message": "Too Many Requests"
}

Headers

Retry-After

number

Example

1

Number of seconds until you can retry the request

X-RateLimit-Limit

number

Example

10

Number of request allowed for this end point

X-RateLimit-Remaining

number

Example

5

Number of request remaining for this end point

500

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 500,
  "message": "Unexpected error occurred"
}