Skip to main content
GET
Retrieve custom attributes by workspaceId

Authorizations

x-api-key
string
header
required

Copy the API key as provided by the Bridge Console.

Path Parameters

workspaceId
string<uuid>
required

Unique identifier of the workspace (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

Query Parameters

category
enum<string> | null

Filter by attribute category. Omit to return all categories.

Available options:
OPEN,
CLOSED
includeArchived
boolean
default:false

When true, archived attributes (those with a past deletedAt) are included in the response. Default is false, which returns only active attributes.

isRequired
boolean | null

Filter by required flag. true returns only required attributes, false only optional. Omit to return all.

Response

Successful Response

Response body for custom attributes operations.

customAttributes
CustomAttributes · object[]
required

List of custom attributes objects with their values.