company logo

Help center

Go to Agentcis
Follow us on FacebookFollow us on Linkedin
All collectionsAPI DocumentationCustom Fields Api Documentation

Custom Fields Api Documentation

List of custom field for client entities

List of Custom Fields 🔒

  • Endpoint: {{Base URL}}/custom-fields/client

  • Method: GET

  • Description: Fetch the list of custom fields for clients

Query String Parameters


page=1&per_page=10


Response

{

    "data": [

        {

            "id": 4169,

            "name": "GPA",

            "entity": "client",

            "type": "number",

            "options": {

                "importable": false,

                "is_multiple": false,

                "is_required": false,

                "show_in_list": true

            },

            "slug": "65b9a0a6-b846-491d-a6c4-f7f477481cd7",

            "status": 1,

            "section": {

                "id": 18,

                "name": "Additional Client Details"

            },

            "items": [],

            "entities": []

        },

        {

            "id": 4168,

            "name": "Banks",

            "entity": "client",

            "type": "dropdown",

            "options": {

                "importable": false,

                "is_multiple": false,

                "is_required": false,

                "show_in_list": false

            },

            "slug": "576fa82c-88a0-4c43-8c47-c748d7e7f7cf",

            "status": 1,

            "section": {

                "id": 851,

                "name": "hello"

            }

    ],

    "links": {

        "first": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/custom-fields\/client?page=1",

        "last": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/custom-fields\/client?page=2",

        "prev": null,

        "next": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/custom-fields\/client?page=2"

    },

    "meta": {

        "current_page": 1,

        "from": 1,

        "last_page": 2,

        "links": [

            {

                "url": null,

                "label": "« Previous",

                "active": false

            },

            {

                "url": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/custom-fields\/client?page=1",

                "label": "1",

                "active": true

            },

            {

                "url": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/custom-fields\/client?page=2",

                "label": "2",

                "active": false

            },

            {

                "url": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/custom-fields\/client?page=2",

                "label": "Next »",

                "active": false

            }

        ],

        "path": "http:\/\/demoagency.agentcisapp.com\/api\/v2\/custom-fields\/client",

        "per_page": 10,

        "to": 10,

        "total": 40

    }

}

Did this answer your question?
😞
😐
😁