Accounts

Get Classifications

Returns the paginated list of classifications configured for the authenticated account. Deleted classifications are excluded from results.

get/v1/accounts/me/classifications

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/accounts/me/classifications
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: account.info)

Response

OK. Returns a list of classifications for the account.

idstring uuid required

Unique ID of the classification.

labelstring required

Display name of the classification.

priorityinteger required

Priority of the classification.

descriptionstring nullable

Optional description of the classification.

guidelineUrlstring nullable

Optional URL linking to classification guidelines.

Example response

[
  {
    "id": "b7db4f07-5225-4a0c-8313-0fe199eec844",
    "label": "private",
    "priority": 1,
    "description": "For documents with sensitive customer data",
    "guidelineUrl": "https://lucid.app/lucidspark/classification-guidelines"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.