{
  "opencollection": "1.0.0",
  "info": {
    "name": "ALTR Classification Engine Collections API",
    "version": "1.1.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Collections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List collections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{orgID}.classification.live.altr.com/v1/collections",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of items to return (default: 100, max: 100)"
              },
              {
                "name": "contiguous_id",
                "value": "",
                "type": "query",
                "description": "Continuation token for pagination (returned in previous response)"
              },
              {
                "name": "sort_order",
                "value": "",
                "type": "query",
                "description": "Sort order: 'asc' (ascending) or 'desc' (descending). Sorts by collection name."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieves a list of collections with optional pagination and sorting. Collections are groups of classifiers; classifiers carry GDLP conditions in their compound rulesets when needed."
        },
        {
          "info": {
            "name": "Create collection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{orgID}.classification.live.altr.com/v1/collections",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Creates a new collection as a group for organizing classifiers. Collection names starting with 'ALTR' are reserved."
        },
        {
          "info": {
            "name": "Get collection by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{orgID}.classification.live.altr.com/v1/collections/:collection_name",
            "params": [
              {
                "name": "collection_name",
                "value": "pii_data",
                "type": "path",
                "description": "Collection name (URL-encoded if contains special characters)"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieves a specific collection by its name, including its description and classifier count."
        },
        {
          "info": {
            "name": "Update collection",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{orgID}.classification.live.altr.com/v1/collections/:collection_name",
            "params": [
              {
                "name": "collection_name",
                "value": "pii_data",
                "type": "path",
                "description": "Collection name (URL-encoded if contains special characters)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Updates a collection's properties. Only provided fields will be updated. ALTR managed collections cannot be updated."
        },
        {
          "info": {
            "name": "Delete collection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{orgID}.classification.live.altr.com/v1/collections/:collection_name",
            "params": [
              {
                "name": "collection_name",
                "value": "pii_data",
                "type": "path",
                "description": "Collection name (URL-encoded if contains special characters)"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Soft deletes a collection by its name. This will remove all classifier associations and mark it as deleted. ALTR managed collections cannot be deleted."
        },
        {
          "info": {
            "name": "Get all classifiers in a collection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{orgID}.classification.live.altr.com/v1/collections/:collection_name/classifiers",
            "params": [
              {
                "name": "collection_name",
                "value": "pii_data",
                "type": "path",
                "description": "Collection Name (URL-encoded if contains special characters)"
              },
              {
                "name": "limit",
                "value": "50",
                "type": "query",
                "description": "Maximum number of items to return (1-100)"
              },
              {
                "name": "contiguous_id",
                "value": "eyJQSyI6eyJTIjoiT1JHSUQjMTIzNDU2Nzg5MCJ9fQ",
                "type": "query",
                "description": "Pagination token from previous response"
              },
              {
                "name": "prefix",
                "value": "email",
                "type": "query",
                "description": "Prefix to filter classifier names (e.g., 'email' matches 'email_address', 'email_domain')"
              },
              {
                "name": "sort_order",
                "value": "asc",
                "type": "query",
                "description": "Sort order: 'asc' (ascending) or 'desc' (descending). Sorts by classifier name."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieves all classifiers that belong to a specific collection with optional pagination, filtering, and sorting"
        },
        {
          "info": {
            "name": "Append classifiers to collection",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{orgID}.classification.live.altr.com/v1/collections/:collection_name/classifiers/append",
            "params": [
              {
                "name": "collection_name",
                "value": "pii_data",
                "type": "path",
                "description": "Collection name (URL-encoded if contains special characters)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Adds multiple classifiers to an existing collection in a single atomic transaction. All classifiers must exist and not already be in this collection. ALTR managed collections cannot have classifiers appended."
        },
        {
          "info": {
            "name": "Remove classifiers from collection",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{orgID}.classification.live.altr.com/v1/collections/:collection_name/classifiers/remove",
            "params": [
              {
                "name": "collection_name",
                "value": "pii_data",
                "type": "path",
                "description": "Collection name (URL-encoded if contains special characters)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Removes multiple classifiers from an existing collection in a single atomic transaction. All classifiers must be currently in this collection. ALTR managed collections cannot have classifiers removed."
        }
      ]
    }
  ],
  "bundled": true
}