---
title: "List Custom Properties"
method: GET
path: "/v1/projects/{project}/customProperties"
tags: ["Custom Properties"]
---

# List Custom Properties

`GET /v1/projects/{project}/customProperties`

List Custom Properties

## Path parameters

- `project` string, required

## Query parameters

- `page` number
- `perPage` number
- `sortBy` 'createdAt' | 'updatedAt' | 'name' | 'key' | 'propertyKey'
- `sortOrder` 'asc' | 'desc'
- `search` string
- `type` 'String' | 'Boolean' | 'Number'
- `includeUsage` boolean

## Response `200`

- CustomProperty[]
  - `name` string, required — Display name for Custom Property.
  - `key` string, required — Auto generated key to be used by the API to reference by 'key' rather then _id for CRUD operations. Must only contain lower-case characters and `_`, `-` or `.`.
  - `_id` string, required — A unique CustomProperty ID
  - `_project` string, required — The Project owning the Custom Property
  - `_createdBy` string, required — ID of the User who created the project
  - `propertyKey` string, required — Custom Property key, must be unique by Project. Only to be used by the SDKs to reference the Custom Property..
  - `type` 'String' | 'Boolean' | 'Number', required — The Custom Property type
  - `createdAt` string, date-time, required — The date the Project was created
  - `updatedAt` string, date-time, required — The date the Project was last updated
  - `schema` PropertySchema
    - `schemaType` 'enum'
    - `required` boolean
    - `enumSchema` EnumSchema
      - `allowedValues` AllowedValue[], required
        - `label` string, required
        - `value` object, required
      - `allowAdditionalValues` boolean, required
  - `hasUsage` boolean — Whether the custom property is in use by a feature

## Other responses

- `400`
- `401`
- `403`
- `404`

---

[API](https://skmtc.dev/devcycle/apis/devcycle-management-api.md) · [All operations](https://skmtc.dev/devcycle/apis/devcycle-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/devcycle/devcycle-management-api/revisions/d4a127a37608/schema)