Get Routing Form

Fetch a routing form’s definition, including its questions, answer options, and display settings.

Endpoint


GET /api/public/routing/{userSlug}/{formSlug}

Authentication: None required

Path Parameters

Parameter	Type	Description
`userSlug`	`string`	The user’s unique URL slug
`formSlug`	`string`	The routing form’s URL slug

Response

Returns 200 OK with the form definition.


{
  "id": "rf_abc123",
  "name": "Book a Meeting",
  "slug": "book-a-meeting",
  "description": "Answer a few questions so we can connect you with the right person.",
  "fields": [
    {
      "id": "field_company_size",
      "label": "What is your company size?",
      "type": "select",
      "required": true,
      "options": [
        { "id": "opt_1", "label": "1-10 employees" },
        { "id": "opt_2", "label": "11-50 employees" },
        { "id": "opt_3", "label": "51-200 employees" },
        { "id": "opt_4", "label": "200+ employees" }
      ]
    },
    {
      "id": "field_topic",
      "label": "What do you need help with?",
      "type": "select",
      "required": true,
      "options": [
        { "id": "opt_a", "label": "Product demo" },
        { "id": "opt_b", "label": "Technical support" },
        { "id": "opt_c", "label": "Billing question" }
      ]
    },
    {
      "id": "field_email",
      "label": "Your email address",
      "type": "text",
      "required": true,
      "options": []
    }
  ],
  "branding": {
    "primaryColor": "#4F46E5",
    "logoUrl": "https://storage.proximity.io/logos/acme.png"
  }
}

Response Fields

Field	Type	Description
`id`	`string`	Unique form identifier
`name`	`string`	Form display name
`slug`	`string`	URL-safe slug
`description`	`string \| null`	Description shown to visitors
`fields`	`array`	Ordered list of form fields
`branding`	`object`	Form branding settings

`fields[]`

Field	Type	Description
`id`	`string`	Unique field identifier
`label`	`string`	Question text shown to the visitor
`type`	`string`	Field type: `select`, `text`, `email`, `phone`, `textarea`
`required`	`boolean`	Whether the field is required
`options`	`array`	Answer options (for `select` fields)

Errors

Status	Description
`404`	User or routing form not found

Code Examples

cURL


curl https://app.proximity.io/api/public/routing/jane-doe/book-a-meeting

JavaScript


const response = await fetch(
  'https://app.proximity.io/api/public/routing/jane-doe/book-a-meeting'
);
const form = await response.json();
 
console.log(`Form: ${form.name}`);
form.fields.forEach(field => {
  console.log(`  ${field.label} (${field.type}, required: ${field.required})`);
});