For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

List user properties for a project

このページはまだあなたの言語に翻訳されていません。 現在取り組んでいますので、後でもう一度確認してください。

get/v1/projects/{project_id}/user-properties

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

Example:12345
Constraints:pattern: ^[0-9]+$

Query parameters

cursorstring

Opaque cursor from pagination.next_cursor on the previous response. Numeric offsets are capped by the underlying search index (10,000 results per query). Well-formed pagination stops before that window; requests whose cursor would exceed it return 400 pagination_not_supported.

Constraints:nullable
limitinteger

Number of items to return. Defaults to 50, max 200.

Default:50
Constraints:min: 1max: 200
qstring

Full-text search query.

Response

application/json
200· Successful response.
dataobject[]required
Show child attributes
idstringrequired

Stable resource identifier. Equal to property_name.

objectstringrequired

Resource-type discriminator. Always user_property.

project_idstringrequired
Constraints:pattern: ^[0-9]+$
property_namestringrequired
display_namestring
Constraints:nullable
descriptionstring
Constraints:nullable
is_officialboolean

Curated/official flag. null ⇒ inherited / unset upstream.

Constraints:nullable
is_hiddenbooleanrequired
is_in_schemabooleanrequired

Whether this property is part of the project's curated tracking plan. Same semantics as EventProperty.is_in_schema.

data_typestring

Logical data type of a property. null means untyped at the source; clients should treat it as string for ingestion.

Allowed values:stringnumberbooleanobjectenumanynull
Constraints:nullable
is_array_typebooleanrequired
enum_valuesstring[]required
regexstring
Constraints:nullable
classificationsstring[]required
paginationobjectrequired
Show child attributes
next_cursorstringrequired

Cursor for the next page, or null on the last page. Chart list responses may stop before all project charts are enumerated because the search backend caps each query at 10,000 sorted hits.

Constraints:nullable
has_morebooleanrequired

これは役に立ちましたか？