Read API keys

Retrieve a paginated list of API keys for a community. This endpoint provides an overview
of all API keys in the community without exposing the actual key values for security.

Security Requirements:

Bearer token authentication required

Only community owners and administrators can access this endpoint

User must have either COMMUNITY_OWNER or COMMUNITY_ADMIN permissions for the specified community

Key Features:

Paginated results with configurable page size

API key values are masked for security (not included in response)

Sorted by creation date (newest first)

Includes permission information for each key

Real-time event emission to community members

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

communityId

string <objectId>

required

The unique identifier of the community

Example:

675a1234bcde567890123456

Query Params

page

integer

optional

Page number for pagination

>= 1

Default:

Example:

limit

integer

optional

Number of API keys per page

>= 1<= 100

Default:

Example:

Responses

🟢200OK

application/json

Read API keys successful

Body

meta

object

optional

status

string

optional

Response status

statusCode

number

optional

HTTP status code

total

number

optional

Total number of API keys

page

number

optional

Current page number

limit

number

optional

Number of items per page

message

string

optional

Success message for the operation

data

array [object {8}]

optional

_id

string

optional

The unique identifier of the API key

name

string

optional

The name of the API key

key

string

optional

The API key value

permissions

array[string]

optional

Array of permissions assigned to the API key

expirePeriod

number

optional

Expiration period in days (0 for no expiration)

expireDate

string

optional

Specific expiration date for the API key

updatedAt

string <date-time>

optional

When the API key was last updated

createdAt

string <date-time>

optional

When the API key was created

Example

{
    "meta": {
        "status": "success",
        "statusCode": 200,
        "total": 5,
        "page": 1,
        "limit": 20
    },
    "message": "Read API keys success.",
    "data": [
        {
            "_id": "675b9876fedc432109876543",
            "name": "Slack Integration API Key",
            "key": "8f3e4d5c6b7a9e2f1a4b7c8d5e9f2a6b3c7e8f1a4b5c9d2e6f8a1b4c7e9f2a5b8c",
            "permissions": [
                "sendMessage",
                "replyMessage",
                "createUser",
                "manageUser",
                "getUserData",
                "getUserStats",
                "bulkUpdateUser",
                "userFields"
            ],
            "expirePeriod": 0,
            "expireDate": "",
            "updatedAt": "2024-12-15T10:30:45.123Z",
            "createdAt": "2024-12-15T10:30:45.123Z"
        },
        {
            "_id": "675c1122aabb334455667788",
            "name": "Payment Webhook Service",
            "key": "2a7b8c9d4e5f6a1b2c3d4e5f6a7b8c9d4e5f6a1b2c3d4e5f6a7b8c9d4e5f6a1b2c",
            "permissions": [
                "sendMessage",
                "replyMessage",
                "createUser",
                "manageUser",
                "getUserData",
                "getUserStats",
                "bulkUpdateUser",
                "userFields"
            ],
            "expirePeriod": 365,
            "expireDate": "2025-12-15T23:59:59.000Z",
            "updatedAt": "2024-12-10T16:42:18.789Z",
            "createdAt": "2024-12-10T09:15:30.456Z"
        },
        {
            "_id": "675d2233ccdd445566778899",
            "name": "Development Testing Key",
            "key": "5c8e9f2a6b3d7e1a4b5c9d2e6f8a1b4c7e9f2a5b8c3e6f9a2b5c8d1e4f7a0b3c6d",
            "permissions": [
                "sendMessage",
                "replyMessage",
                "createUser",
                "manageUser",
                "getUserData",
                "getUserStats",
                "bulkUpdateUser",
                "userFields"
            ],
            "expirePeriod": 30,
            "expireDate": "2025-01-14T23:59:59.000Z",
            "updatedAt": "2024-12-14T14:20:12.345Z",
            "createdAt": "2024-12-14T14:20:12.345Z"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses