platform
account-management
api-keys

Get API keys by filter

This method allows you to fetch an API keys by filter. Only users with certain roles can fetch api keys; for example, Account Manager and Integrations Manager roles.

get/settings/2/api-keys

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or HTTP basic

Query parameters

accountIdstring

Unique identifier for account this API keys belongs to. AccountId is optional and if not provided it will default to the account making the request.

namestring

Name of this API Key.

pageinteger

Specify the API key response page you want to fetch, starting with 0. If not set, the response will contain first page. The highest allowed page value is 100.

sizeinteger

The number of API keys in one response page. If not set, the response will be limited to 100 API keys, which is also the highest allowed size.

orderBystring

The ordering parameter of API keys in the response page. If not set, the API keys in the response will be ordered by API key id.

orderDirectionstring

The order direction of API keys in the response page. If not set, the API keys in the response will be in the ascending order.

enabledboolean

Is API key enabled.

apiKeySecretstring

Authentication key. Use this value for authentication on API. Keep this in secure storage and don't share it.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.