api
api_keys

Changed on

Get an API Key

get/api/keys/{id}

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/keys/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The ID of the API key.

Response

OK

_idstring required

The ID of the API key.

activeboolean

Whether the API key can be used to authenticate against the API.

namestring required

An internal name to identify the API key.

sellerIdstring

The ID of the seller that owns the API key.

orgIdstring

The ID of the organisation that owns the API key.

createdAtstring date-time required

An ISO Timestamp indicating when the API Key was created.

updatedAtstring date-time required

An ISO Timestamp indicating when the API Key was last updated.

expiresAtstring date-time nullable

Optional ISO instant after which the key no longer authenticates; omit or null for no automatic expiry.

versioninteger

The version of the API key.

fullSellerAccessboolean

Seller keys only: when true, grants full seller access (seller-admin equivalent).

permissionsstring[]

Explicit permissions

Changes

  • d2b32b7098eeRevision changes
    • warning

      added the new seatMaps:create enum value to the / response property for the response status

    • warning

      added the new seatMaps:export enum value to the / response property for the response status

    • warning

      added the new seatMaps:list enum value to the / response property for the response status

    • warning

      added the new seatMaps:update enum value to the / response property for the response status

  • 0c9cb42c536aRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status