Skip to main content
GET
List tags

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

count
boolean

When truthy, adds a messages_count field to each tag with the number of messages carrying that tag.

deleted
boolean

When truthy, returns only soft-deleted tags instead of active ones.

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object[]

All tags. Pass deleted=1 to list soft-deleted tags instead. messages_count appears on each record only when count=true is passed.