> For the complete documentation index, see [llms.txt](https://kasplo.gitbook.io/kasplo-doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kasplo.gitbook.io/kasplo-doc/channels/email-marketing/get-custom-field-api.md).

# GET Custom-field API

### Endpoint:

```
POST {domain}/audience/v1/:sid/custom-field
    
```

### Sample CURL:

```

      curl --location '{domain}/audience/v1/{sid}/custom-field' \
--header 'api-key: {api-key}'
  
```

### Response:

```

       {
    "data": [
      { 
"name": "age", 
"custom_id": "351c3611ddc42c223483386015411b0e", 
"type": "string", 
"values": "", "status": 1, 
"created_at": "2025-01-06T10:43:32Z", 
"updated_at": "2025-01-06T10:43:32Z", 
"required": 0, 
"default": "" 
},
    ],
    "error": {},
    "limit": 10,
    "message": "Request processed successfully.",
    "status": 200,
    "total": 1
}
  
```

### Response Fields:

* Name: Name of the custom field.
* Custom\_id: The unique ID for the custom field.
* Type: Type of the custom field (Possible values: string, boolean, numeric, date, dropdown).
* Values: Possible values for the custom field if the type is dropdown.
* Status: Status of the custom field. 1 means active.
* Created\_at: Timestamp of creation (UTC).
* Updated\_at: Timestamp of last update (UTC).
* Required:  Specifies if the custom field is mandatory for a contact or not. (1 - Required, 0 - Not required). This means that if the value is set to 1 a contact can’t be added without adding the specified custom field value.
* Default: Default value for the custom field.