Find comunicado recipients

QA Environment

https://qa-api.kiolinkapp.com

POST

/v1/comunicados/business-users/search

Comunicados

Last modified:2026-10-05 22:16:43

Maintainer:Not configured

Required Permission(s):comunicados-items-readcomunicados-items-createcomunicados-items-update

Returns the business users that match a comunicado's filters, to use as its _business_users. A user matches when:

they are active and receive releases (show_in_releases),

their role is one of roles,

their business's language_notices is language, and

their business has one of locations with at least one of its phases.

Requires a session token whose role has any of these permissions: comunicados-items-read, comunicados-items-create, comunicados-items-update.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Body Params application/jsonRequired

Example

{
  "locations": [
    {
      "datacenter": "MEX1",
      "fases": [
        "F1"
      ]
    }
  ],
  "roles": [
    "65f1c2a9e4b0a1b2c3d4e5b2"
  ],
  "language": "es"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://qa-api.kiolinkapp.com/v1/comunicados/business-users/search' \
--header 'authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "locations": [
    {
      "datacenter": "MEX1",
      "fases": [
        "F1"
      ]
    }
  ],
  "roles": [
    "65f1c2a9e4b0a1b2c3d4e5b2"
  ],
  "language": "es"
}'

Responses

🟢200Matching users

application/json

Matching users.

Bodyapplication/json

Example

{
    "data": [
        {
            "_id": "65f1c2a9e4b0a1b2c3d4e5f6",
            "email": "ana.lopez@example.com",
            "firstname": "Ana",
            "lastname": "López",
            "show_in_releases": true,
            "business": {
                "name": "Digital Ignition",
                "datacenters": [
                    {
                        "_id": "65f1c2a9e4b0a1b2c3d4e601",
                        "datacenter": "MEX1",
                        "status": true,
                        "fases": [
                            "F1",
                            "F2"
                        ]
                    }
                ]
            }
        }
    ]
}

🟠401The session token expired

🟠403Not authenticated (missing/invalid token, inactive user), or

🔴500Unexpected error (e

Modified at 2026-10-05 22:16:43

Send a comunicado now

View a comunicado I received