Get Client ID Request Status

GET

https://api.inboxkit.com/v1/api/mailboxes/client-id-request/status/{requestId}

Maintainer:Not configured

Returns the current state of a client ID request.

A Microsoft request is asynchronous: it stays processing while tenant-wide admin consent is being granted, which takes minutes. While it is waiting it reports processing with a null error_message, so keep polling rather than treating it as failed. errored and failed mean what they say.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Responses

🟢200Request Status Retrieved Successfully

application/json

Bodyapplication/json

🟠404Request Not Found

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.inboxkit.com/v1/api/mailboxes/client-id-request/status/' \
--header 'X-Workspace-Id: a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "error": false,
    "message": "Client ID request status retrieved successfully",
    "data": {
        "uid": "req-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "status": "queued",
        "domain_name": "example.com",
        "client_id": "123456789-abcdefghijklmnop.apps.googleusercontent.com",
        "platform": "GOOGLE",
        "delegated": true,
        "scopes": [
            "https://www.googleapis.com/auth/gmail.modify",
            "https://www.googleapis.com/auth/admin.directory.user"
        ],
        "created_at": "2025-01-15T10:00:00.000Z",
        "updated_at": "2025-01-15T10:05:30.000Z",
        "completed_at": "2025-01-15T10:05:30.000Z",
        "error_message": null
    }
}

Modified at 2026-08-19 16:01:11

Initiate Client ID Request

List Client ID Requests