Get a Routing Form - Zeeg Developer Hub

GET

routing-forms

{id}

Get a routing form

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zeeg.me/v2/routing-forms/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zeeg.me/v2/routing-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;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zeeg.me/v2/routing-forms/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zeeg.me/v2/routing-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

{
  "success": true,
  "status": 200,
  "routingForm": {
    "id": "f1cbafc4-b646-4cf9-af29-193491b555d9",
    "name": "Inbound Lead Qualification",
    "slug": "inbound-lead-qual",
    "url": "https://zeeg.me/RF/inbound-lead-qual",
    "isActive": true,
    "headline": "Tell us about your team",
    "body": null,
    "submitBtnText": "Continue",
    "styleSettings": {
      "bgColor": "#ffffff",
      "buttonBgColor": "#1f2937",
      "buttonTextColor": "#ffffff"
    },
    "createdAt": "2026-04-01T09:12:44+00:00",
    "updatedAt": "2026-04-10T08:30:00+00:00",
    "inputs": [
      {
        "id": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
        "label": "What is your company size?",
        "type": "SELECT",
        "order": 0,
        "isRequired": true,
        "isActive": true,
        "options": [
          "1-10 employees",
          "50-200 employees"
        ],
        "crmAttribute": null
      }
    ],
    "routes": [
      {
        "id": "c4a1e0d2-5f39-4a7b-8f11-2b6d0c9e7a84",
        "type": "EVENT_TYPE",
        "isFallback": false,
        "order": 0,
        "customUrl": null,
        "submissionParamsForwarding": false,
        "headline": null,
        "body": null,
        "eventType": {
          "id": "80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
          "title": "30-Minute Discovery Call",
          "slug": "30min-discovery-call",
          "uri": "https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e"
        },
        "team": null,
        "rules": {
          "all": [
            {
              "inputId": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
              "operator": "is_any_of",
              "values": [
                "50-200 employees"
              ]
            }
          ]
        }
      },
      {
        "id": "2e7f4b90-8a13-4c6d-b5e2-7f0a9c3d1e64",
        "type": "CUSTOM_PAGE",
        "isFallback": true,
        "order": 1,
        "customUrl": null,
        "submissionParamsForwarding": false,
        "headline": "Thank you",
        "body": "A member of the team contacts you within one working day.",
        "eventType": null,
        "team": null,
        "rules": []
      }
    ]
  }
}

Returns one routing form with its questions in inputs and its routes in routes. A question carries its type, its options, and the CRM attribute it maps onto. A question that takes no options carries an empty options array. A route carries its destination and the rules that select it. Exactly one route is the fallback, which takes every submission that matches no other route. The fallback carries an empty rules array.

The id is a UUID. A malformed id answers 404, not 422. A routing form outside your workspace answers 404 as well.

Authorizations

Authorization

string

header

required

Path Parameters

string<uuid>

required

UUID of the routing form.

Response

success

boolean

Example:

true

status

integer

Example:

200

routingForm

object

A routing form with its questions and its routes, as returned when you fetch one routing form.

Hide child attributes

routingForm.id

string<uuid>

Example:

"f1cbafc4-b646-4cf9-af29-193491b555d9"

routingForm.name

string

The internal name of the routing form.

Example:

"Inbound Lead Qualification"

routingForm.slug

string

The slug that addresses the routing form in its public URL.

Example:

"inbound-lead-qual"

routingForm.url

string<uri>

The public address at which an invitee opens the routing form.

Example:

"https://zeeg.me/RF/inbound-lead-qual"

routingForm.isActive

boolean

An inactive routing form accepts no submission.

Example:

true

routingForm.headline

string | null

The headline that the routing form shows above the questions.

Example:

"Tell us about your team"

routingForm.body

string | null

The body text that the routing form shows below the headline.

Example:

null

routingForm.submitBtnText

string | null

The label on the submit button of the routing form.

Example:

"Continue"

routingForm.styleSettings

object

