Get Started

Custom Properties

Custom properties allow you to add custom fields to resources in your workspace. Learn more about custom properties here.

List Custom Properties

get

Get all custom properties in the workspace.

Authorizations
Responses
200

List of custom properties

application/json
get
GET /api/v1/resource/all_v2/custom_properties/ HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "entity_types": [
      "text"
    ]
  }
]

Create Custom Property

post

Create a new custom property in the workspace.

Authorizations
Body
namestringRequired
value_typestring · enumRequiredPossible values:
Responses
200

Custom property created successfully

application/json
post
POST /api/v1/resource/all_v2/custom_properties/ HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "name": "text",
  "entity_types": [
    "all"
  ],
  "value_type": "string"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "entity_types": [
    "text"
  ]
}

Get Custom Property

get

Get details of a specific custom property.

Authorizations
Path parameters
custom_property_idstringRequired
Responses
200

Custom property details

application/json
get
GET /api/v1/resource/all_v2/custom_properties/{custom_property_id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "entity_types": [
    "text"
  ]
}

Update Custom Property

put

Update an existing custom property.

Authorizations
Path parameters
custom_property_idstringRequired
Body
namestringRequired
value_typestring · enumRequiredPossible values:
Responses
200

Custom property updated successfully

application/json
put
PUT /api/v1/resource/all_v2/custom_properties/{custom_property_id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "name": "text",
  "entity_types": [
    "all"
  ],
  "value_type": "string"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "entity_types": [
    "text"
  ]
}

Delete Custom Property

delete

Delete a custom property.

Authorizations
Path parameters
custom_property_idstringRequired
Responses
204

Custom property deleted successfully

delete
DELETE /api/v1/resource/all_v2/custom_properties/{custom_property_id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*

No content

Update Entity Custom Property Value

put

Update the value of a custom property for a specific entity.

Authorizations
Path parameters
custom_property_idstringRequired

The ID of the custom property

entity_idstringRequired

The ID of the entity

Body
valuestringRequired
Responses
200

Custom property value updated successfully

put
PUT /api/v1/resource/all_v2/custom_properties/{custom_property_id}/{entity_id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "value": "text"
}
No content

Bulk Update Entity Custom Properties

put

Update custom property values for multiple entities in a single request. To bulk delete custom property values, set their values to an empty string ("").

Authorizations
Body
entity_idsstring[]Required

List of entity IDs to update

Example: ["550e8400-e29b-41d4-a716-446655440000","7c9e6679-7425-40de-944b-e07fc1f90ae7"]
Responses
200

Custom property values updated successfully

put
PUT /api/v1/resource/all_v2/bulk_update/custom_properties/ HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "entity_ids": [
    "550e8400-e29b-41d4-a716-446655440000",
    "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  ],
  "properties": {
    "550e8400-e29b-41d4-a716-446655440000": "value1",
    "My%20Custom%20Property": ""
  }
}
No content

Was this helpful?