Custom fields

List custom fields

GET

/field-definitions

One page of records, newest first unless you say otherwise, with the total count in meta so you know how far to paginate.

Required scope: field-definitions:read.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Query Parameters

page?integer

1-based. meta.totalPages says how many there are.

Range1 <= value

Default1

per_page?integer

Rows per page. A value above 200 returns 400 - never a silent clamp.

Range1 <= value <= 200

Default50

sort?string

Prefix with - for descending. An undeclared sort returns 400.

Default"position"

Value in"position""-position""createdAt""-createdAt""label""-label"

q?string

Case-insensitive "contains", across: label, key.

filter[entity]?string

Exact match on entity.

Value in"ticket""deal""account""lead""contact"

filter[type]?string

Exact match on type.

Value in"text""long_text""number""date""select""multi_select""checkbox""url""user""email"

filter[archived]?string

Exact match on archived.

Value in"true""false"

Response Body

The requested page.

application/json

response

data*array<>

meta*

Example Request

curl -X GET 'https://api.usedashly.com/v1/field-definitions'

Example Request

curl -X GET 'https://api.usedashly.com/v1/field-definitions'

Example ResponseSchema

{
  "data": [
    {
      "id": "string",
      "key": "string",
      "label": "string",
      "type": "text",
      "entity": "ticket",
      "options": null,
      "required": true,
      "clientVisible": true,
      "scope": "client",
      "showInCreate": true,
      "showInDetail": true,
      "category": "string",
      "position": 0,
      "archived": true,
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "page": 0,
    "perPage": 0,
    "total": 0,
    "totalPages": 0
  }
}

{  "data": [    {      "id": "string",      "key": "string",      "label": "string",      "type": "text",      "entity": "ticket",      "options": null,      "required": true,      "clientVisible": true,      "scope": "client",      "showInCreate": true,      "showInDetail": true,      "category": "string",      "position": 0,      "archived": true,      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "perPage": 0,    "total": 0,    "totalPages": 0  }}

Links are given as the target's public id (clientId: "hsbftmp3f5"); the API resolves them server-side. Fields the database requires but the interface decides for you are filled in the same way here.

Required scope: field-definitions:write.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Header Parameters

Request Body

application/json

body

key*string

Match^[a-z][a-z0-9_]*$

Length1 <= length <= 60

label*string

Length1 <= length <= 120

type*string

Value in"text""long_text""number""date""select""multi_select""checkbox""url""email""user"

entity*string

Value in"ticket""deal""account""lead""contact"

options?array<|>

Itemsitems <= 100

required?boolean

clientVisible?boolean

scope?|null

showInCreate?boolean

showInDetail?boolean

category?|null

position?integer

Range0 <= value <= 9999

archived?boolean

createdAt?string

When this actually happened, for an import. Past dates only; defaults to now. updatedAt follows it unless the body sets one.

Formatdate-time

Response Body

Created. The body is the new record, as a read would return it.

application/json

response

data*

Example Request

curl -X POST 'https://api.usedashly.com/v1/field-definitions' \
  -H 'Content-Type: application/json' \
  -d '{
  "key": "string",
  "label": "string",
  "type": "text",
  "entity": "ticket"
}'

Example Request

curl -X POST 'https://api.usedashly.com/v1/field-definitions' \  -H 'Content-Type: application/json' \  -d '{  "key": "string",  "label": "string",  "type": "text",  "entity": "ticket"}'

Example ResponseSchema

{
  "data": {
    "id": "string",
    "key": "string",
    "label": "string",
    "type": "text",
    "entity": "ticket",
    "options": null,
    "required": true,
    "clientVisible": true,
    "scope": "client",
    "showInCreate": true,
    "showInDetail": true,
    "category": "string",
    "position": 0,
    "archived": true,
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "key": "string",    "label": "string",    "type": "text",    "entity": "ticket",    "options": null,    "required": true,    "clientVisible": true,    "scope": "client",    "showInCreate": true,    "showInDetail": true,    "category": "string",    "position": 0,    "archived": true,    "createdAt": "2019-08-24T14:15:22Z"  }}

Retrieve a custom field

GET

/field-definitions/{id}

The full record, custom fields included when the resource carries them. A record from another agency is a 404, not a 403 - its existence is not ours to confirm.

Required scope: field-definitions:read.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Path Parameters

id*string

The record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.

Response Body

Found.

application/json

response

data*

Example Request

curl -X GET 'https://api.usedashly.com/v1/field-definitions/string'

Example Request

curl -X GET 'https://api.usedashly.com/v1/field-definitions/string'

Example ResponseSchema

{
  "data": {
    "id": "string",
    "key": "string",
    "label": "string",
    "type": "text",
    "entity": "ticket",
    "options": null,
    "required": true,
    "clientVisible": true,
    "scope": "client",
    "showInCreate": true,
    "showInDetail": true,
    "category": "string",
    "position": 0,
    "archived": true,
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "key": "string",    "label": "string",    "type": "text",    "entity": "ticket",    "options": null,    "required": true,    "clientVisible": true,    "scope": "client",    "showInCreate": true,    "showInDetail": true,    "category": "string",    "position": 0,    "archived": true,    "createdAt": "2019-08-24T14:15:22Z"  }}

Update a custom field

PATCH

/field-definitions/{id}

A partial update: only the fields you send change. One exception - customFields is replaced wholesale, not merged, so sending it with a single key clears the others. Read the record, merge, then write.

Required scope: field-definitions:write.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Path Parameters

id*string

The record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.

Request Body

application/json

body

label?string

Length1 <= length <= 120

options?array<|>

Itemsitems <= 100

required?boolean

clientVisible?boolean

scope?|null

showInCreate?boolean

showInDetail?boolean

category?|null

position?integer

Range0 <= value <= 9999

archived?boolean

Response Body

Updated. The body is the record as it now stands.

application/json

response

data*

Example Request

curl -X PATCH 'https://api.usedashly.com/v1/field-definitions/string' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example Request

curl -X PATCH 'https://api.usedashly.com/v1/field-definitions/string' \  -H 'Content-Type: application/json' \  -d '{}'

Example ResponseSchema

{
  "data": {
    "id": "string",
    "key": "string",
    "label": "string",
    "type": "text",
    "entity": "ticket",
    "options": null,
    "required": true,
    "clientVisible": true,
    "scope": "client",
    "showInCreate": true,
    "showInDetail": true,
    "category": "string",
    "position": 0,
    "archived": true,
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "key": "string",    "label": "string",    "type": "text",    "entity": "ticket",    "options": null,    "required": true,    "clientVisible": true,    "scope": "client",    "showInCreate": true,    "showInDetail": true,    "category": "string",    "position": 0,    "archived": true,    "createdAt": "2019-08-24T14:15:22Z"  }}

Delete a custom field

DELETE

/field-definitions/{id}

Permanent. The audit log keeps the trace; the record does not come back.

Required scope: field-definitions:write.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Path Parameters

id*string

The record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.

Response Body

Deleted. Empty body.

Example Request

curl -X DELETE 'https://api.usedashly.com/v1/field-definitions/string'

Example Request

curl -X DELETE 'https://api.usedashly.com/v1/field-definitions/string'

Example Response

Empty

List available actions

GET

/field-definitions/actions

Every verb this resource answers to, with its target and the JSON Schema of its body - the same contracts this document describes, readable at runtime.

Required scope: field-definitions:read.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Response Body

The available verbs.

application/json

response

data*array<>

Example Request

curl -X GET 'https://api.usedashly.com/v1/field-definitions/actions'

Example Request

curl -X GET 'https://api.usedashly.com/v1/field-definitions/actions'

Example ResponseSchema

{
  "data": [
    {
      "name": "string",
      "label": "string",
      "description": "string",
      "target": "item",
      "readOnly": true,
      "path": "string",
      "input": {}
    }
  ]
}

{  "data": [    {      "name": "string",      "label": "string",      "description": "string",      "target": "item",      "readOnly": true,      "path": "string",      "input": {}    }  ]}

Reorder the fields

POST

/field-definitions/actions/reorder

Reorders the field definitions: each field's position becomes its index in the list of ids you send.

Does what the dashboard's reorderFieldDefinitionsAction does - same implementation, so the two cannot diverge.

Required scope: field-definitions:write.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Header Parameters

Request Body

application/json

body

ids*array<>

Items1 <= items <= 500

Response Body

Done.

application/json

response

data*unknown

The action's result; its shape depends on the verb.

Example Request

curl -X POST 'https://api.usedashly.com/v1/field-definitions/actions/reorder' \
  -H 'Content-Type: application/json' \
  -d '{
  "ids": [
    "string"
  ]
}'

Example Request

curl -X POST 'https://api.usedashly.com/v1/field-definitions/actions/reorder' \  -H 'Content-Type: application/json' \  -d '{  "ids": [    "string"  ]}'

Example ResponseSchema

{
  "data": null
}

{  "data": null}

List custom fieldsCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Create a custom fieldCopy Anchor Link

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Retrieve a custom fieldCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Update a custom fieldCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Delete a custom fieldCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

List available actionsCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Reorder the fieldsCopy Anchor Link

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

List custom fields

Authorization

Query Parameters

Response Body

Create a custom field

Authorization

Header Parameters

Request Body

Response Body

Retrieve a custom field

Authorization

Path Parameters

Response Body

Update a custom field

Authorization

Path Parameters

Request Body

Response Body

Delete a custom field

Authorization

Path Parameters

Response Body

List available actions

Authorization

Response Body

Reorder the fields

Authorization

Header Parameters

Request Body

Response Body