> ## Documentation Index > Fetch the complete documentation index at: https://docs.bridge.new/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve custom attributes by workspaceId > Return the custom attributes for the specified workspace. By default, only **active** attributes are returned (those without a past `deletedAt`). **Filters:** - `category` — Filter by `OPEN` or `CLOSED`. Omit to return all categories. - `includeArchived` — Set to `true` to include archived attributes (those with a past `deletedAt`). Default: `false`. - `isRequired` — Set to `true` to return only required attributes, `false` for optional only. Omit to return all. ## OpenAPI ````yaml /api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/settings/attributes openapi: 3.1.0 info: title: Bridge API summary: Bridge API specification for chat system management. description: >- Bridge API specification including webhook receiver endpoints, Contact CRUD operations, and comprehensive chat system. This API includes: 1. Webhook Receiver API - for CRM clients to receive event notifications from Bridge 2. Contact CRUD API - for clients to manage contacts in Bridge 3. Conversations API - for managing conversations with flexible user identification and participant management 4. Messages API - for sending messages and files to a conversation 5. Files API - for managing files in a message 6. Custom attributes API - for consult custom attributes of an specific workspace **Multi-Tenant Architecture**: All operations are scoped to a specific workspace using workspaceId. termsOfService: https://www.sainapsis.com/legal/terms-of-service contact: name: Bridge Support url: https://app.bridge.new/ email: support@sainapsis.com license: name: MIT License url: https://spdx.org/licenses/MIT.html version: 1.0.0 servers: - url: https://api-connect-us.bridge.new description: Production server security: [] paths: /bridge/api/v1/workspaces/{workspaceId}/settings/attributes: get: tags: - Custom attributes API summary: Retrieve custom attributes by workspaceId description: >- Return the custom attributes for the specified workspace. By default, only **active** attributes are returned (those without a past `deletedAt`). **Filters:** - `category` — Filter by `OPEN` or `CLOSED`. Omit to return all categories. - `includeArchived` — Set to `true` to include archived attributes (those with a past `deletedAt`). Default: `false`. - `isRequired` — Set to `true` to return only required attributes, `false` for optional only. Omit to return all. operationId: >- get_custom_attributes_by_workspace_bridge_api_v1_workspaces__workspaceId__settings_attributes_get parameters: - name: workspaceId in: path required: true schema: type: string format: uuid description: Unique identifier of the workspace (UUID v4). examples: - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234 title: Workspaceid description: Unique identifier of the workspace (UUID v4). - name: category in: query required: false schema: anyOf: - enum: - OPEN - CLOSED type: string - type: 'null' description: Filter by attribute category. Omit to return all categories. title: Category description: Filter by attribute category. Omit to return all categories. - name: includeArchived in: query required: false schema: type: boolean description: >- When `true`, archived attributes (those with a past `deletedAt`) are included in the response. Default is `false`, which returns only active attributes. default: false title: Includearchived description: >- When `true`, archived attributes (those with a past `deletedAt`) are included in the response. Default is `false`, which returns only active attributes. - name: isRequired in: query required: false schema: anyOf: - type: boolean - type: 'null' description: >- Filter by required flag. `true` returns only required attributes, `false` only optional. Omit to return all. title: Isrequired description: >- Filter by required flag. `true` returns only required attributes, `false` only optional. Omit to return all. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomAttributesResponse' '403': description: Forbidden content: application/json: examples: FORBIDDEN: value: title: Forbidden status: 403 code: BRIDGE_CORE_0301 schema: $ref: '#/components/schemas/Problem' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - x-api-key: [] components: schemas: CustomAttributesResponse: properties: customAttributes: items: $ref: '#/components/schemas/CustomAttributes' type: array title: Custom Attributes description: List of custom attributes objects with their values. type: object required: - customAttributes title: CustomAttributesResponse description: Response body for custom attributes operations. Problem: properties: title: type: string title: Title description: Short, summary of the problem type. status: type: integer title: Status description: >- HTTP status code generated by the origin server for this occurrence of the problem. detail: anyOf: - type: string - type: 'null' title: Detail description: Explanation specific to this occurrence of the problem. instance: anyOf: - type: string - type: 'null' title: Instance description: >- A URI reference that identifies the specific occurrence of the problem. traceId: anyOf: - type: string - type: 'null' title: Traceid description: Trace ID for debugging purposes. code: anyOf: - type: string - type: 'null' title: Code description: >- Error code for identification, view the error codes page for more details. errors: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' title: Errors description: List of error details. extra: anyOf: - additionalProperties: true type: object - type: 'null' title: Extra description: Extra information about the problem. type: object required: - title - status title: Problem description: Object representing a Problem response body. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CustomAttributes: properties: id: type: string title: Identifier description: Unique custom attribute identifier. examples: - 651c97c1-b31d-466f-825c-fe77b39e7ae6 category: type: string enum: - OPEN - CLOSED title: Category description: Category of custom attribute. examples: - OPEN - CLOSED isRequired: type: boolean title: Is Required description: Define if the custom attribute is required. examples: - true - false keyName: type: string title: Key Name description: Name of custom attribute. closedAttributesValues: anyOf: - items: $ref: '#/components/schemas/ClosedAttribute' type: array - type: 'null' title: Closed Attributes Values description: List of closed attribute values. type: type: string enum: - TEXT - NUMBER - DATE - SELECT - MULTI_SELECT title: Type description: Type of the values of custom attributes. examples: - TEXT - NUMBER - DATE - SELECT - MULTI_SELECT deletedAt: anyOf: - type: string - type: 'null' title: Deleted At description: Soft-delete timestamp. Null means the attribute is active. type: object required: - id - category - isRequired - keyName - type title: CustomAttributes description: Object representing the custom attribute. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError ClosedAttribute: properties: id: type: string title: Identifier description: Unique closed attribute identifier examples: - 62de01f0-fd48-467c-9c35-18647c51532a value: anyOf: - type: string - type: 'null' title: Value description: Value of closed attributes type: object required: - id title: ClosedAttribute description: Object representing the closed attribute values. securitySchemes: x-api-key: type: apiKey description: Copy the API key as provided by the Bridge Console. in: header name: x-api-key ````