AllMatters

Retrieves a list of all matters in the system without paging. A matter has a client, matter details, and associated phases.

Query Structure

Query Name: AllMatters

Return Type: [Matter!]! - A non-null array of non-null Matter objects

Example Usage

cURL


curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
    "query": "query { AllMatters { Id Number Name Client { Id Number Name } Phases { Id Number Name } } }"
  }' \
  https://sandbox.drivepractice.com/api/v1/graphql

C#


using System;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
class Program
{
    static async Task Main(string[] args)
    {
        var url = "https://sandbox.drivepractice.com/api/v1/graphql";
        var token = "YOUR_ACCESS_TOKEN";
 
        var query = @"
        query GetAllMatters {
          AllMatters {
            Id
            Number
            Name
            Client {
              Id
              Number
              Name
            }
            Phases {
              Id
              Number
              Name
            }
          }
        }";
 
        using var httpClient = new HttpClient();
        httpClient.DefaultRequestHeaders.Authorization =
            new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", token);
 
        var payload = new
        {
            query = query
        };
 
        var content = new StringContent(JsonConvert.SerializeObject(payload), System.Text.Encoding.UTF8, "application/json");
        var response = await httpClient.PostAsync(url, content);
        var responseString = await response.Content.ReadAsStringAsync();
 
        dynamic result = JsonConvert.DeserializeObject(responseString);
        if (result.errors != null)
        {
            Console.WriteLine("Error: " + result.errors[0].message);
        }
        else
        {
            Console.WriteLine("Matters retrieved successfully");
            Console.WriteLine("Number of matters: " + result.data.AllMatters.Count);
        }
    }
}

VB.NET


Imports System.Net.Http
Imports Newtonsoft.Json
 
Module Module1
    Sub Main()
        Dim url As String = "https://sandbox.drivepractice.com/api/v1/graphql"
        Dim token As String = "YOUR_ACCESS_TOKEN"
 
        Dim query As String = "
        query GetAllMatters {
          AllMatters {
            Id
            Number
            Name
            Client {
              Id
              Number
              Name
            }
            Phases {
              Id
              Number
              Name
            }
          }
        }"
 
        Dim httpClient As New HttpClient()
        httpClient.DefaultRequestHeaders.Authorization = New Http.Headers.AuthenticationHeaderValue("Bearer", token)
 
        Dim payload As New With {
            .query = query
        }
 
        Dim content As New StringContent(JsonConvert.SerializeObject(payload), System.Text.Encoding.UTF8, "application/json")
        Dim response As HttpResponseMessage = httpClient.PostAsync(url, content).Result
        Dim responseString As String = response.Content.ReadAsStringAsync().Result
 
        Dim result As Object = JsonConvert.DeserializeObject(Of Object)(responseString)
        If TypeOf result Is Dictionary(Of String, Object) Then
            Dim dict As Dictionary(Of String, Object) = DirectCast(result, Dictionary(Of String, Object))
            If dict.ContainsKey("errors") Then
                Console.WriteLine("Error: " + DirectCast(dict("errors"), List(Of Object))(0).ToString())
            ElseIf dict.ContainsKey("data") Then
                Console.WriteLine("Matters retrieved successfully")
                Dim data As Dictionary(Of String, Object) = DirectCast(dict("data"), Dictionary(Of String, Object))
                Dim matters As List(Of Object) = DirectCast(data("AllMatters"), List(Of Object))
                Console.WriteLine("Number of matters: " + matters.Count.ToString())
            End If
        End If
    End Sub
End Module

JavaScript


import { request } from 'graphql-request';
 
const query = `
  query GetAllMatters {
    AllMatters {
      Id
      Number
      Name
      Client {
        Id
        Number
        Name
      }
      Phases {
        Id
        Number
        Name
      }
    }
  }
`;
 
const data = await request(
  'https://sandbox.drivepractice.com/api/v1/graphql',
  query,
  {},
  {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  }
);
 
console.log(data);

Python


import requests
import json
 
url = 'https://sandbox.drivepractice.com/api/v1/graphql'
headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
}
 
query = """
query GetAllMatters {
  AllMatters {
    Id
    Number
    Name
    Client {
      Id
      Number
      Name
    }
    Phases {
      Id
      Number
      Name
    }
  }
}
"""
 
payload = {
    "query": query
}
 
response = requests.post(url, headers=headers, json=payload)
data = response.json()
 
if 'errors' in data:
    print("Error:", data['errors'])
else:
    print("Matters retrieved successfully")
    print("Number of matters:", len(data['data']['AllMatters']))

Example Response


{
  "data": {
    "AllMatters": [
      {
        "Id": "5f8d0d5a7b3e4f1234567890",
        "Number": "MAT-2023-001",
        "Name": "Corporate Restructuring Project",
        "Client": {
          "Id": "5f8d0d5a7b3e4f1234567891",
          "Number": "CLI-2022-456",
          "Name": "Acme Corporation"
        },
        "Phases": [
          {
            "Id": "5f8d0d5a7b3e4f1234567892",
            "Number": "PH-2023-001-A",
            "Name": "Discovery Phase"
          },
          {
            "Id": "5f8d0d5a7b3e4f1234567893",
            "Number": "PH-2023-001-B",
            "Name": "Implementation Phase"
          }
        ]
      },
      {
        "Id": "5f8d0d5a7b3e4f1234567894",
        "Number": "MAT-2023-002",
        "Name": "Legal Compliance Review",
        "Client": {
          "Id": "5f8d0d5a7b3e4f1234567895",
          "Number": "CLI-2022-789",
          "Name": "Global Tech Inc."
        },
        "Phases": [
          {
            "Id": "5f8d0d5a7b3e4f1234567896",
            "Number": "PH-2023-002-A",
            "Name": "Initial Assessment"
          }
        ]
      }
    ]
  }
}

Response Fields

Id: Unique identifier for the matter (String!)
Number: Matter reference number (String!)
Name: Descriptive name of the matter (String!)
Client: Client information (Client! type)
- Id: Client unique identifier
- Number: Client reference number
- Name: Client name
Phases: Array of matter phases (MatterPhase! type)
- Id: Phase unique identifier
- Number: Phase reference number
- Name: Phase name

Pagination

Note: This query does not support pagination. All matters are returned in a single response. If paging is required, a different query should be used which suports pagination.

Error Handling

Common error responses:


{
  "errors": [
    {
      "message": "Unauthorized",
      "extensions": {
        "code": "UNAUTHENTICATED"
      }
    }
  ]
}


{
  "errors": [
    {
      "message": "Internal server error",
      "extensions": {
        "code": "INTERNAL_SERVER_ERROR"
      }
    }
  ]
}