API Key GET

GET 
/api_keys/:apiKeyId

Required Permissions: ApiKey Get or ApiKey Admin

Request

Path Parameters

apiKeyId integerrequired

The id of the API Key that you wish to get data from.

Responses

200

A JSON Object a particular API key's data.

application/json

Schema

Schema

api_key object
id integer
name string
description string
key uuid
permissions string
Possible values: Value must match regular expression create,edit,delete,read
used_at date-timenullable
created_at date-time
created_by_user_id integer
updated_at date-timenullable
updated_by_user_id integernullable
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email

Example (from schema)

{
  "api_key": {
    "id": 0,
    "name": "All CRUD API Key",
    "description": "An API key with all permissions",
    "key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "permissions": "string",
    "used_at": "2024-12-02T14:38:57.743Z",
    "created_at": "2024-12-02T14:38:57.743Z",
    "created_by_user_id": 0,
    "updated_at": "2024-12-02T14:38:57.743Z",
    "updated_by_user_id": 0,
    "created_by": {
      "archived": false,
      "avatar": {},
      "avatar_file_upload_url": "/cropUrl/100x100/1.png",
      "created_at": "2024-12-02T14:38:57.743Z",
      "created_by_user_id": 0,
      "department": "Marketing",
      "email": "user@example.com"
    }
  }
}

Loading...