APIKey

Requires one of the following scopes: api_keys:read, api_keys:all, all:read, all:all

get/api/v2/api-keys

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/api-keys
  • Auth
    HTTP bearer

Query parameters

limitinteger
Example:10

The number of items to return

starting_afterstring
Example:01956fbd-0eb1-72db-a565-82977a586084

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

Response

The list of API Key

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example response

{
  "items": [
    {
      "id": "01a19e6f-3f1d-731c-9048-24c8ae5af679",
      "name": "My API Key",
      "scopes": [
        "campaigns:create"
      ],
      "key": "ZmNhN2RjNGYtMThmNS00NDFlLTkwYWItM2IzOTQ4NWMyYjY5OkZpWHVkMjZla19TYzNTWDNCVTJEQkJfN3dfM3prNV9p",
      "organization_id": "01a19e6f-3f1e-7d9b-b6a2-aad79d1c53bd",
      "timestamp_created": "2026-11-02T22:44:13.214Z",
      "timestamp_updated": "2026-11-02T22:44:13.214Z"
    }
  ],
  "next_starting_after": "01a19e6f-87a3-7c6d-8407-3cc0c3f0f9e3"
}

Changes

    • warning

      added the new email_marketing_events:all enum value to the /// response property for the response status

    • warning

      added the new email_marketing_events:create enum value to the /// response property for the response status

    • warning

      added the new email_marketing_events:read enum value to the /// response property for the response status

    • warning

      added the new supersearch_enrichments:all enum value to the /// response property for the response status

    • warning

      added the new supersearch_enrichments:create enum value to the /// response property for the response status

    • warning

      added the new supersearch_enrichments:delete enum value to the /// response property for the response status

    • warning

      added the new supersearch_enrichments:read enum value to the /// response property for the response status

    • warning

      added the new supersearch_enrichments:update enum value to the /// response property for the response status