Skip to main content
GET
List folders

Authorizations

x-conveyour-token
string
header
required

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

Query Parameters

schema
string

Use small for a lightweight response with minimal folder metadata. Default: full.

folder_id
string

Filter by parent folder ID. Omit to return all folders.

page
integer

Page number for paginated results (1-based). Omit or pass 0 for no pagination.

per_page
integer

Items per page when page is set. Default: 50.

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.

deleted
boolean
default:false

Return soft-deleted folders instead of active ones.

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[]

The response payload — an object or an array depending on the endpoint.