# Get all custom fields

**GET /api/v1/custom-field**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters


### Query parameters
- **filter[uuid]** (string)
  Filter by a comma separated list of UUIDs.
- **filter[model_type]** (string)
  Filter the custom fields by a specific model type. For example: ?filter[model_type]=client
- **sort** (string)
  Field to sort by. Valid fields are [created_at, updated_at, name, model_type, position]. Negative sign to denote DESC.  Defaults to 'position'.
- **per_page** (integer)
  Number of results to return with pagination (Default 15. Max 500).


## Responses
### 200


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the custom field
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **type** (string)
  The type of custom field
- **name** (string)
  The name of the custom field
- **reference** (string)
  The reference of the custom field, used when updating the custom field on the model.
- **is_required** (boolean)
  Denotes if the custom field is required
- **model_type** (string)
  The type of model that the custom field is for.
- **help_text** (string)
  Optional help text to aide the custom field. Will be displayed on Plannr.
- **firm** (object)
  The custom field firm
- **selection_options** (array[string])
  This is the array of available options for the selection box. If the type is "selection" this array will be provided.
- **is_visible_to_clients** (boolean)
  Denotes if the custom field is visible and editable to clients.
- **position** (integer)
  The position of the custom field


[Powered by Bump.sh](https://bump.sh)