Prospects

List custom fields

Returns a list of prospect custom fields

get/settings/fields/groups

Request

  • Base URL: http://bonzo.site/api/v3
  • URL: http://bonzo.site/api/v3/settings/fields/groups
  • Auth: HTTP bearer

Response

Success

Example response

{
  "groups": [
    {
      "name": "My custom field group",
      "created_at": "2022-01-01T01:00:00.000000Z",
      "updated_at": "2022-01-01T01:00:00.000000Z",
      "fields": [
        {
          "label": "Nickname",
          "label_normalized": "nickname",
          "help_text": "Prospect nickname",
          "type": "text",
          "created_at": "2022-01-01T01:00:00.000000Z",
          "updated_at": "2022-01-01T01:00:00.000000Z"
        }
      ]
    }
  ],
  "links": {
    "first": "https://example.com?page=1",
    "last": "https://example.com?page=3",
    "next": "https://example.com?page=2"
  },
  "meta": {
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://example.com?page=1",
        "label": 1,
        "active": true
      },
      {
        "url": "https://example.com?page=2",
        "label": 2,
        "active": false
      },
      {
        "url": "https://example.com?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://example.com"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.