DocumentationAPI Reference
API keys

List API keys

Lists credential metadata. Secret key values are never returned after creation. Requires the keys:read scope when called with a scoped key.

GET/v1/keys

Lists credential metadata. Secret key values are never returned after creation. Requires the keys:read scope when called with a scoped key.

Authorization

AuthorizationBearer <token>

Pass Authorization: Bearer mapleads_xxx.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/keys"
{  "keys": [    {      "id": "string",      "name": "string",      "prefix": "string",      "start": "string",      "enabled": true,      "scopes": [        "string"      ],      "createdAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z",      "lastRequest": "2019-08-24T14:15:22Z"    }  ]}

Get usage and credits GET

Returns the authenticated account's access state, remaining credits, allowance, reset date, and effective API-key rate limit. Requires the `usage:read` scope when called with a scoped key.

Create an API key POST

Creates a scoped credential. The full `mapleads_` key is returned once and must be stored securely. Requires the `keys:write` scope when called with a scoped key.