Get a form

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,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.forms.get("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.forms.get("id", {});
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/forms/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/forms/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/forms/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/forms/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/forms/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

The ID of the form to retrieve.

Maximum string length: 30

Paramètres de requête

hydrate · enum<string>[]

Query parameter to hydrate the response with additional data

Options disponibles: flow_count, links

Maximum string length: 50

Réponse

200

application/json

Form successfully retrieved.

id · string<form-id> · requis

Maximum string length: 30

name · string · requis

Required string length: 1 - 150

created_at · string<date-time> · requis

updated_at · string<date-time> · requis

messages · object

Show child attributes

languages · object

Show child attributes

translations · object

Show child attributes

nodes · object[]

Option 1

Option 2

Option 3

Show child attributes

start · object

Show child attributes

ending · object

Show child attributes

style · object

Show child attributes

embedded_at · string<date>

submitted_at · string<date>