Skip to main content
GET
/
v1
/
workspaces
/
{workspaceUuid}
/
custom-fields
/
{key}
Get a custom field definition
curl --request GET \
  --url https://api.snitcher.com/v1/workspaces/{workspaceUuid}/custom-fields/{key} \
  --header 'Authorization: Bearer <token>'
{
  "identifier": "industry",
  "key": "industry",
  "name": "Industry",
  "entity_type": "organisation",
  "type": "text",
  "description": "The primary industry of the company.",
  "group": "custom",
  "is_visible": true,
  "source": "manual",
  "rules": [
    {}
  ],
  "is_system": false,
  "options": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

Enter your personal access token (PAT) to authenticate

Path Parameters

​
workspaceUuid
string<uuid>
required

The UUID of the workspace

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
key
string
required

The key of the custom field

Example:

"industry"

Response

The custom field definition

A custom field definition for organisations

​
identifier
string

The unique identifier of the field

Example:

"industry"

​
key
string

The machine-readable key of the field

Example:

"industry"

​
name
string

The human-readable name of the field

Example:

"Industry"

​
entity_type
string

The entity type the field belongs to

Example:

"organisation"

​
type
string

The data type of the field

Example:

"text"

​
description
string | null
Example:

"The primary industry of the company."

​
group
string

The group the field belongs to

Example:

"custom"

​
is_visible
boolean
Example:

true

​
source
string

The source of the field

Example:

"manual"

​
rules
object[]
​
is_system
boolean
Example:

false

​
options
object[]