Fields

List field types

List the types a workspace can create field definitions with (POST /v1/accounts/{accountId}/fields). The built-in signature, initial and signatureDate types are not listed: they can't be created, and their definitions come from GET /v1/accounts/{accountId}/fields?include_standard=true. cpf expects 11 digits; cnpj accepts 14-char values (letters A-Z allowed in positions 1–12 per the CNPJ Alfanumérico rule; check digits 13–14 stay numeric). Punctuation is ignored during validation.

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/field-types

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/field-types
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Response

Field types

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": [
    {
      "type": "cpf",
      "name": "CPF"
    }
  ]
}

Changes

No recorded changes to this operation across all 14 revisions of this API.