Chilkat Online Tools

Perl / Atlassian Confluence Cloud / Get user email addresses in batch

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("accountId","<string>");
$queryParams->UpdateString("accountId","<string>");

# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/user/email/bulk",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jarrResp = chilkat::CkJsonArray->new();
$jarrResp->LoadSb($sbResponseBody);
$jarrResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jarrResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# [
#   {
#     "accountId": "sint aute elit sunt",
#     "email": "dolor eu occaecat consectetur"
#   },
#   {
#     "accountId": "veniam in sunt",
#     "email": "dolor sunt eiusmod"
#   }
# ]

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$i = 0;
$count_i = $jarrResp->get_Size();
while ($i < $count_i) {
    # json is a JsonObject
    $json = $jarrResp->ObjectAt($i);
    $accountId = $json->stringOf("accountId");
    $email = $json->stringOf("email");

    $i = $i + 1;
}

Curl Command

curl -G -d "accountId=%3Cstring%3E"
	-d "accountId=%3Cstring%3E"
https://your-domain.atlassian.net/wiki/rest/api/user/email/bulk

Postman Collection Item JSON

{
  "name": "Get user email addresses in batch",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/user/email/bulk?accountId=<string>&accountId=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "user",
        "email",
        "bulk"
      ],
      "query": [
        {
          "key": "accountId",
          "value": "<string>",
          "description": "(Required) The account IDs of the users."
        },
        {
          "key": "accountId",
          "value": "<string>",
          "description": "(Required) The account IDs of the users."
        }
      ]
    },
    "description": "Returns user email addresses for a set of accountIds. This API is only available to apps approved by\nAtlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).\n\nAny accounts which are not available will not be included in the result.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\nPermission to access the Confluence site ('Can use' global permission)."
  },
  "response": [
    {
      "name": "Returned if the request is successful.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/api/user/email/bulk?accountId=<string>&accountId=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "user",
            "email",
            "bulk"
          ],
          "query": [
            {
              "key": "accountId",
              "value": "<string>"
            },
            {
              "key": "accountId",
              "value": "<string>"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n {\n  \"accountId\": \"sint aute elit sunt\",\n  \"email\": \"dolor eu occaecat consectetur\"\n },\n {\n  \"accountId\": \"veniam in sunt\",\n  \"email\": \"dolor sunt eiusmod\"\n }\n]"
    },
    {
      "name": "Returned if the calling app is not approved to use this API.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/api/user/email/bulk?accountId=<string>&accountId=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "user",
            "email",
            "bulk"
          ],
          "query": [
            {
              "key": "accountId",
              "value": "<string>"
            },
            {
              "key": "accountId",
              "value": "<string>"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Returned if the authentication credentials are incorrect or missing\nfrom the request.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/api/user/email/bulk?accountId=<string>&accountId=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "user",
            "email",
            "bulk"
          ],
          "query": [
            {
              "key": "accountId",
              "value": "<string>"
            },
            {
              "key": "accountId",
              "value": "<string>"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Indicates that the API is not currently enabled.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/api/user/email/bulk?accountId=<string>&accountId=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "user",
            "email",
            "bulk"
          ],
          "query": [
            {
              "key": "accountId",
              "value": "<string>"
            },
            {
              "key": "accountId",
              "value": "<string>"
            }
          ]
        }
      },
      "status": "Not Implemented",
      "code": 501,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}