> ## Documentation Index > Fetch the complete documentation index at: https://docs.periskope.app/llms.txt > Use this file to discover all available pages before exploring further. # Get Custom Property > Looks up a custom property by property_id or name (case-insensitive), including its options. ## OpenAPI ````yaml api-reference/openapi-generated.json GET /v1/properties/{property_id} openapi: 3.0.3 info: title: Periskope API version: 1.0.0 description: >- Periskope external API. Responses use a flat, unwrapped shape: most endpoints return the resource at the top level, and list endpoints return a wrapper object with pagination inline (e.g. `{ from, to, count, chats: [...] }`). The documented response schemas describe these shapes directly. servers: - url: https://api.periskope.app security: - bearerAuth: [] paths: /v1/properties/{property_id}: get: tags: - Properties summary: Get a custom property by id or name description: >- Looks up a custom property by property_id or name (case-insensitive), including its options. operationId: getPropertyById parameters: - schema: type: string minLength: 1 description: >- The property_id (property-xxxxxxxxxxxxxxxx) or the name (case-insensitive) of the custom property. Prefer the property_id — a name that exists as both a chat and a ticket property is ambiguous without the type query parameter. example: property-aaaaaaaaaaaa required: true description: >- The property_id (property-xxxxxxxxxxxxxxxx) or the name (case-insensitive) of the custom property. Prefer the property_id — a name that exists as both a chat and a ticket property is ambiguous without the type query parameter. name: property_id in: path - schema: type: string enum: - chat - ticket description: >- Resolves the chat or the ticket property when property_id is a name that exists as both. Not needed when passing a property_id, or when the name only exists under one type. example: ticket required: false description: >- Resolves the chat or the ticket property when property_id is a name that exists as both. Not needed when passing a property_id, or when the name only exists under one type. name: type in: query responses: '200': description: The matched property (or array of matches, see data) content: application/json: schema: anyOf: - allOf: - $ref: '#/components/schemas/CustomProperty' - description: >- A custom property — a workspace-defined field that appears on every chat (type: chat) or every ticket (type: ticket). Text, date and file kinds hold free values; dropdown and picklist kinds hold a value chosen from the property’s option list. - type: array items: allOf: - $ref: '#/components/schemas/CustomProperty' - description: >- A custom property — a workspace-defined field that appears on every chat (type: chat) or every ticket (type: ticket). Text, date and file kinds hold free values; dropdown and picklist kinds hold a value chosen from the property’s option list. description: >- The matched property. An array of every match when property_id is a name that exists as both a chat and a ticket property and no type query parameter was passed. examples: default: summary: Response body value: property_id: property-aaaaaaaaaaaa property_name: Workspace type: ticket kind: dropdown mandatory: false section_id: 00000000-0000-0000-0000-000000000000 section_name: Issue Details options: - id: '1755859200000' label: Example Corp - id: '1755859200001' label: Globex created_at: '2026-01-15T09:30:00.000Z' '401': description: Invalid, expired or missing API token content: application/json: examples: error: summary: Invalid, expired or missing API token value: code: UNAUTHORIZED_ERROR message: Invalid bearer auth token status: 401 schema: type: object properties: code: type: string example: UNAUTHORIZED_ERROR message: type: string example: Invalid bearer auth token status: type: integer example: 401 example: code: UNAUTHORIZED_ERROR message: Invalid bearer auth token status: 401 '404': description: No custom property matches property_id content: application/json: examples: error: summary: No custom property matches property_id value: code: NOT_FOUND_ERROR message: No custom property matches property_id status: 404 schema: type: object properties: code: type: string example: NOT_FOUND_ERROR message: type: string example: No custom property matches property_id status: type: integer example: 404 example: code: NOT_FOUND_ERROR message: No custom property matches property_id status: 404 '422': description: Request validation failed content: application/json: examples: error: summary: Request validation failed value: code: VALIDATION_ERROR message: Request validation failed status: 422 fields: body.chat_id: message: chat_id is required schema: type: object properties: code: type: string example: VALIDATION_ERROR message: type: string example: Request validation failed status: type: integer example: 422 fields: type: object additionalProperties: type: object properties: message: type: string value: {} example: body.chat_id: message: chat_id is required example: code: VALIDATION_ERROR message: Request validation failed status: 422 fields: body.chat_id: message: chat_id is required '429': description: Rate limit exceeded content: application/json: examples: error: summary: Rate limit exceeded value: code: RATE_LIMIT_ERROR message: You can only make 100 requests per second status: 429 schema: type: object properties: code: type: string example: RATE_LIMIT_ERROR message: type: string example: You can only make 100 requests per second status: type: integer example: 429 example: code: RATE_LIMIT_ERROR message: You can only make 100 requests per second status: 429 '500': description: Internal server error content: application/json: examples: error: summary: Internal server error value: code: UNKNOWN_ERROR message: Internal server error status: 500 schema: type: object properties: code: type: string example: UNKNOWN_ERROR message: type: string example: Internal server error status: type: integer example: 500 example: code: UNKNOWN_ERROR message: Internal server error status: 500 security: - bearerAuth: [] x-codeSamples: - lang: typescript label: TypeScript source: |- import { PeriskopeApi } from '@periskope/periskope-client'; const client = new PeriskopeApi({ authToken: 'YOUR_API_KEY', }); async function main() { const response = await client.properties.getPropertyById({ property_id: 'property-aaaaaaaaaaaa', }); console.log(response); } main(); - lang: bash label: cURL source: >- curl -X GET 'https://api.periskope.app/v1/properties/property-aaaaaaaaaaaa' \ -H 'Authorization: Bearer YOUR_API_KEY' components: schemas: CustomProperty: type: object properties: property_id: type: string description: >- Unique id of the custom property (property-xxxxxxxxxxxxxxxx). Accepted wherever a property_id path parameter or property reference is expected. example: property-aaaaaaaaaaaa property_name: type: string description: >- Name of the property. Unique within its type (case-insensitive) — the same name can exist once as a chat property and once as a ticket property. example: Workspace type: type: string enum: - chat - ticket description: >- Whether the property applies to chats ('chat') or to tickets ('ticket') example: ticket kind: type: string description: >- Value kind of the property: 'text', 'date', 'file', 'dropdown' (single choice), 'picklist' (multiple choice) or 'dependent_dropdown' (dashboard-created only — cannot be created via the API) example: dropdown mandatory: type: boolean description: >- Whether the property must be filled in. Always false for chat properties — only ticket properties can be mandatory. example: false section_id: type: string description: >- Id of the section the property is placed under. null when the property is not in any section. example: 00000000-0000-0000-0000-000000000000 section_name: type: string description: >- Name of the section the property is placed under. null when the property is not in any section. example: Issue Details options: type: array items: $ref: '#/components/schemas/CustomPropertyOption' description: >- Options of the property as {id, label} pairs. Present only for dropdown and picklist kinds — omitted for every other kind. example: - id: '1755859200000' label: Example Corp - id: '1755859200001' label: Globex created_at: type: string description: When the property was created, as an ISO 8601 timestamp example: '2026-01-15T09:30:00.000Z' description: The created property CustomPropertyOption: type: object properties: id: type: string description: >- Id of the option, unique within the property. Stable for the lifetime of the option — store it instead of the label when syncing with an external system. Accepted in place of the label when removing options. example: '1755859200000' label: type: string description: Display label of the option example: Example Corp securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your Periskope API token, sent as `Authorization: Bearer `. Generate one from the Periskope dashboard under **Settings → API & Webhooks**. API access requires an active Pro or Enterprise plan. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.