Skip to main content
GET
/
v1
/
purposes
List purposes
curl --request GET \
  --url https://gateway.inviolet.ai/v1/purposes \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "label": "customer_support_lookup",
      "intent_class": "reporting",
      "id": "<string>",
      "display_name": "Customer Support Lookup",
      "description": "<string>",
      "status": "draft",
      "approval_required": true,
      "ttl_minutes": 123,
      "data_elements": [
        {
          "data_source_id": "<string>",
          "path": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key minted at /settings/api-keys. Three scopes: read_only, policy_write, admin.

Response

200 - application/json

Purposes for the authenticated org.

data
object[]