Documents API namespace root

Namespace root with no resource of its own — it returns 404. Documents are accessed per parent entity, e.g. /api/v1/tickets/{id}/documents.

Response body

Success response 401 · schema ErrorResponse

errorobjectRequired

codestringRequired

messagestringRequired

detailsany

Response codes

401

API key missing/invalid.

404

Always — this root has no resource; call a sub-resource path.

GET /api/v1/documents

cURL

curl -X GET "https://algapsa.com/api/v1/documents" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/documents", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/documents");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

401 OK·application/json

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}