The colours of the public routing form page. Each value is a CSS colour of at most 20 characters, or null when the routing form sets no colour. A response always carries the object with all three keys. The write endpoints accept the same shape, so a routing form that you read goes straight back to PATCH /routing-forms/{id} without reshaping.

Hide child attributes

routingForm.styleSettings.bgColor

string | null

Background colour of the page.

Maximum string length: 20

Example:

"#ffffff"

routingForm.styleSettings.buttonBgColor

string | null

Background colour of the submit button.

Maximum string length: 20

Example:

"#1f2937"

routingForm.styleSettings.buttonTextColor

string | null

Text colour of the submit button.

Maximum string length: 20

Example:

"#ffffff"

routingForm.createdAt

string<date-time> | null

Time at which the routing form was created, in UTC.

Example:

"2026-04-01T09:12:44+00:00"

routingForm.updatedAt

string<date-time> | null

Time of the last change to the routing form, in UTC.

Example:

"2026-04-10T08:30:00+00:00"

routingForm.inputs

object[]

The questions of the routing form, which the invitee answers in the given order.

Hide child attributes

routingForm.inputs.id

string<uuid>

Example:

"f7c82298-6dd9-43bd-98e4-c437b5c0ae47"

routingForm.inputs.label

string

The question text that the invitee reads.

Example:

"What is your company size?"

routingForm.inputs.type

enum<string>

The answer control that the routing form shows for this question.

Available options:

TEXT_INPUT,

TEXTAREA,

SELECT,

RADIO_INPUT,

EMAIL,

PHONE_NUMBER,

NUMBER_INPUT,

CRM_ATTRIBUTE

Example:

"SELECT"

routingForm.inputs.order

integer

Position of the question in the routing form. The first question carries 0.

Example:

0

routingForm.inputs.isRequired

boolean

True when the invitee must answer the question.

Example:

true

routingForm.inputs.isActive

boolean

The routing form hides the question when this is false.

Example:

true

routingForm.inputs.options

(string | object)[]

The selectable values of the question. A SELECT or RADIO_INPUT question carries plain strings. A CRM_ATTRIBUTE question carries the option objects of the CRM attribute. Every other type carries an empty array.

Example:

["1-10 employees", "50-200 employees"]

routingForm.inputs.crmAttribute

object | null

The CRM attribute that a question maps onto. It is null when the question maps onto no attribute.

Hide child attributes

routingForm.inputs.crmAttribute.objectSlug

string

Slug of the CRM object that holds the attribute.

Example:

"companies"

routingForm.inputs.crmAttribute.attributeSlug

string

Slug of the attribute on that object.

Example:

"industries"

routingForm.routes

object[]

The routes of the routing form. Exactly one route is the fallback.

Hide child attributes

routingForm.routes.id

string<uuid>

Example:

"c4a1e0d2-5f39-4a7b-8f11-2b6d0c9e7a84"

routingForm.routes.type

enum<string>

The kind of destination. EVENT_TYPE opens a scheduling page, TEAM_PAGE opens the page of a team, URL redirects to an external address, and CUSTOM_PAGE shows a message inside the routing form.

Available options:

EVENT_TYPE,

URL,

CUSTOM_PAGE,

TEAM_PAGE

Example:

"EVENT_TYPE"

routingForm.routes.isFallback

boolean

The fallback route takes every submission that matches no other route.

Example:

false

routingForm.routes.order

integer

Position of the route in the routing form. The first route carries 0. The routing form takes the first route whose conditions hold.

Example:

0

routingForm.routes.customUrl

string | null

Destination address of a URL route. It is null for every other type.

Example:

null

routingForm.routes.submissionParamsForwarding

boolean

True when the answers are appended to the destination as query parameters. Send it back unchanged when you replace the routes, since an absent flag stores false.

Example:

false

routingForm.routes.headline

string | null

Headline of a CUSTOM_PAGE route.

Example:

"Thank you"

routingForm.routes.body

string | null

