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" : "5714212a-f7bd-4001-89a0-c1e8fcb9430b",
  "created" : "2025-11-02T06:30:53.138279",
  "lastModified" : "2025-11-02T06:30:53.13828",
  "name" : "SIT-generated api key (2025-11-02T06:30:53.086736587)",
  "clientId" : "QiVunGnVk97YBgUbXKruJ8aZfNuXWIcQ",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "update apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "delete apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "profile" : {
      "href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
    }
  }
}

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

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" : "8bc3ad38-37a1-4558-a3f8-99fd68696782",
      "created" : "2025-11-02T06:30:52.126151",
      "lastModified" : "2025-11-02T06:30:52.126151",
      "name" : "default",
      "clientId" : "eHhl7uRvUujER2VsgFN1tYCRqkeqqtZE",
      "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
      "accessToken" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJFRkNRamczTlRRMk16QTROalpHT0RjNFFUWkJOemMyTkRGR1FUSkVOVEEyUkRkR1JrSkRPQSJ9.eyJpc3MiOiJodHRwczovL2lkZW50aXR5Lm1hdGF0aWthLmNvbS8iLCJzdWIiOiJlSGhsN3VSdlV1akVSMlZzZ0ZOMXRZQ1Jxa2VxcXRaRUBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9hcHAubWF0YXRpa2EuY29tL2FwaSIsImlhdCI6MTc2MjA2NTA1MiwiZXhwIjoxNzYyMTUxNDUyLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJhenAiOiJlSGhsN3VSdlV1akVSMlZzZ0ZOMXRZQ1Jxa2VxcXRaRSJ9.agA_I5AJN0uJtucyz80tM6I_k3ikykpBXX84F-id-tCQa06RO0bu0lDxQFPHqN7281f-v5fOfXkAcuAI_mtpvbD9VPJq1eemnlmw-pW0wxcRSPCAJirX8bmly6hw6AVFH7FWVEVz2AKIsbl6KLfBpcJuIVXNst_6J2D_jk9KqWGnyQ6O13f7QhvyJlOo8PU5Y406UElHAKneEku268a01DQF9oOgPA1cN00_v_VC9-umQbcz-sOaIKVtvPLKfDzX6DWLOvlQ0kPXF-GPEyvdrBS7NZ0jSr-glXym7PEkODhyxoW2LBKog4ZhEIukWJmzYiw8C7Ar9yhQdAIgdU-HAw",
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/apikeys/8bc3ad38-37a1-4558-a3f8-99fd68696782"
        },
        "update apikey" : {
          "href" : "https://app.matatika.com/api/apikeys/8bc3ad38-37a1-4558-a3f8-99fd68696782"
        },
        "delete apikey" : {
          "href" : "https://app.matatika.com/api/apikeys/8bc3ad38-37a1-4558-a3f8-99fd68696782"
        },
        "profile" : {
          "href" : "https://app.matatika.com/api/profiles/auth0%7C5eb0327cbfd7490bff55feeb"
        }
      }
    }, {
      "id" : "5714212a-f7bd-4001-89a0-c1e8fcb9430b",
      "created" : "2025-11-02T06:30:53.138279",
      "lastModified" : "2025-11-02T06:30:53.13828",
      "name" : "SIT-generated api key (2025-11-02T06:30:53.086736587)",
      "clientId" : "QiVunGnVk97YBgUbXKruJ8aZfNuXWIcQ",
      "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
      "_links" : {
        "self" : {
          "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
        },
        "update apikey" : {
          "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
        },
        "delete apikey" : {
          "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
        },
        "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/5714212a-f7bd-4001-89a0-c1e8fcb9430b' -i -X GET

Python (requests)

import requests

url = "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"

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" : "5714212a-f7bd-4001-89a0-c1e8fcb9430b",
  "created" : "2025-11-02T06:30:53.138279",
  "lastModified" : "2025-11-02T06:30:53.13828",
  "name" : "SIT-generated api key (2025-11-02T06:30:53.086736587)",
  "clientId" : "QiVunGnVk97YBgUbXKruJ8aZfNuXWIcQ",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "update apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "delete apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "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 '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" : "5714212a-f7bd-4001-89a0-c1e8fcb9430b",
  "created" : "2025-11-02T06:30:53.061673056",
  "lastModified" : "2025-11-02T06:30:53.061673556",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "create apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    }
  }
}

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-11-02T06:30:53.086736587)"
}

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated api key (2025-11-02T06:30:53.086736587)"
}'

Python (requests)

import requests

url = "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"

data = {
  "name" : "SIT-generated api key (2025-11-02T06:30:53.086736587)"
}
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" : "5714212a-f7bd-4001-89a0-c1e8fcb9430b",
  "created" : "2025-11-02T06:30:53.138279035",
  "lastModified" : "2025-11-02T06:30:53.138279635",
  "name" : "SIT-generated api key (2025-11-02T06:30:53.086736587)",
  "clientId" : "QiVunGnVk97YBgUbXKruJ8aZfNuXWIcQ",
  "clientSecret" : "S-fWrxcLqE3aTFXCpaDlaJWAQOch_CUb4zjk5nsSfhQNFTYgXBQYI7A2Wd5ye_rP",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "update apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "delete apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "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-11-02T06:30:53.086736587) (updated)"
}

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated api key (2025-11-02T06:30:53.086736587) (updated)"
}'

Python (requests)

import requests

url = "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"

data = {
  "name" : "SIT-generated api key (2025-11-02T06:30:53.086736587) (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" : "5714212a-f7bd-4001-89a0-c1e8fcb9430b",
  "created" : "2025-11-02T06:30:53.138279",
  "lastModified" : "2025-11-02T06:30:53.930962125",
  "name" : "SIT-generated api key (2025-11-02T06:30:53.086736587) (updated)",
  "clientId" : "QiVunGnVk97YBgUbXKruJ8aZfNuXWIcQ",
  "profileId" : "auth0|5eb0327cbfd7490bff55feeb",
  "_links" : {
    "self" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "update apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "delete apikey" : {
      "href" : "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"
    },
    "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/5714212a-f7bd-4001-89a0-c1e8fcb9430b' -i -X DELETE

Python (requests)

import requests

url = "https://app.matatika.com/api/apikeys/5714212a-f7bd-4001-89a0-c1e8fcb9430b"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.