Sign in
Workspaces

Get the list of variables (or columns) for a workspace.

This endpoint retrieves all available variables/columns for a specific workspace. It returns both default variables (first_name, email, company_name, company_domain) and any custom variables that have been created for the workspace.

When updating or inserting a lead, you can use the variables/columns from this endpoint to add the values to the specific variable/column for the lead.

get/api/external/v1/workspaces/get-variable-list

Query parameters

workspace_idinteger required

The workspace to list the variables of.

Example:55

The workspace to list the variables of.

Response

object[] required

Example response

[
  {
    "key": "linkedin_profile_url",
    "helpText": "LinkedIn profile URL (at least one of LinkedIn URL, Company Domain, or Email is required)"
  },
  {
    "key": "email",
    "helpText": "Email address (at least one of LinkedIn URL, Company Domain, or Email is required)"
  },
  {
    "key": "company_domain",
    "helpText": "Company domain (at least one of LinkedIn URL, Company Domain, or Email is required)"
  },
  {
    "key": "first_name",
    "helpText": "First name"
  },
  {
    "key": "company_name",
    "helpText": "Company name"
  },
  {
    "key": "My Custom Variable1"
  },
  {
    "key": "custom_variable2"
  }
]

Changes