Api tokens

Get list of API tokens for an organisation

An authenticated user retrieves the list of tokens for the specified organisation (it requires admin permissions over the organisation)

GEThttps://app.seedata.io/api/api-tokens

Query parameters

Response

200

OK

Body

application/json

metadatametadata

Pagination Metadata

itemsarray of APIToken

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/api-tokens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "metadata": {},
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "token": "text",
      "expiration": "2024-05-11T16:25:39.286Z",
      "createdByType": "text",
      "createdById": "text",
      "roleId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-05-11T16:25:39.286Z",
      "updatedAt": "2024-05-11T16:25:39.286Z"
    }
  ]
}

Get an API token for an organisation

Get an API token for the specified organisation (it requires admin permissions over the organisation)

GEThttps://app.seedata.io/api/api-tokens/{tokenId}

Path parameters

tokenId*string (uuid)

Response

200

OK

Body

application/json

idstring (uuid)

name*string

A friendly name for this token

descriptionstring

A longer description for this token

tokenstring

The API token

expirationnullable string (date-time)

The expiration date for the token

createdByTypestring

createdByIdstring

roleIdstring (uuid)

The role associated with the token

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurl

const response = await fetch('https://app.seedata.io/api/api-tokens/{tokenId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "token": "text",
  "expiration": "2024-05-11T16:25:39.286Z",
  "createdByType": "text",
  "createdById": "text",
  "roleId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-05-11T16:25:39.286Z",
  "updatedAt": "2024-05-11T16:25:39.286Z"
}