List

GET

/api-keys

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api-keys' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Main Admin Key",
  "admin": "<admin_user_id_1>",
  "is_active": true
}'

Response Example

200 - List - List

{
    "success": true,
    "data": [
        {
            "id": "e4a1f2b2-3f5c-4305-9d2d-957c19e434f2",
            "created_at": "2025-04-06T09:02:42.452334-05:00",
            "updated_at": "2025-04-06T09:02:42.452363-05:00",
            "key": "4fa7121d-ee1a-49e3-9ca9-9821a2733af7",
            "name": "Main Admin Key",
            "is_active": true,
            "last_used_at": null,
            "admin": "5523006f-7b7d-4879-9eda-62c500bbc52b"
        },
        {
            "id": "5fc2e94a-67d8-4a77-bcca-e28184f54ac9",
            "created_at": "2025-04-06T09:05:17.501562-05:00",
            "updated_at": "2025-04-06T09:05:17.501586-05:00",
            "key": "23d94cda-7ee4-493e-b825-17c835d1c8f2",
            "name": "Store Manager Key",
            "is_active": true,
            "last_used_at": null,
            "admin": "5523006f-7b7d-4879-9eda-62c500bbc52b"
        },
        {
            "id": "d3f6c548-cf98-45aa-bd93-3e4983e2bda2",
            "created_at": "2025-04-06T09:05:37.138185-05:00",
            "updated_at": "2025-04-06T09:05:37.138206-05:00",
            "key": "1e62274b-034c-427a-b9db-03f8a0ccc894",
            "name": "Store Manager Key",
            "is_active": false,
            "last_used_at": null,
            "admin": "5523006f-7b7d-4879-9eda-62c500bbc52b"
        }
    ],
    "message": "Request successful"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/json

Examples

Responses

🟢200List

application/json

Body

🟢200List

Modified at 2025-04-07 21:10:50

Delete

Create