Skip to content
TeamGrid Developer

List custom-field definitions

GET
/custom-field-definitions
curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/custom-field-definitions?limit=50&archived=false&fieldType=contact&targetType=contact' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
cursor
string
<= 1024 characters

Opaque cursor returned in meta.page.nextCursor.

limit
integer
default: 50 >= 1 <= 200
archived
boolean

Return archived resources instead of active resources.

defaultEnabled
boolean

Filter by whether the definition is enabled by default.

fieldType
string
Allowed values: contact date dropdown number project switcher tag text textarea user

Filter by a canonical writable custom-field type. Unsupported legacy types remain visible in unfiltered listings.

targetType
string
Allowed values: contact project projectJournalEntry task

Filter by the resource type that owns the field value.

Responses

Section titled “Responses”

200

Section titled “200”

A stable cursor page.

Media typeapplication/json
object
data
required
Array<object>
object
attributes
required
object
archived
required
boolean
compatibility
required
string
Allowed values: invalid readOnlyLegacy unsupported writable
configuration
required
One of:
object
groupId
string
>= 1 characters <= 128 characters
multi
boolean
placeholder
string
<= 500 characters
type
required
string
Allowed value: contact
createdAt
required
string | null format: date-time
defaultEnabled
required
boolean
description
required
string
<= 5000 characters
fieldType
required
string
Allowed values: contact date dropdown number project switcher tag text textarea user unsupported
legacyTargetType
string
<= 128 characters
legacyType
string
<= 128 characters
required
required
boolean
targetType
required
string
Allowed values: contact project projectJournalEntry task unsupported
title
required
string
<= 500 characters
updatedAt
required
string | null format: date-time
id
required
string
>= 1 characters <= 128 characters
type
required
string
Allowed value: customFieldDefinition
meta
required
object
page
required
object
limit
required
integer
>= 1 <= 200
nextCursor
required
string | null
requestId
required
string
Example
{
  "data": [
    {
      "attributes": {
        "compatibility": "invalid",
        "configuration": {
          "type": "contact"
        },
        "fieldType": "contact",
        "targetType": "contact"
      },
      "type": "customFieldDefinition"
    }
  ]
}

400

Section titled “400”

The request is invalid.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

401

Section titled “401”

The bearer credential is missing, invalid, expired, or revoked.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

403

Section titled “403”

The credential has insufficient scope.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

429

Section titled “429”

The credential or source exceeded its rate limit.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

Headers

Section titled “Headers”
Retry-After
integer
>= 1

Minimum delay in seconds before retrying.

X-RateLimit-Limit
integer

Maximum requests in the current window.

X-RateLimit-Remaining
integer

Requests remaining in the current window.

X-RateLimit-Reset
integer

Unix time in milliseconds when the current window resets.

X-Request-Id
string

Request correlation identifier.

503

Section titled “503”

A required cell-local dependency is unavailable.

Media typeapplication/json
object
errors
required
Array<object>
object
code
required
string
detail
required
string
source
object
key
additional properties
string
status
required
string
/^[1-5][0-9]{2}$/
title
required
string
meta
required
object
requestId
required
string
Examplegenerated
{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}