---
title: "List all known properties for an integration"
method: GET
path: "/integration/{integration_id}/properties/"
tags: ["integrations"]
---

# List all known properties for an integration

`GET /integration/{integration_id}/properties/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/integration/{integration_id}/properties/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

List the property names the integration exposes for a record type, read live from the integration's API. Supports optional search filtering by property name.

## Path parameters

- `integration_id` string, uuid, required

## Query parameters

- `record_type` string, required: Record type to list properties for (e.g., 'person', 'contact')
- `kind` 'builtin' | 'custom', required: Mode of a property. Used while creating/updating/deleting properties. Attributes: BUILTIN: The property is a built-in property. E.g. "$created_at" or "$email" for PostHog. CUSTOM: The property is a custom property. E.g. "custom_property" for PostHog. Unknown properties are marked as CUSTOM.
- `search` string, nullable: Search properties by name (case-insensitive)

## Response `200`

Successful Response

- PropertyListResponseSchema: Response model for listing properties.
  - `properties` PropertyReadSchema[], required: List of unique property names found in the integration
    - `label` string, nullable: The tool's own display name for the property (HubSpot's 'Record ID' for hs_object_id), for showing to people. Null when the tool exposes none; `name` stays the key every read and write uses.
    - `mode` 'builtin' | 'custom', required: Mode of a property. Used while creating/updating/deleting properties. Attributes: BUILTIN: The property is a built-in property. E.g. "$created_at" or "$email" for PostHog. CUSTOM: The property is a custom property. E.g. "custom_property" for PostHog. Unknown properties are marked as CUSTOM.
    - `name` string, required: The name of the property
    - `read_only` boolean, required: Whether the property is read-only and cannot be used as a destination field
    - `type` 'string' | 'integer' | 'float' | 'boolean' | 'datetime' | 'date' | 'list' | 'dict', required: Type of a property. Used while creating/updating/deleting properties.
  - `reason` 'ok' | 'no_properties_found', required: Why a property listing came back the way it did.
  - `total_count` integer, required: Total number of unique properties found

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Integration not found
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)