List tags

Tag lookup. Use `id` as `tags_id` on deals.

get /api/v1/tags

Security

ApiKeyAuth

Parameters

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

Responses

200 Tag 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": "Tag",
                        "type": "object",
                        "required": [
                            "id",
                            "name"
                        ],
                        "properties": {
                            "id": {
                                "type": "integer"
                            },
                            "name": {
                                "type": "string"
                            },
                            "colour": {
                                "type": "string",
                                "nullable": true
                            }
                        }
                    }
                }
            }
        }
    ]
}

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)"
        }
    }
}