Obtener un formulario

GET https://{tenantDomain}/api/v2/forms/{id}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.GetFormRequestParameters{}
    client.Forms.Get(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "embedded_at": "2023-12-25",
  "ending": {
    "after_submit": {
      "flow_id": "<string>"
    },
    "coordinates": {
      "x": 0,
      "y": 0
    },
    "redirection": {
      "target": "<string>",
      "delay": 5
    }
  },
  "languages": {
    "default": "<string>",
    "primary": "<string>"
  },
  "messages": {
    "custom": {},
    "errors": {}
  },
  "nodes": [
    {
      "config": {
        "flow_id": "<string>",
        "next_node": "<string>"
      },
      "id": "<string>",
      "alias": "<string>",
      "coordinates": {
        "x": 0,
        "y": 0
      }
    }
  ],
  "start": {
    "coordinates": {
      "x": 0,
      "y": 0
    },
    "hidden_fields": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "next_node": "<string>"
  },
  "style": {
    "css": "<string>"
  },
  "submitted_at": "2023-12-25",
  "translations": {}
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

id · string · requerido

El ID del formulario que se va a recuperar.

Maximum string length: 30

Parámetros de consulta

hydrate · enum<string>[]

Parámetro de consulta para completar la respuesta con datos adicionales

Opciones disponibles: flow_count, links

Maximum string length: 50

Respuesta

200

application/json

Form recuperado correctamente.

created_at · string<date-time> · requerido

id · string<form-id> · requerido

Maximum string length: 30

name · string · requerido

Required string length: 1 - 150

updated_at · string<date-time> · requerido

embedded_at · string<date>

ending · object

Show child attributes

languages · object

Show child attributes

messages · object

Show child attributes

nodes · object[]

Option 1

Option 2

Option 3

Show child attributes

start · object

Show child attributes

style · object

Show child attributes

submitted_at · string<date>

translations · object

Show child attributes