API Keys
API keys offer an alternate method of authentication to the Matatika API using a client ID and secret. Access using API key credentials is supported by the Matatika CLI and SDK, which allows a user to remain authenticated permanently.
Objects
API Key
Path | JSON Type | Format | Description |
---|---|---|---|
id |
string |
Version 4 UUID | The API key ID |
created |
string |
ISO 8601 timestamp | The instant when the API key was created |
lastModified |
string |
ISO 8601 timestamp | The instant when the API key was last modified |
name |
string |
The API key name | |
clientId |
string |
The API key client ID | |
profileId |
string |
The API key owner profile ID |
{
"id" : "5fbf3be9-6f12-47a8-ac49-91fcc3b7a241",
"created" : "2025-08-17T18:36:38.550378",
"lastModified" : "2025-08-17T18:36:38.550378",
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425)",
"clientId" : "pQj5JqjoKrqo4EwAjN8QgqWQJUdhW2bi",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
}
Requests
- View all API keys
- View an API key
- Initialise an API key
- Create an API key
- Update an API key
- Delete an API key
View all API keys
GET
/api/apikeys
Returns all API keys owned by the authenticated user profile.
Prerequisites
- The authenticated user must own a Matatika account
- The API key
{apikey-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/apikeys/' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com/api/apikeys/"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
API key collection with HAL links.
{
"_embedded" : {
"apikeys" : [ {
"id" : "ea1b190c-04e5-46b5-8fb7-84ee80923ed8",
"created" : "2025-08-17T18:36:37.333819",
"lastModified" : "2025-08-17T18:36:37.333819",
"name" : "default",
"clientId" : "j7omM7sEYIGystrLHspAGbCgh8DMypjQ",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"accessToken" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJFRkNRamczTlRRMk16QTROalpHT0RjNFFUWkJOemMyTkRGR1FUSkVOVEEyUkRkR1JrSkRPQSJ9.eyJpc3MiOiJodHRwczovL2lkZW50aXR5Lm1hdGF0aWthLmNvbS8iLCJzdWIiOiJqN29tTTdzRVlJR3lzdHJMSHNwQUdiQ2doOERNeXBqUUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9hcHAubWF0YXRpa2EuY29tL2FwaSIsImlhdCI6MTc1NTQ1NTc5OCwiZXhwIjoxNzU1NTQyMTk4LCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJhenAiOiJqN29tTTdzRVlJR3lzdHJMSHNwQUdiQ2doOERNeXBqUSJ9.5MLsmG7N_161s9LPwezZM8CdqZPiE-gB3XHKwnIHsE5dT_c6cQ8tq6jYPVcx0AdV9F-w4qmVIM9WjWkwv7BJfk-xbTomyIWSpzyYLatZzhOxzH7WYK0pfw1aFoLZqLWI4U_DAseHHbfQYHTqmprUDu5DWxB7IpcUO0rEAHp6gPrxgAuBQB-F0Ve2Ki3s8W3Q6XHmsyc_bpVAEoxeWb-Ot1MztCyCODWvsaPHuzXH0ugsnrvpVnGyBblvCpIDM90o5aNoMOwFqxLuniRm6sfKPwYC2YaQv7t5VCKz1UHtkx1n18WjZnnPHSkPo-oF6dyrZl1IB5-01KU4LcaX9dScCQ",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/ea1b190c-04e5-46b5-8fb7-84ee80923ed8"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/ea1b190c-04e5-46b5-8fb7-84ee80923ed8"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/ea1b190c-04e5-46b5-8fb7-84ee80923ed8"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
}, {
"id" : "5fbf3be9-6f12-47a8-ac49-91fcc3b7a241",
"created" : "2025-08-17T18:36:38.550378",
"lastModified" : "2025-08-17T18:36:38.550378",
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425)",
"clientId" : "pQj5JqjoKrqo4EwAjN8QgqWQJUdhW2bi",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/?page=0&size=20"
}
},
"page" : {
"size" : 20,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
View an API key
GET
/api/apikeys/{apikey-id}
Returns the API key {apikey-id}
.
Prerequisites
- The authenticated user must own a Matatika account
- The API key
{apikey-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241' -i -X GET \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("GET", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
API key with HAL links.
{
"id" : "5fbf3be9-6f12-47a8-ac49-91fcc3b7a241",
"created" : "2025-08-17T18:36:38.550378",
"lastModified" : "2025-08-17T18:36:38.550378",
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425)",
"clientId" : "pQj5JqjoKrqo4EwAjN8QgqWQJUdhW2bi",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
}
Initialise an API key
POST
/api/apikeys
Initialises a new API key.
Prerequisites
- The authenticated user must own a Matatika account
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/apikeys/' -i -X POST \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json'
Python (requests
)
import requests
url = "https://app.matatika.com/api/apikeys/"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("POST", url, headers=headers)
print(response.text.encode('utf8'))
Response
200 OK
API key with HAL links.
{
"id" : "5fbf3be9-6f12-47a8-ac49-91fcc3b7a241",
"created" : "2025-08-17T18:36:38.473588779",
"lastModified" : "2025-08-17T18:36:38.473589179",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"create apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
}
}
}
Create an API key
PUT
/api/apikeys/{apikey-id}
Creates the API key {apikey-id}
.
Prerequisites
- The authenticated user must own a Matatika account
Request
Body
API key resource.
{
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425)"
}
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425)"
}'
Python (requests
)
import requests
url = "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
data = {
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425)"
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
201 Created
API key with HAL links.
{
"id" : "5fbf3be9-6f12-47a8-ac49-91fcc3b7a241",
"created" : "2025-08-17T18:36:38.55037795",
"lastModified" : "2025-08-17T18:36:38.55037835",
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425)",
"clientId" : "pQj5JqjoKrqo4EwAjN8QgqWQJUdhW2bi",
"clientSecret" : "XGulHHZCkTQ6JCrwgzEAgxfsgZqdaQvV9ooq0SJ6vwS5K4dm6WbnT8sdhyDQpDiG",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
}
Update an API key
PUT
/api/apikeys/{apikey-id}
Updates the API key {apikey-id}
.
Prerequisites
- The authenticated user must own a Matatika account
Request
Body
API key resource.
{
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425) (updated)"
}
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241' -i -X PUT \
-H 'Accept: application/json, application/javascript, text/javascript, text/json' \
-H 'Content-Type: application/json' \
-d '{
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425) (updated)"
}'
Python (requests
)
import requests
url = "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
data = {
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425) (updated)"
}
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("PUT", url, headers=headers, data=data)
print(response.text.encode('utf8'))
Response
200 OK
API key with HAL links.
{
"id" : "5fbf3be9-6f12-47a8-ac49-91fcc3b7a241",
"created" : "2025-08-17T18:36:38.550378",
"lastModified" : "2025-08-17T18:36:39.498512754",
"name" : "SIT-generated api key (2025-08-17T19:36:38.505425) (updated)",
"clientId" : "pQj5JqjoKrqo4EwAjN8QgqWQJUdhW2bi",
"profileId" : "auth0|5eb0327cbfd7490bff55feeb",
"_links" : {
"self" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"update apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"delete apikey" : {
"href" : "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
},
"profile" : {
"href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
}
}
}
Delete an API key
DELETE
/api/apikeys/{apikey-id}
Deletes the API key {apikey-id}
.
Prerequisites
- The authenticated user must own a Matatika account
- The API key
{apikey-id}
must exist
Request
Example Snippets
cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241' -i -X DELETE \
-H 'Accept: application/json, application/javascript, text/javascript, text/json'
Python (requests
)
import requests
url = "https://app.matatika.com/api/apikeys/5fbf3be9-6f12-47a8-ac49-91fcc3b7a241"
headers = {
'Authorization': ACCESS_TOKEN
}
response = requests.request("DELETE", url, headers=headers)
print(response.text.encode('utf8'))
Response
204 No Content
No response body provided.