Body text of a CUSTOM_PAGE route.

Example:

"A member of the team contacts you within one working day."

routingForm.routes.eventType

object | null

The event type that a route or a submission points at. It is null when no event type is set.

Hide child attributes

routingForm.routes.eventType.id

string<uuid>

Example:

"80f46bf5-eb01-4c07-960e-a9a3e18aae5e"

routingForm.routes.eventType.title

string

Example:

"30-Minute Discovery Call"

routingForm.routes.eventType.slug

string

Example:

"30min-discovery-call"

routingForm.routes.eventType.uri

string<uri>

Address of the event type in this API.

Example:

"https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e"

routingForm.routes.team

object | null

The team that a route or a submission points at. It is null when no team is set.

Hide child attributes

routingForm.routes.team.id

string<uuid>

Example:

"3d9b1a77-2c58-4e6a-9f30-8b1c5d4e2f6a"

routingForm.routes.team.title

string

Example:

"Sales EMEA"

routingForm.routes.team.slug

string

Example:

"sales-emea"

routingForm.routes.rules

The condition tree that selects this route. A node is either a group or a condition. A group holds child nodes under any for OR, or under all for AND. A condition holds inputId, operator and values. The operator is one of equals, does_not_equal, is_any_of, is_not_any_of, contains, does_not_contain, starts_with, ends_with, greater_than, greater_than_or_equal, less_than, less_than_or_equal, is_empty or is_not_empty. The fallback route carries an empty array, because it needs no condition.

Example:

{
  "all": [
    {
      "inputId": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
      "operator": "is_any_of",
      "values": ["50-200 employees"]
    }
  ]
}

Last modified on September 9, 2026

Get a routing form

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zeeg.me/v2/routing-forms/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zeeg.me/v2/routing-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;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zeeg.me/v2/routing-forms/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zeeg.me/v2/routing-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

{
  "success": true,
  "status": 200,
  "routingForm": {
    "id": "f1cbafc4-b646-4cf9-af29-193491b555d9",
    "name": "Inbound Lead Qualification",
    "slug": "inbound-lead-qual",
    "url": "https://zeeg.me/RF/inbound-lead-qual",
    "isActive": true,
    "headline": "Tell us about your team",
    "body": null,
    "submitBtnText": "Continue",
    "styleSettings": {
      "bgColor": "#ffffff",
      "buttonBgColor": "#1f2937",
      "buttonTextColor": "#ffffff"
    },
    "createdAt": "2026-04-01T09:12:44+00:00",
    "updatedAt": "2026-04-10T08:30:00+00:00",
    "inputs": [
      {
        "id": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
        "label": "What is your company size?",
        "type": "SELECT",
        "order": 0,
        "isRequired": true,
        "isActive": true,
        "options": [
          "1-10 employees",
          "50-200 employees"
        ],
        "crmAttribute": null
      }
    ],
    "routes": [
      {
        "id": "c4a1e0d2-5f39-4a7b-8f11-2b6d0c9e7a84",
        "type": "EVENT_TYPE",
        "isFallback": false,
        "order": 0,
        "customUrl": null,
        "submissionParamsForwarding": false,
        "headline": null,
        "body": null,
        "eventType": {
          "id": "80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
          "title": "30-Minute Discovery Call",
          "slug": "30min-discovery-call",
          "uri": "https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e"
        },
        "team": null,
        "rules": {
          "all": [
            {
              "inputId": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
              "operator": "is_any_of",
              "values": [
                "50-200 employees"
              ]
            }
          ]
        }
      },
      {
        "id": "2e7f4b90-8a13-4c6d-b5e2-7f0a9c3d1e64",
        "type": "CUSTOM_PAGE",
        "isFallback": true,
        "order": 1,
        "customUrl": null,
        "submissionParamsForwarding": false,
        "headline": "Thank you",
        "body": "A member of the team contacts you within one working day.",
        "eventType": null,
        "team": null,
        "rules": []
      }
    ]
  }
}