Skip to main content
GET
/
api
/
v2
/
api-keys
List API keys
curl --request GET \
  --url https://demo.api.loopcrypto.xyz/api/v2/api-keys \
  --header 'api-key: <api-key>' \
  --header 'entity-id: <api-key>'
{
  "totalResults": 100,
  "apiKeys": [
    {
      "dateCreated": 1716211200,
      "name": "Loop API key",
      "id": "1234567890abcdef",
      "permissions": [
        "CreateEntity",
        "GetPaymentTypes"
      ]
    }
  ]
}

Authorizations

​
api-key
string
header
required
​
entity-id
string
header
required

Query Parameters

​
apiKeyId
string

Optional ID to filter API keys. If provided, returns only API keys matching this ID. This is not the API key value, but the unique identifier for the API key that can be obtained using the list API keys endpoint.

​
apiKeyName
string

Optional name to filter API keys. If provided, returns only API keys matching this name.

​
page
number

Optional pagination parameter to specify the page number of the results to return. Default is 1 which is the first page.

​
limit
number

Optional pagination parameter to specify the number of results per page. Default is 25, maximum is 100.

​
sortBy
string

Optional sorting parameter to specify the field to sort the results by. Valid options are "id", "name", and "dateCreated". Default is "dateCreated".

​
sortDir
string

Optional sorting parameter to specify the direction to sort the results by. Valid options are "asc" and "desc". Default is "desc".

Response

Ok

​
totalResults
number
required

The total count of API keys matching the search criteria, regardless of page size or number.

Example:

100

​
apiKeys
object[]
required

The list of API keys associated with the entity

⌘I