List Contact Properties

GET

/v1/contact-property-definitions

Returns every custom property field defined for the workspace the schema for contact custom fields. This is the endpoint referenced elsewhere (Set/Delete Property Value on Contact, Search Contacts) for discovering valid propertyId values.

Request: none. No query parameters, no pagination. Always returns the full list of property definitions for the workspace in one call.

Fields:

key — an auto-generated slug from name, set at creation, used internally. Not something you pass when setting a value (use id as the propertyId for that).

type — 1 = Text, 2 = Number, 3 = Select, 4 = Date.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

Full list of property definitions for the workspace, oldest first.

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.voxa.sa/v1/contact-property-definitions' \
--header 'Authorization: Bearer <token>'

Response Example

Success Example

{
    "workspaceId": "d307b8...............",
    "name": "جديد",
    "key": "جديد",
    "type": 1,
    "isRequired": false,
    "selectOptions": [],
    "lastModificationTime": null,
    "lastModifierId": null,
    "creationTime": "2026-06-19T13:20:22.441968",
    "creatorId": "3a1dc2...............",
    "id": "3a21f2..............."
}

Modified at 2026-06-21 11:13:19

Contacts History

Contact Properties Statistics