Skip to main content

GET Api Key‚Äč

Required Permissions: ApiKey Get or ApiKey Admin

Path Parameters
    apiKeyId integer required

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


A JSON Object a particular API key's data.

    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-time nullable
    created_at date-time
    created_by_user_id integer
    updated_at date-time nullable
    updated_by_user_id integer nullable
    created_by object
    archived boolean
    avatar object nullable
    avatar_file_upload_url string
    created_at date-time
    created_by_user_id integer

    Possible values: >= 1

    department string
    email email