Manage your Infobip account details, such as individual users and api keys. — 13 operation path(s) and 0 webhook(s) in Infobip's published OpenAPI.
{
"openapi":"3.1.0",
"info":{
"title":"Infobip OpenAPI Specification",
"description":"OpenAPI Specification that contains all public endpoints and webhooks.",
"contact":{
"name":"Infobip support",
"email":"support@infobip.com"
},
"version":"3.210.0",
"x-generatedAt":"2026-07-23T15:24:04.338668974Z"
},
"tags":[
{
"name":"platform",
"description":"Modular tools to scale and automate your business.\n",
"x-type":"category",
"x-displayName":"Platform"
},
{
"name":"account-management",
"description":"Manage your Infobip account details, such as individual users and api keys.",
"x-type":"product",
"x-displayName":"Account management"
},
{
"name":"balance",
"description":"",
"x-type":"section",
"x-displayName":"Balance"
},
{
"name":"accounts",
"description":"",
"x-type":"section",
"x-displayName":"Accounts"
},
{
"name":"api-keys",
"description":"",
"x-type":"section",
"x-displayName":"API keys"
},
{
"name":"login",
"description":"",
"x-type":"section",
"x-displayName":"Login"
},
{
"name":"oauth",
"description":"",
"x-type":"section",
"x-displayName":"OAuth"
},
{
"name":"audit-logs",
"description":"",
"x-type":"section",
"x-displayName":"Audit logs"
}
],
"paths":{
"/account/1/balance":{
"get":{
"tags":[
"platform",
"account-management",
"balance"
],
"summary":"Get current account balance",
"description":"Returns the current account balance displayed in the currency configured for the account.",
"operationId":"get-account-balance",
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.AccountBalance"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
]
}
},
"/account/1/free-messages":{
"get":{
"tags":[
"platform",
"account-management",
"balance"
],
"summary":"Get remaining free messages",
"description":"Returns the remaining number of free messages available for the account.",
"operationId":"get-free-messages-count",
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.FreeMessagesResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
]
}
},
"/account/1/total-balance":{
"get":{
"tags":[
"platform",
"account-management",
"balance"
],
"summary":"Get account balance with free messages",
"description":"Returns the current account balance, monthly balance, monthly and total credit limit, currency details, and the remaining count of free messages per service type.",
"operationId":"get-total-account-balance",
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.BalanceInfoResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
]
}
},
"/settings/1/accounts":{
"get":{
"tags":[
"platform",
"account-management",
"accounts"
],
"summary":"Get all sub accounts with filter",
"description":"This method allows you to get all sub accounts with custom filter",
"operationId":"get-all-accounts",
"parameters":[
{
"name":"name",
"in":"query",
"description":"Account name",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"limit",
"in":"query",
"description":"Number of account in response",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":40
}
},
{
"name":"enabled",
"in":"query",
"description":"Indicates whether the account is enabled",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.AccountsResponse"
},
"examples":{
"default_accounts_response":{
"summary":"Get all subaccounts by filter",
"value":{
"accounts":[
{
"key":"accountKey",
"ownerKey":"ownerKey",
"name":"Account Name",
"enabled":true
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
]
}
},
"/settings/1/accounts/{accountKey}":{
"put":{
"tags":[
"platform",
"account-management",
"accounts"
],
"summary":"Update account",
"description":"This method allows you to update account. You can only update sub accounts",
"operationId":"update-account",
"parameters":[
{
"name":"accountKey",
"in":"path",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateAccountRequest"
},
"examples":{
"UpdateAccountRequest":{
"summary":"UpdateAccountRequest",
"description":"Example of UpdateAccountRequest",
"value":{
"name":"New Account Name",
"enabled":true
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Account"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
]
}
},
"/settings/1/accounts/{accountKey}/api-keys":{
"get":{
"tags":[
"platform",
"account-management",
"api-keys"
],
"summary":"Get API keys by filter",
"description":"This method allows you to get API keys of some account by filter forwarded",
"operationId":"get-api-keys-by-filter-deprecated",
"parameters":[
{
"name":"accountKey",
"in":"path",
"description":"Key of the main account the API key belongs to. Use the special `_` value to reference the account of the user making the API request or a standard account key such as `8F0792F86035A9F4290821F1EE6BC06A` to reference an account explicitly.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"name",
"in":"query",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"limit",
"in":"query",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":40
}
},
{
"name":"enabled",
"in":"query",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
}
},
{
"name":"publicApiKey",
"in":"query",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeys"
},
"examples":{
"default_api_keys_response":{
"summary":"Default API keys response",
"value":{
"apiKeys":[
{
"key":"573711510E1C002E29679B12C7CB48AE",
"publicApiKey":"<secrete api key>",
"accountKey":"8F0792F86035A9F4290821F1EE6BC06A",
"name":"ApiKey name",
"allowedIPs":[
"127.0.0.1"
],
"validFrom":"2026-07-09T06:04:54.988+00:00",
"validTo":"2026-07-09T06:04:54.988+00:00",
"enabled":true,
"permissions":[
"ALL"
]
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"$ref":"#/components/responses/ApiError404"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
]
},
"post":{
"tags":[
"platform",
"account-management",
"api-keys"
],
"summary":"Create API key",
"description":"This method allows you to create an API key.",
"operationId":"create-api-key-deprecated",
"parameters":[
{
"name":"accountKey",
"in":"path",
"description":"Key of the main account the API key belongs to. Use the special `_` value to reference the account of the user making the API request or a standard account key such as `8F0792F86035A9F4290821F1EE6BC06A` to reference an account explicitly.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequestV1"
},
"examples":{
"default_create_api_key_v1_request":{
"summary":"Create API key v1 request",
"value":{
"name":"name",
"allowedIPs":[
"127.0.0.1"
],
"validTo":"2026-08-08T06:04:54.988+0000",
"validFrom":"2026-08-08T06:04:54.988+0000",
"enabled":true,
"permissions":[
"ALL"
]
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Created",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiError400"
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"$ref":"#/components/responses/ApiError404"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":40,
"numberOfTimeUnits":0,
"timeUnit":"d"
}
]
}
},
"/settings/1/accounts/{accountKey}/api-keys/{key}":{
"get":{
"tags":[
"platform",
"account-management",
"api-keys"
],
"summary":"Get API key",
"description":"Key of the main account the API key belongs to. Use the special _ value to reference the account of the user making the API request or a standard account key such as 8F0792F86035A9F4290821F1EE6BC06A to reference an account explicitly",
"operationId":"get-api-key-deprecated",
"parameters":[
{
"name":"accountKey",
"in":"path",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"key",
"in":"path",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"$ref":"#/components/responses/ApiError404"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
]
},
"put":{
"tags":[
"platform",
"account-management",
"api-keys"
],
"summary":"Update API key",
"description":"Key of the main account the API key belongs to. Use the special _ value to reference the account of the user making the API request or a standard account key such as 8F0792F86035A9F4290821F1EE6BC06A to reference an account explicitly.",
"operationId":"update-api-key-deprecated",
"parameters":[
{
"name":"accountKey",
"in":"path",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"key",
"in":"path",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequestV1"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiError400"
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"$ref":"#/components/responses/ApiError404"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
]
}
},
"/settings/2/api-keys":{
"get":{
"tags":[
"platform",
"account-management",
"api-keys"
],
"summary":"Get API keys by filter",
"description":"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.",
"operationId":"get-api-keys-by-filter",
"parameters":[
{
"name":"accountId",
"in":"query",
"description":"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.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"name",
"in":"query",
"description":"Name of this API Key.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"page",
"in":"query",
"description":"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.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32"
}
},
{
"name":"size",
"in":"query",
"description":"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.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32"
}
},
{
"name":"orderBy",
"in":"query",
"description":"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.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"orderDirection",
"in":"query",
"description":"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.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"enabled",
"in":"query",
"description":"Is API key enabled.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
}
},
{
"name":"apiKeySecret",
"in":"query",
"description":"Authentication key. Use this value for authentication on API. Keep this in secure storage and don't share it.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.GetApiKeysResponse"
},
"examples":{
"default_get_api_key_response":{
"summary":"Get API keys response",
"value":{
"apiKeys":[
{
"id":"573711510E1C002E29679B12C7CB48AE",
"apiKeySecret":"<secret api key>",
"accountId":"8F0792F86035A9F4290821F1EE6BC06A",
"name":"First ApiKey on my account",
"allowedIPs":[
"127.0.0.1",
"168.158.10.122"
],
"validFrom":"2023-09-01T10:00:00",
"validTo":"2024-09-01T10:00:00",
"enabled":true,
"permissions":[
"PUBLIC_API"
],
"scopeGuids":[
"2fa:manage",
"account-management:manage"
]
}
],
"paging":{
"page":0,
"pageSize":10,
"orderDirection":"asc",
"totalCount":1,
"totalPages":1
}
}
},
"default_get_api_key_cpaasx_response":{
"summary":"Get CPaasX API keys response",
"value":{
"apiKeys":[
{
"id":"573711510E1C002E29679B12C7CB48AE",
"apiKeySecret":"<secret api key>",
"accountId":"8F0792F86035A9F4290821F1EE6BC06A",
"name":"First ApiKey on my account",
"allowedIPs":[
"127.0.0.1",
"168.158.10.122"
],
"validFrom":"2023-09-01T10:00:00",
"validTo":"2024-09-01T10:00:00",
"enabled":true,
"platform":[
{
"key":"301493481C01BC01921AB1072S1A1AA1",
"applicationId":"test-application",
"entityId":"test-entity"
},
{
"key":"12948B109237B1DB10237EB10E1B01B0",
"applicationId":"default"
},
{
"key":"C365C6D6575A757D576D5987968D574D",
"applicationId":"marketing-automation-application",
"entityId":"promotional-traffic-entity",
"action":"FILL"
}
]
}
],
"paging":{
"page":0,
"pageSize":10,
"orderDirection":"asc",
"totalCount":1,
"totalPages":1
}
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"platform",
"account-management",
"api-keys"
],
"summary":"Create API key",
"description":"This method allows you to create an API key. Only users with certain roles can create api keys; for example, Account Manager and Integrations Manager roles.",
"operationId":"create-api-key",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequest"
},
"examples":{
"default_create_api_key_request":{
"summary":"Create API key request",
"value":{
"accountId":"8F0792F86035A9F4290821F1EE6BC06A",
"name":"First ApiKey on my account",
"allowedIPs":[
"127.0.0.1",
"168.158.10.122"
],
"validFrom":"2023-09-01T10:00:00",
"validTo":"2024-09-01T10:00:00",
"permissions":[
"PUBLIC_API"
],
"scopeGuids":[
"2fa:manage",
"account-management:manage"
]
}
},
"default_create_cpaasx_api_key_request":{
"summary":"Create CPaaSX API key request",
"value":{
"accountId":"8F0792F86035A9F4290821F1EE6BC06A",
"name":"First ApiKey on my account",
"allowedIPs":[
"127.0.0.1",
"168.158.10.122"
],
"validFrom":"2023-09-01T10:00:00",
"validTo":"2024-09-01T10:00:00",
"platform":[
{
"applicationId":"test-application",
"entityId":"test-entity"
},
{
"applicationId":"default"
},
{
"applicationId":"marketing-automation-application",
"entityId":"promotional-traffic-entity",
"action":"FILL"
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey"
},
"examples":{
"default_create_api_key_response":{
"summary":"Create API key response",
"value":{
"id":"573711510E1C002E29679B12C7CB48AE",
"apiKeySecret":"<secret api key>",
"accountId":"8F0792F86035A9F4290821F1EE6BC06A",
"name":"First ApiKey on my account",
"allowedIPs":[
"127.0.0.1",
"168.158.10.122"
],
"validFrom":"2024-09-01T10:00:00",
"validTo":"2023-09-01T10:00:00",
"enabled":true,
"permissions":[
"PUBLIC_API"
],
"scopeGuids":[
"2fa:manage",
"account-management:manage"
]
}
},
"default_create_cpaasx_api_key_response":{
"summary":"Create CPaaSX API key response",
"value":{
"id":"573711510E1C002E29679B12C7CB48AE",
"apiKeySecret":"<secret api key>",
"accountId":"8F0792F86035A9F4290821F1EE6BC06A",
"name":"First ApiKey on my account",
"allowedIPs":[
"127.0.0.1",
"168.158.10.122"
],
"validFrom":"2024-09-01T10:00:00",
"validTo":"2023-09-01T10:00:00",
"enabled":true,
"platform":[
{
"key":"301493481C01BC01921AB1072S1A1AA1",
"applicationId":"test-application",
"entityId":"test-entity"
},
{
"key":"12948B109237B1DB10237EB10E1B01B0",
"applicationId":"default"
},
{
"key":"C365C6D6575A757D576D5987968D574D",
"applicationId":"marketing-automation-application",
"entityId":"promotional-traffic-entity",
"action":"FILL"
}
]
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"account-management:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":40,
"numberOfTimeUnits":0,
"timeUnit":"d"
}
]
}
},
"/settings/2/api-keys/{apiKeyId}":{
"get":{
"tags":[
"platform",
"account-management",
"api-keys"
],
"summary":"Get API key",
"description":"This method allows you to fetch an API key. Only users with certain roles can fetch api key; for example, Account Manager and Integrations Manager roles.",
"operationId":"get-api-key",
"parameters":[
{
"name":"apiKeyId",
"in":"path",
"description":"Unique identifier of api key to be returned.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"*/*":{
"schema":{
"$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey"
},
"examples":{
"default_get_api_key_response":{
"summary":"Get API key response",
"value":{
"id":"573711510E1C002E29679B12C7CB48AE",
"apiKeySecret":"<secret api key>",
"accountId":"8F0792F86035A9F4290821F1EE6BC06A",
"name":"First ApiKey on my account",
"allowedIPs":[
"127.0.0.1",
"168.158.10.122"
],
"validFrom":"2024-09-01T10:00:00",
"validTo":"2023-09-01T10:00:00",
"enabled":true,
"permissions":[
"PUBLIC_API"
],
"scopeGuids":[
"2fa:manage",
"account-management:manage"
]
}
},
"default_get_cpaasx_api_key_response":{
"summary":"Get CPaaSX API key response",
"value":{
"id":"573711510E1C002E29679B12C7CB48AE",
"apiKeySecret":"<secret api key>",
"accountId":"8F0792F86035A9F4290821F1EE6BC06A",
"name":"First ApiKey on my account",
"allowedIPs":[
"127.0.0.1",
"168.158.10.122"
],
"validFrom":"2024-09-01T10:00:00",
"validTo":"2023-09-01T10:00:00",
"enabled":true,
"platform":[
{
"key":"301493481C01BC01921AB1072S1A1AA1",
"applicationId":"test-application",
"entityId":"test-entity"
},
{
"key":"12948B109237B1DB10237EB10E1B01B0",
"applicationId":"default"
},
{
"key":"C365C6D6575A757D576D5987968D574D",
"applicationId":"marketing-automation-application",
"entityId":"promotional-traffic-entity",
"action":"FILL"
}
]
}
}
}
}
}
},
"400":{
"descripti
# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/openapi/infobip-account-management-openapi.json