List fields on a workspace

This endpoint will provide a list of all the available fields/variables on a workspace.

Endpoint

cURL

GET https://api.mailstand.com/workspaces/{{workspace_id}}/all-fields

Parameters

Field	Required	Description
workspace	true	The workspace ID that you want to query.

200 Response

JSON

{
    "status": "ok",
    "data: [
        {
            "label": "First Name",
            "code": "first_name",
            "searchable": [
                "firstname",
                "first"
            ]
        },
        {
            "label": "Middle Name",
            "code": "middle_name",
            "searchable": [
                "middlename",
                "middle"
            ]
        },
        {
            "label": "Last Name",
            "code": "last_name",
            "searchable": [
                "lastname",
                "last"
            ]
        },
        {
            "label": "Full Name",
            "code": "full_name",
            "searchable": [
                "fullname",
                "full"
            ]
        },
        {
            "label": "Nickname",
            "code": "nickname",
            "searchable": [
                "nickname"
            ]
        },
        {
            "label": "Email Address",
            "code": "email",
            "searchable": [
                "email",
                "emailaddress"
            ]
        },
        {
            "label": "Imgur URL",
            "code": "custom_1",
            "searchable": [
                "imgururl"
            ]
        }
        //...
    ]
    
}

Response Fields

	Description
data[label]	The pretty name for the field/variable.
data[code]	The actual field name that you can use for creating contacts, editing contacts, etc...
data[searchable]	An array of lower case names used to easily filter for the field/variable that you're looking for.