Skip to main content
GET
Get a folder

Authorizations

x-conveyour-token
string
header
required

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

Path Parameters

id
string
required

The id identifier.

Query Parameters

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.

schema
string
default:full

Which field set to return. Defaults to full.

deleted
boolean
default:false

Return soft-deleted folders instead of active ones.

folder_id
string

Only folders whose parent is this ID. Pass null to get top-level folders.

page
integer

Page number for the CHILD listing. Passing this switches each child array to a paginated object.

per_page
integer
default:50

Children per page when page is passed. Defaults to 50, capped at limits.folder_children.

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 bookmark folder, returned by the shared folder endpoints.