Skip to main content
GET
/
v1
/
list-custom-fields
/
{company_id}
List all custom fields for a company
curl --request GET \
  --url https://api.salescaptain.com/v1/list-custom-fields/{company_id} \
  --header 'Authorization: Bearer <token>'
{
  "message": "Custom fields fetched successfully!",
  "custom_fields": {
    "data": [
      {
        "cf_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a",
        "cf_name": "industry",
        "cf_label": "Industry",
        "cf_datatype": "text",
        "cf_description": "Customer's industry sector",
        "created_at": "2024-01-10T09:00:00.000Z",
        "updated_at": "2024-01-15T11:30:00.000Z"
      },
      {
        "cf_id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",
        "cf_name": "budget",
        "cf_label": "Budget",
        "cf_datatype": "number",
        "cf_description": "Customer's budget range",
        "created_at": "2024-01-12T14:00:00.000Z",
        "updated_at": null
      },
      {
        "cf_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
        "cf_name": "company_size",
        "cf_label": "Company Size",
        "cf_datatype": "dropdown",
        "cf_description": "Number of employees",
        "created_at": "2024-01-20T10:15:00.000Z",
        "updated_at": "2024-02-01T08:45:00.000Z"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Authentication token required for accessing protected endpoints. The token should be obtained from the main SalesCaptain authentication service.

Path Parameters

company_id
string<uuid>
required

Unique identifier for the company

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Custom fields fetched successfully

message
string
Example:

"Custom fields fetched successfully!"

custom_fields
object