Skip to main content
GET
/
workspace
/
{workspace_id}
/
custom-fields
List workspace custom fields
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/custom-fields \
  --header 'Authorization: <api-key>'
{
  "custom_fields": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "field_name": "<string>",
      "field_label": "<string>",
      "is_preset": true,
      "preset_value": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

workspace_id
string<uuid>
required

Workspace ID

Response

Custom fields retrieved successfully

custom_fields
object[]