Skip to main content

GraphQL API Documentation

This document provides comprehensive documentation for the HuskyCare GraphQL API.

Overview​

The HuskyCare API uses GraphQL, which allows clients to request exactly the data they need. This documentation provides an interactive explorer for the GraphQL schema, allowing you to browse available queries, mutations, types, and more.

tip

For a comprehensive introduction to GraphQL concepts, visit the official GraphQL documentation.

API Schema​

The GraphQL schema defines the capabilities of the API. It specifies what queries, mutations, and subscriptions are available, as well as the types of data that can be retrieved.

note

The schema is automatically fetched from our development environment at https://dev.huskycare.de/api/graphql/schema.

tip

To learn more about GraphQL schemas and type systems, refer to the official GraphQL schema documentation.

Interactive Schema Explorer​

Below you'll find an interactive explorer for our GraphQL schema. You can use this to:

  • Browse all available queries and mutations
  • Explore the type system
  • Understand the relationships between different entities
  • See what fields are available on each type
  • View required arguments for queries and mutations

This explorer is similar to tools like GraphiQL and GraphQL Playground, which are recommended in the official GraphQL tools documentation.

tip

Explore the huskycare API interactively with Voyager

Using the API​

For information on how to authenticate and make requests to the API, please refer to the Authentication and API Requests documentation.

Best Practices​

When working with our GraphQL API, consider these best practices:

  1. Request only what you need: GraphQL allows you to specify exactly which fields you want, reducing payload size
  2. Use meaningful operation names: This helps with debugging and monitoring
  3. Handle errors gracefully: Always check for errors in the response
  4. Use variables for dynamic values: This helps prevent injection attacks
  5. Explore the schema: Use this documentation to understand what's available before building your queries
tip

For more detailed best practices, see the official GraphQL best practices guide and GraphQL query optimization techniques.

Example Queries​

Here are some example queries to help you get started. For more examples and query syntax details, refer to the official GraphQL queries documentation:

# Example query to get active tours
query GetActiveTours {
    activeTours(filter: {
        date: "2023-06-01",
        residentialParkId: "1"
    }) {
        id
        name
        status
        workItems {
            id
            estimatedStart
            estimatedEnd
        }
    }
}

# Example mutation to create a client
mutation CreateClient {
    createClient(input: {
        residentialParkId: "1",
        self: {
            firstName: "John"
            lastName: "Doe"
            email: "john.doe@example.com"
        }
    }) {
        id
        self {
            firstName
            lastName
        }
    }
}

Further Reading​

To deepen your understanding of GraphQL, here are some valuable resources from the official GraphQL documentation:

Need Help?​

If you need assistance with the API or have questions about specific functionality, please contact our developer support team.