Skip to main content
GET
List fields

Authorizations

x-conveyour-token
string
header
required

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

Query Parameters

bucket
string

Filter to a specific bucket by name. Omit to return all buckets. Common values: contact, communication, system.

event
string

Filter to fields relevant to a specific event type. Returns a subset of fields keyed by event-specific identifiers.

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

A field bucket (section) with its field definitions. Verified against a live GET /api/fields response. The fields map is org-defined — keys are field names configured for that organization.