Overview

The API index and the machine-readable OpenAPI specification. Neither needs a key.

2 endpoints

GET/api/v1

API index

Lists the API version, the modules and every endpoint path. No key needed.

No key needed

This endpoint takes no parameters beyond the URL itself.

Example response

json

{
  "product": "Signed",
  "api_version": "1.0.0",
  "base_path": "/api/v1",
  "documentation": "https://usesigned.co.uk/docs/api",
  "modules": [
    {
      "slug": "organisation",
      "title": "Organisation",
      "endpoints": 5
    }
  ]
}

Copy and paste

curl -X GET "https://api.usesigned.co.uk/api/v1" \
  -H "X-API-Key: $SIGNED_API_KEY"

GET/api/v1/openapi.json

OpenAPI specification

The full OpenAPI 3.1 document for this API. No key needed. Import it into Postman, Insomnia or any generator.

No key needed

This endpoint takes no parameters beyond the URL itself.

Example response

json

{
  "openapi": "3.1.0",
  "info": {
    "title": "Signed API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://signed.ci:3005"
    }
  ],
  "paths": {
    "/api/v1/users": {
      "get": {
        "summary": "List people"
      }
    }
  }
}

Copy and paste

curl -X GET "https://api.usesigned.co.uk/api/v1/openapi.json" \
  -H "X-API-Key: $SIGNED_API_KEY"