v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Reception Flows

Get reception flows

Retrieve all reception flows in the organization

Required scopes: flex.community.receptionFlows.read

get/api/v2/organizations/{orgSlug}/reception-flows

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

Filter by reception flow id. Supports both single id values (e.g., _id=66623dc53090242657393910) and array operations (e.g., _id[$in]=66623dc53090242657393910,66623dbf309024265739390a). Note: Multiple values in simple string format (e.g., _id=66623dc53090242657393910,66623dbf309024265739390a) are not allowed - use _id[$in] format instead.

namestring

Example:Member

Filter by reception flow name.

typestring

Example:visitor

Filter by reception flow type.

locationstring

Example:603dfbc260f4054084125d39

Filter by reception flow location.

enabledboolean

Example:true

Filter by reception flow enabled status.

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_id": "6080186f490fcf6e0547ec57",
      "name": "Visitor",
      "location": "6080186f490fcf6e0547ec58"
    }
  ]
}