Solarware API Docs
Download YAML

List salutations

Salutation lookup. Use `id` as `salutations_id` on contacts.

get /api/v1/salutations

Security

ApiKeyAuth

Parameters

Name In Type Details
search query string optional Search across entity fields and nested CRM emails/phones/addresses

Responses

200 Salutation list

application/json

{
    "allOf": [
        {
            "title": "API envelope",
            "type": "object",
            "properties": {
                "success": {
                    "type": "boolean"
                },
                "message": {
                    "type": "string",
                    "nullable": true
                },
                "errors": {
                    "nullable": true
                },
                "meta": {
                    "type": "object",
                    "nullable": true,
                    "additionalProperties": true
                }
            }
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "type": "array",
                    "items": {
                        "title": "Salutation",
                        "type": "object",
                        "required": [
                            "id",
                            "salutation"
                        ],
                        "properties": {
                            "id": {
                                "type": "integer"
                            },
                            "salutation": {
                                "type": "string"
                            }
                        }
                    }
                }
            }
        }
    ]
}
401 Missing or invalid API key

application/json

{
    "type": "object",
    "properties": {
        "success": {
            "type": "boolean",
            "example": false
        },
        "message": {
            "type": "string",
            "example": "Missing API key (X-Api-Key)"
        }
    }
}