MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Endpoints

Handles the API request and renders the Swagger documentation view.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documentation" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documentation"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>L5 Swagger UI</title>
    <link rel="stylesheet" type="text/css" href="http://gryphon-central-stage.gryphon-tenant-api.test:3002/docs/asset/swagger-ui.css?v=4758762786ee309249dce960484fc1f4">
    <link rel="icon" type="image/png" href="http://gryphon-central-stage.gryphon-tenant-api.test:3002/docs/asset/favicon-32x32.png?v=40d4f2c38d1cd854ad463f16373cbcb6" sizes="32x32"/>
    <link rel="icon" type="image/png" href="http://gryphon-central-stage.gryphon-tenant-api.test:3002/docs/asset/favicon-16x16.png?v=f0ae831196d55d8f4115b6c5e8ec5384" sizes="16x16"/>
    <style>
    html
    {
        box-sizing: border-box;
        overflow: -moz-scrollbars-vertical;
        overflow-y: scroll;
    }
    *,
    *:before,
    *:after
    {
        box-sizing: inherit;
    }

    body {
      margin:0;
      background: #fafafa;
    }
    </style>
    </head>

<body >
<div id="swagger-ui"></div>

<script src="http://gryphon-central-stage.gryphon-tenant-api.test:3002/docs/asset/swagger-ui-bundle.js?v=ff3f03083fa6f196ebb3182ae209848b"></script>
<script src="http://gryphon-central-stage.gryphon-tenant-api.test:3002/docs/asset/swagger-ui-standalone-preset.js?v=2ff98136c02067086c51951f5e11c8db"></script>
<script>
    window.onload = function() {
        const urls = [];

                    urls.push({name: "L5 Swagger UI", url: "http://gryphon-central-stage.gryphon-tenant-api.test:3002/docs?api-docs.json"});
        
        // Build a system
        const ui = SwaggerUIBundle({
            dom_id: '#swagger-ui',
            urls: urls,
            "urls.primaryName": "L5 Swagger UI",
            operationsSorter: null,
            configUrl: null,
            validatorUrl: null,
            oauth2RedirectUrl: "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/oauth2-callback",

            requestInterceptor: function(request) {
                request.headers['X-CSRF-TOKEN'] = '';
                return request;
            },

            presets: [
                SwaggerUIBundle.presets.apis,
                SwaggerUIStandalonePreset
            ],

            plugins: [
                SwaggerUIBundle.plugins.DownloadUrl
            ],

            layout: "StandaloneLayout",
            docExpansion : "none",
            deepLinking: true,
            filter: true,
            persistAuthorization: "false",

        })

        window.ui = ui

            }
</script>
</body>
</html>

Request   

GET api/documentation

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Handles the OAuth2 callback and retrieves the required file for the redirect.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/oauth2-callback" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/oauth2-callback"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
content-type: text/html; charset=utf-8
cache-control: no-cache, private
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

<!doctype html>
<html lang="en-US">
<body>
<script src="oauth2-redirect.js"></script>
</body>
</html>

Request   

GET api/oauth2-callback

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/health

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/health" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/health"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "status": "ok",
    "service": "gryphon-api",
    "version": "unknown",
    "timestamp": "2026-05-14T17:42:31+00:00",
    "app_version": "unknown"
}

Request   

GET api/health

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Handle webhook from WorkMarket for payment status updates

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/webhook" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/webhook"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/workmarket/webhook

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Public login-page endpoint. Returns active site banners only.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/site-banners/active" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/site-banners/active"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Server Error",
    "app_version": "unknown"
}

Request   

GET api/site-banners/active

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/status/outage

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/status/outage" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/status/outage"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "outage": false,
    "app_version": "unknown"
}

Request   

GET api/status/outage

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Return the registry contract as {data: placeholder[], meta: {contexts: {key, label}[], storage_strategy: string}}.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/placeholders" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/placeholders"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/rich-text/placeholders

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/rich-text/resolution-failures

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/resolution-failures" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"context\": \"vmqeopfuudtdsufvyvddq\",
    \"end_date\": \"2107-06-13\",
    \"page\": 45,
    \"per_page\": 16,
    \"render_stage\": \"preview\",
    \"sort_by\": \"context\",
    \"sort_order\": \"desc\",
    \"start_date\": \"2026-05-14T17:42:31\",
    \"token\": \"eopfuudtdsufvyvddqamn\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/resolution-failures"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "context": "vmqeopfuudtdsufvyvddq",
    "end_date": "2107-06-13",
    "page": 45,
    "per_page": 16,
    "render_stage": "preview",
    "sort_by": "context",
    "sort_order": "desc",
    "start_date": "2026-05-14T17:42:31",
    "token": "eopfuudtdsufvyvddqamn"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/rich-text/resolution-failures

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

context   string  optional  

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

end_date   string  optional  

Must be a valid date. Must be a date after or equal to start_date. Example: 2107-06-13

page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

reference_id   string  optional  
render_stage   string  optional  

Example: preview

Must be one of:
  • preview
  • final_render
sort_by   string  optional  

Example: context

Must be one of:
  • context
  • created_at
  • reference_id
  • render_stage
  • token
sort_order   string  optional  

Example: desc

Must be one of:
  • asc
  • desc
start_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

token   string  optional  

Must not be greater than 100 characters. Example: eopfuudtdsufvyvddqamn

GET api/rich-text/resolution-failures/{richTextResolutionFailure}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/resolution-failures/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/resolution-failures/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/rich-text/resolution-failures/{richTextResolutionFailure}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

richTextResolutionFailure   string   

Example: consequatur

POST api/rich-text/render

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/render" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": {
        \"content\": [],
        \"type\": \"doc\"
    },
    \"context\": \"alert_template\",
    \"output_format\": \"html\",
    \"reference_id\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/render"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "content": {
        "content": [],
        "type": "doc"
    },
    "context": "alert_template",
    "output_format": "html",
    "reference_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/rich-text/render

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

content   object   
content   object   
type   string   

Example: doc

Must be one of:
  • doc
context   string   

Example: alert_template

Must be one of:
  • alert_template
output_format   string   

Example: html

Must be one of:
  • html
  • pdf
reference_id   string   

Example: consequatur

POST api/rich-text/resolve

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/resolve" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"context\": \"alert_template\",
    \"reference_id\": \"consequatur\",
    \"render_stage\": \"final_render\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/resolve"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "context": "alert_template",
    "reference_id": "consequatur",
    "render_stage": "final_render"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/rich-text/resolve

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

context   string   

Example: alert_template

Must be one of:
  • alert_template
  • banner_builder
reference_id   string   

Example: consequatur

render_stage   string   

Example: final_render

Must be one of:
  • preview
  • final_render

POST api/rich-text/validate

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/validate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": {
        \"content\": [],
        \"type\": \"doc\"
    },
    \"context\": \"banner_builder\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/rich-text/validate"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "content": {
        "content": [],
        "type": "doc"
    },
    "context": "banner_builder"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/rich-text/validate

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

content   object   
content   object   
type   string   

Example: doc

Must be one of:
  • doc
context   string   

Example: banner_builder

Must be one of:
  • alert_template
  • banner_builder

GET api/addresses

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/addresses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/addresses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/addresses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/addresses/zip-lookup

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/addresses/zip-lookup" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/addresses/zip-lookup"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/addresses/zip-lookup

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/addresses/complete

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/addresses/complete" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/addresses/complete"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/addresses/complete

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/qs_reports

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/qs_reports" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/qs_reports"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/qs_reports

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/qs_reports/getEmbedUrl

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/qs_reports/getEmbedUrl" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/qs_reports/getEmbedUrl"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/qs_reports/getEmbedUrl

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/logout

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/logout"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/logout

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/register/submit

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/register/submit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"domain\": \"consequatur\",
    \"company\": \"mqeopfuudtdsufvyvddqa\",
    \"name\": \"mniihfqcoynlazghdtqtq\",
    \"email\": \"ablanda@example.org\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/register/submit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "domain": "consequatur",
    "company": "mqeopfuudtdsufvyvddqa",
    "name": "mniihfqcoynlazghdtqtq",
    "email": "ablanda@example.org"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/register/submit

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

domain   string  optional  

Example: consequatur

company   string   

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

name   string   

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: ablanda@example.org

GET api/professional-designations

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/professional-designations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/professional-designations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/professional-designations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/professional-designations

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/professional-designations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"consequatur\",
    \"name\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"is_active\": false,
    \"display_order\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/professional-designations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "consequatur",
    "name": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "is_active": false,
    "display_order": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/professional-designations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

code   string   

Example: consequatur

name   string   

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

is_active   boolean  optional  

Example: false

display_order   integer  optional  

Example: 17

POST /api/clients/standalone Creates a top-level (standalone) company.

requires authentication

Requires company_role=Operational (enforced by write service).

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/standalone" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_name\": \"vmqeopfuudtdsufvyvddq\",
    \"company_role\": \"Organizational\",
    \"abbreviation\": \"amniihfqcoynlazghdtqt\",
    \"domain\": \"qxbajwbpilpmufinllwlo\",
    \"under_loa\": false,
    \"case_id_type\": \"auydlsmsjuryvojcybzvr\",
    \"client_category_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/standalone"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_name": "vmqeopfuudtdsufvyvddq",
    "company_role": "Organizational",
    "abbreviation": "amniihfqcoynlazghdtqt",
    "domain": "qxbajwbpilpmufinllwlo",
    "under_loa": false,
    "case_id_type": "auydlsmsjuryvojcybzvr",
    "client_category_id": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients/standalone

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

company_name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

company_role   string   

Example: Organizational

Must be one of:
  • Operational
  • Organizational
abbreviation   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

domain   string  optional  

Must not be greater than 63 characters. Example: qxbajwbpilpmufinllwlo

under_loa   boolean   

Example: false

case_id_type   string   

Must not be greater than 100 characters. Example: auydlsmsjuryvojcybzvr

client_category_id   integer  optional  

The id of an existing record in the client_categories table. Example: 17

data   object  optional  

POST /api/clients/{parentId}/children Creates a child company under the given parent.

requires authentication

Parent must exist and belong to the tenant tree.

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1562/children" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_name\": \"vmqeopfuudtdsufvyvddq\",
    \"company_role\": \"Organizational\",
    \"abbreviation\": \"amniihfqcoynlazghdtqt\",
    \"domain\": \"qxbajwbpilpmufinllwlo\",
    \"under_loa\": false,
    \"case_id_type\": \"auydlsmsjuryvojcybzvr\",
    \"client_category_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1562/children"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_name": "vmqeopfuudtdsufvyvddq",
    "company_role": "Organizational",
    "abbreviation": "amniihfqcoynlazghdtqt",
    "domain": "qxbajwbpilpmufinllwlo",
    "under_loa": false,
    "case_id_type": "auydlsmsjuryvojcybzvr",
    "client_category_id": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients/{parentId}/children

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

parentId   string   

Example: 1562

Body Parameters

company_name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

company_role   string  optional  

Example: Organizational

Must be one of:
  • Operational
  • Organizational
abbreviation   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

domain   string  optional  

Must not be greater than 63 characters. Example: qxbajwbpilpmufinllwlo

under_loa   boolean   

Example: false

case_id_type   string   

Must not be greater than 100 characters. Example: auydlsmsjuryvojcybzvr

client_category_id   integer  optional  

The id of an existing record in the client_categories table. Example: 17

data   object  optional  

GET /api/clients/operational-picker Returns Operational + Active companies visible to the authenticated user, with hierarchy paths resolved in a single batch query.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/operational-picker" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/operational-picker"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/operational-picker

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET /api/clients/{id}/hierarchy Accepts any node ID (root, child, or deep descendant).

requires authentication

Auto-resolves to the tree root via the closure table. ModelNotFoundException propagates to Handler → 404 'Client not found.'

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1562/hierarchy" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1562/hierarchy"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/{id}/hierarchy

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the client. Example: 1562

GET /api/clients/{id}/relationships Returns direct parent and direct children for the given client.

requires authentication

ModelNotFoundException propagates to Handler → 404 'Client not found.'

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1562/relationships" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1562/relationships"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/{id}/relationships

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the client. Example: 1562

GET /api/clients/{client}/internal-documents Lists internal documents for a central user on the given client.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/internal-documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/internal-documents"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/{client_id}/internal-documents

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

client_id   integer   

The ID of the client. Example: 1

POST /api/clients/{client}/internal-documents Uploads a new internal document for the given client.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/internal-documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@/tmp/phpOgtDGF" 
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/internal-documents"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request   

POST api/clients/{client_id}/internal-documents

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

client_id   integer   

The ID of the client. Example: 1

Body Parameters

file   file   

Must be a file. Must not be greater than 8192 kilobytes. Example: /tmp/phpOgtDGF

GET /api/clients/{client}/internal-documents/{documentId}/preview Returns a signed preview URL when supported, otherwise an inline stream.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/internal-documents/1562/preview" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/internal-documents/1562/preview"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/{client_id}/internal-documents/{documentId}/preview

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

client_id   integer   

The ID of the client. Example: 1

documentId   string   

Example: 1562

DELETE /api/clients/{client}/internal-documents/{documentId} Soft-deletes an internal document and removes its stored binary.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/internal-documents/1562" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/internal-documents/1562"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/clients/{client_id}/internal-documents/{documentId}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

client_id   integer   

The ID of the client. Example: 1

documentId   string   

Example: 1562

POST /api/clients/{clientId}/inheritance/detach Detaches a section from parent inheritance, making it locally owned.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/inheritance/detach" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"section\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/inheritance/detach"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "section": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients/{clientId}/inheritance/detach

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clientId   integer   

Example: 1

Body Parameters

section   string   

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

Must be one of:
  • DUE_DATES_AND_TURNAROUND_TIMES
  • MISCELLANEOUS
  • LINES_OF_BUSINESS_AND_MEMBER_ID_TYPES
  • REQUEST_TYPES
  • CLINICAL_CRITERIA
  • PRICING
  • NARRATIVE_REPORTS_SUBMISSION
  • AUTO_ASSIGN_CASE_MANAGERS
  • CUSTOM_ALERTS
  • PAYER_INFO
  • INVOICE_SUBMISSION
  • INVOICE_CONTENT_TYPES
  • USERS

POST /api/clients/{clientId}/inheritance/reattach Re-attaches a section to the parent's inheritance chain.

requires authentication

Requires confirm=true (FormRequest enforces this).

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/inheritance/reattach" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"section\": \"vmqeopfuudtdsufvyvddq\",
    \"confirm\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/inheritance/reattach"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "section": "vmqeopfuudtdsufvyvddq",
    "confirm": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients/{clientId}/inheritance/reattach

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clientId   integer   

Example: 1

Body Parameters

section   string   

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

Must be one of:
  • DUE_DATES_AND_TURNAROUND_TIMES
  • MISCELLANEOUS
  • LINES_OF_BUSINESS_AND_MEMBER_ID_TYPES
  • REQUEST_TYPES
  • CLINICAL_CRITERIA
  • PRICING
  • NARRATIVE_REPORTS_SUBMISSION
  • AUTO_ASSIGN_CASE_MANAGERS
  • CUSTOM_ALERTS
  • PAYER_INFO
  • INVOICE_SUBMISSION
  • INVOICE_CONTENT_TYPES
  • USERS
confirm   boolean   

Must be accepted. Example: true

GET api/clients/{clientId}/sections

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/sections" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/sections"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/{clientId}/sections

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clientId   integer   

Example: 1

PATCH /api/clients/{id}/payer

requires authentication

Assign a payer company to this client. Guards:

On Finance incompleteness: fires audit event payer_assignment_blocked_missing_finance (fire-and-forget) then throws PayerAssignmentBlockedMissingFinanceException (→ 400).

Permission: update:organizations

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/payer" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"payer_client_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/payer"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "payer_client_id": 17
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/clients/{id}/payer

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

Body Parameters

payer_client_id   integer   

The id of an existing record in the clients table. Example: 17

GET api/clients/{id}/rules

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/rules" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/rules"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/{id}/rules

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

PATCH api/clients/{id}/rules

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/rules" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"narrative_report_submission\": true,
    \"auto_assign_case_managers\": false,
    \"custom_alerts_enabled\": true,
    \"turnaround_days\": 73
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/rules"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "narrative_report_submission": true,
    "auto_assign_case_managers": false,
    "custom_alerts_enabled": true,
    "turnaround_days": 73
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/clients/{id}/rules

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

Body Parameters

narrative_report_submission   boolean  optional  

Example: true

auto_assign_case_managers   boolean  optional  

Example: false

custom_alerts_enabled   boolean  optional  

Example: true

turnaround_days   integer  optional  

Must be at least 0. Example: 73

POST /api/clients/{id}/move/preview Returns inheritance diff and an operation token required for confirm.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/move/preview" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"new_parent_id\": 73
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/move/preview"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "new_parent_id": 73
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients/{id}/move/preview

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

Body Parameters

new_parent_id   integer   

Must be at least 1. Example: 73

POST /api/clients/{id}/move/confirm Executes the move after token and concurrency validation.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/move/confirm" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"operation_token\": \"vmqeopfuudtdsufvyvddq\",
    \"expected_updated_at\": \"2026-05-14T17:42:31\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/move/confirm"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "operation_token": "vmqeopfuudtdsufvyvddq",
    "expected_updated_at": "2026-05-14T17:42:31"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients/{id}/move/confirm

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

Body Parameters

operation_token   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

expected_updated_at   string   

Must be a valid date. Example: 2026-05-14T17:42:31

POST /api/clients/{id}/parent-above Inserts a new blank parent company above the given company.

requires authentication

The new parent gets all sections LOCAL; the existing company's settings are unchanged.

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/parent-above" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_name\": \"vmqeopfuudtdsufvyvddq\",
    \"company_role\": \"Organizational\",
    \"abbreviation\": \"amniihfqc\",
    \"under_loa\": true,
    \"case_id_type\": \"oynlazghdtqtqxbajwbpi\",
    \"client_category_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/parent-above"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_name": "vmqeopfuudtdsufvyvddq",
    "company_role": "Organizational",
    "abbreviation": "amniihfqc",
    "under_loa": true,
    "case_id_type": "oynlazghdtqtqxbajwbpi",
    "client_category_id": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients/{id}/parent-above

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

Body Parameters

company_name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

company_role   string   

Example: Organizational

Must be one of:
  • Operational
  • Organizational
abbreviation   string  optional  

Must not be greater than 10 characters. Example: amniihfqc

under_loa   boolean   

Example: true

case_id_type   string   

Must not be greater than 100 characters. Example: oynlazghdtqtqxbajwbpi

client_category_id   integer  optional  

The id of an existing record in the client_categories table. Example: 17

POST /api/clients/{id}/activate Activates the company. Idempotent if already active.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/activate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/activate"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/clients/{id}/activate

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

POST /api/clients/{id}/disable Disables the company. Idempotent if already disabled.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/disable" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/disable"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/clients/{id}/disable

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

POST /api/clients/{id}/reassign-parent Deprecated legacy endpoint kept only to return an explicit migration error.

requires authentication

Use move preview/confirm endpoints instead.

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/reassign-parent" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"new_parent_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/reassign-parent"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "new_parent_id": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients/{id}/reassign-parent

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

Body Parameters

new_parent_id   integer  optional  

The id of an existing record in the clients table. Example: 17

GET /api/clients/{id}/users Returns all users associated with the company itself AND all its ancestor companies.

requires authentication

Users from children or siblings are NOT included.

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/{id}/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

GET api/clients/{client_id}/secure-domains

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/secure-domains" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/secure-domains"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/{client_id}/secure-domains

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

client_id   integer   

The ID of the client. Example: 1

POST api/clients/{client_id}/secure-domains

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/secure-domains" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"domain\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/secure-domains"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "domain": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients/{client_id}/secure-domains

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

client_id   integer   

The ID of the client. Example: 1

Body Parameters

domain   string   

Must match the regex /^(?:a-z0-9?.)+[a-z]{2,}$/. Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

DELETE api/clients/{client_id}/secure-domains/{secureEmailDomain_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/secure-domains/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1/secure-domains/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/clients/{client_id}/secure-domains/{secureEmailDomain_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

client_id   integer   

The ID of the client. Example: 1

secureEmailDomain_id   integer   

The ID of the secureEmailDomain. Example: 17

Global picker — distinct domains registered across all clients. Used by the FE to suggest existing domain values when registering a new entry (business rule 7: "selected from previously registered domains").

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/secure-domains" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/secure-domains"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/secure-domains

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/clients

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"assessment_label\": \"vmqeopfuudtdsufvyvddq\",
    \"category\": {
        \"id\": 17
    },
    \"company_name\": \"mqeopfuudtdsufvyvddqa\",
    \"abbreviation\": \"mniihfqcoynlazghdtqtq\",
    \"domain\": \"xbajwbpilpmufinllwloa\",
    \"addresses\": [
        {
            \"line_1\": \"uydlsmsjuryvojcybzvrb\",
            \"line_2\": \"yickznkygloigmkwxphlv\",
            \"city\": \"azjrcnfbaqywuxhgjjmzu\",
            \"state\": \"xjubqouzswiwxtrkimfca\",
            \"zip_code\": \"tbxspzmrazsroyjpxmqes\",
            \"is_primary\": false,
            \"type\": \"shipping\"
        }
    ],
    \"emails\": [
        {
            \"address\": \"edyghenqcopwvownkbaml\",
            \"type\": \"personal\"
        }
    ],
    \"phones\": [
        {
            \"number\": \"nfngefbeilfzsyuxoezbd\",
            \"type\": \"work\"
        }
    ],
    \"client_access\": [
        {
            \"id\": 17
        }
    ],
    \"gryphon_activities\": [
        {
            \"message\": \"consequatur\",
            \"priority\": \"consequatur\",
            \"visibility\": \"consequatur\",
            \"user\": {
                \"id\": 17
            }
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "assessment_label": "vmqeopfuudtdsufvyvddq",
    "category": {
        "id": 17
    },
    "company_name": "mqeopfuudtdsufvyvddqa",
    "abbreviation": "mniihfqcoynlazghdtqtq",
    "domain": "xbajwbpilpmufinllwloa",
    "addresses": [
        {
            "line_1": "uydlsmsjuryvojcybzvrb",
            "line_2": "yickznkygloigmkwxphlv",
            "city": "azjrcnfbaqywuxhgjjmzu",
            "state": "xjubqouzswiwxtrkimfca",
            "zip_code": "tbxspzmrazsroyjpxmqes",
            "is_primary": false,
            "type": "shipping"
        }
    ],
    "emails": [
        {
            "address": "edyghenqcopwvownkbaml",
            "type": "personal"
        }
    ],
    "phones": [
        {
            "number": "nfngefbeilfzsyuxoezbd",
            "type": "work"
        }
    ],
    "client_access": [
        {
            "id": 17
        }
    ],
    "gryphon_activities": [
        {
            "message": "consequatur",
            "priority": "consequatur",
            "visibility": "consequatur",
            "user": {
                "id": 17
            }
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

parent_id   string  optional  
parent   string  optional  
children   string  optional  
assessment_label   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

category   object  optional  
id   integer  optional  

The id of an existing record in the client_categories table. Example: 17

company_name   string   

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

abbreviation   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

domain   string  optional  

Must not be greater than 63 characters. Example: xbajwbpilpmufinllwloa

data   object  optional  
addresses   object[]  optional  
line_1   string   

Must not be greater than 255 characters. Example: uydlsmsjuryvojcybzvrb

line_2   string  optional  

Must not be greater than 255 characters. Example: yickznkygloigmkwxphlv

city   string   

Must not be greater than 255 characters. Example: azjrcnfbaqywuxhgjjmzu

state   string   

Must not be greater than 255 characters. Example: xjubqouzswiwxtrkimfca

zip_code   string   

Must not be greater than 255 characters. Example: tbxspzmrazsroyjpxmqes

is_primary   boolean  optional  

Example: false

type   string   

Example: shipping

Must be one of:
  • home
  • work
  • billing
  • shipping
emails   object[]  optional  
address   string   

Must be a valid email address. Must not be greater than 255 characters. Example: edyghenqcopwvownkbaml

type   string   

Example: personal

Must be one of:
  • main
  • personal
  • work
  • secondary
phones   object[]  optional  
number   string   

Must not be greater than 255 characters. Example: nfngefbeilfzsyuxoezbd

type   string   

Example: work

Must be one of:
  • main
  • home
  • work
  • mobile
client_access   object[]  optional  
id   integer   

The id of an existing record in the clients table. Example: 17

gryphon_activities   object[]  optional  
message   string   

Example: consequatur

priority   string   

Example: consequatur

visibility   string   

Example: consequatur

user   object  optional  
id   integer  optional  

The id of an existing record in the users table. Example: 17

parent   string  optional  

GET api/clients

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/clients/gryphon-activities/{client_id}

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"user\": {
        \"id\": 17
    },
    \"visibility\": \"consequatur\",
    \"parent\": {
        \"id\": 17
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message": "consequatur",
    "priority": "consequatur",
    "user": {
        "id": 17
    },
    "visibility": "consequatur",
    "parent": {
        "id": 17
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clients/gryphon-activities/{client_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

client_id   integer   

The ID of the client. Example: 1

Body Parameters

message   string   

Example: consequatur

priority   string   

Example: consequatur

user   object  optional  
id   integer  optional  

The id of an existing record in the users table. Example: 17

visibility   string   

Example: consequatur

parent   object  optional  
id   integer  optional  

The id of an existing record in the gryphon_activities table. Example: 17

GET api/clients/gryphon-activities/{client_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search\": \"consequatur\",
    \"start_date\": \"2026-05-14T17:42:31\",
    \"end_date\": \"2026-05-14T17:42:31\",
    \"created_at\": \"2026-05-14T17:42:31\",
    \"activity_type\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"visibility\": \"consequatur\",
    \"user_id\": 17,
    \"parent_id\": 17,
    \"updated_at\": \"2026-05-14T17:42:31\",
    \"page\": 45,
    \"per_page\": 16,
    \"limit\": 5,
    \"offset\": 50,
    \"sort\": \"consequatur\",
    \"order\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search": "consequatur",
    "start_date": "2026-05-14T17:42:31",
    "end_date": "2026-05-14T17:42:31",
    "created_at": "2026-05-14T17:42:31",
    "activity_type": "consequatur",
    "priority": "consequatur",
    "visibility": "consequatur",
    "user_id": 17,
    "parent_id": 17,
    "updated_at": "2026-05-14T17:42:31",
    "page": 45,
    "per_page": 16,
    "limit": 5,
    "offset": 50,
    "sort": "consequatur",
    "order": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/gryphon-activities/{client_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

client_id   integer   

The ID of the client. Example: 1

Body Parameters

search   string  optional  

Example: consequatur

start_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

end_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

created_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

activity_type   string  optional  

Example: consequatur

priority   string  optional  

Example: consequatur

visibility   string  optional  

Example: consequatur

user_id   integer  optional  

Example: 17

parent_id   integer  optional  

Example: 17

updated_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 5

offset   integer  optional  

Must be at least 0. Example: 50

sort   string  optional  

Example: consequatur

order   string  optional  

Example: consequatur

people   string  optional  

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/search"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

GET api/clients/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clients/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

PATCH api/clients/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"assessment_label\": \"vmqeopfuudtdsufvyvddq\",
    \"category\": {
        \"id\": 17
    },
    \"case_type_set\": {
        \"id\": 17
    },
    \"company_name\": \"mqeopfuudtdsufvyvddqa\",
    \"abbreviation\": \"mniihfqcoynlazghdtqtq\",
    \"addresses\": [
        {
            \"line_1\": \"xbajwbpilpmufinllwloa\",
            \"line_2\": \"uydlsmsjuryvojcybzvrb\",
            \"city\": \"yickznkygloigmkwxphlv\",
            \"state\": \"azjrcnfbaqywuxhgjjmzu\",
            \"zip_code\": \"xjubqouzswiwxtrkimfca\",
            \"is_primary\": true,
            \"type\": \"billing\"
        }
    ],
    \"emails\": [
        {
            \"address\": \"tbxspzmrazsroyjpxmqes\",
            \"type\": \"secondary\"
        }
    ],
    \"phones\": [
        {
            \"number\": \"edyghenqcopwvownkbaml\",
            \"type\": \"home\"
        }
    ],
    \"client_access\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clients/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "assessment_label": "vmqeopfuudtdsufvyvddq",
    "category": {
        "id": 17
    },
    "case_type_set": {
        "id": 17
    },
    "company_name": "mqeopfuudtdsufvyvddqa",
    "abbreviation": "mniihfqcoynlazghdtqtq",
    "addresses": [
        {
            "line_1": "xbajwbpilpmufinllwloa",
            "line_2": "uydlsmsjuryvojcybzvrb",
            "city": "yickznkygloigmkwxphlv",
            "state": "azjrcnfbaqywuxhgjjmzu",
            "zip_code": "xjubqouzswiwxtrkimfca",
            "is_primary": true,
            "type": "billing"
        }
    ],
    "emails": [
        {
            "address": "tbxspzmrazsroyjpxmqes",
            "type": "secondary"
        }
    ],
    "phones": [
        {
            "number": "edyghenqcopwvownkbaml",
            "type": "home"
        }
    ],
    "client_access": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/clients/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the client. Example: 1

Body Parameters

parent_id   string  optional  
parent   string  optional  
children   string  optional  
assessment_label   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

category   object  optional  
id   integer  optional  

The id of an existing record in the client_categories table. Example: 17

case_type_set   object  optional  
id   integer  optional  

The id of an existing record in the case_type_sets table. Example: 17

company_name   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

abbreviation   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

data   object  optional  
addresses   object[]  optional  
line_1   string   

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

line_2   string  optional  

Must not be greater than 255 characters. Example: uydlsmsjuryvojcybzvrb

city   string   

Must not be greater than 255 characters. Example: yickznkygloigmkwxphlv

state   string   

Must not be greater than 255 characters. Example: azjrcnfbaqywuxhgjjmzu

zip_code   string   

Must not be greater than 255 characters. Example: xjubqouzswiwxtrkimfca

is_primary   boolean  optional  

Example: true

type   string   

Example: billing

Must be one of:
  • home
  • work
  • billing
  • shipping
emails   object[]  optional  
address   string   

Must be a valid email address. Must not be greater than 255 characters. Example: tbxspzmrazsroyjpxmqes

type   string   

Example: secondary

Must be one of:
  • main
  • personal
  • work
  • secondary
phones   object[]  optional  
number   string   

Must not be greater than 255 characters. Example: edyghenqcopwvownkbaml

type   string   

Example: home

Must be one of:
  • main
  • home
  • work
  • mobile
client_access   object[]  optional  
id   integer   

The id of an existing record in the clients table. Example: 17

GET api/client-categories

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/client-categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/users/gryphon-activities/{user_id}

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"user\": {
        \"id\": 17
    },
    \"visibility\": \"consequatur\",
    \"parent\": {
        \"id\": 17
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message": "consequatur",
    "priority": "consequatur",
    "user": {
        "id": 17
    },
    "visibility": "consequatur",
    "parent": {
        "id": 17
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/users/gryphon-activities/{user_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

message   string   

Example: consequatur

priority   string   

Example: consequatur

user   object  optional  
id   integer  optional  

The id of an existing record in the users table. Example: 17

visibility   string   

Example: consequatur

parent   object  optional  
id   integer  optional  

The id of an existing record in the gryphon_activities table. Example: 17

GET api/users/gryphon-activities/{user_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search\": \"consequatur\",
    \"start_date\": \"2026-05-14T17:42:31\",
    \"end_date\": \"2026-05-14T17:42:31\",
    \"created_at\": \"2026-05-14T17:42:31\",
    \"activity_type\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"visibility\": \"consequatur\",
    \"user_id\": 17,
    \"parent_id\": 17,
    \"updated_at\": \"2026-05-14T17:42:31\",
    \"page\": 45,
    \"per_page\": 16,
    \"limit\": 5,
    \"offset\": 50,
    \"sort\": \"consequatur\",
    \"order\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search": "consequatur",
    "start_date": "2026-05-14T17:42:31",
    "end_date": "2026-05-14T17:42:31",
    "created_at": "2026-05-14T17:42:31",
    "activity_type": "consequatur",
    "priority": "consequatur",
    "visibility": "consequatur",
    "user_id": 17,
    "parent_id": 17,
    "updated_at": "2026-05-14T17:42:31",
    "page": 45,
    "per_page": 16,
    "limit": 5,
    "offset": 50,
    "sort": "consequatur",
    "order": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/gryphon-activities/{user_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

search   string  optional  

Example: consequatur

start_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

end_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

created_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

activity_type   string  optional  

Example: consequatur

priority   string  optional  

Example: consequatur

visibility   string  optional  

Example: consequatur

user_id   integer  optional  

Example: 17

parent_id   integer  optional  

Example: 17

updated_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 5

offset   integer  optional  

Must be at least 0. Example: 50

sort   string  optional  

Example: consequatur

order   string  optional  

Example: consequatur

people   string  optional  

GET api/users/me

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/me" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/me"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/me

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/users/me

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/me" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\",
    \"legal_first_name\": \"dqamniihfqcoynlazghdt\",
    \"legal_last_name\": \"qtqxbajwbpilpmufinllw\",
    \"status\": \"consequatur\",
    \"phones\": [
        {
            \"type\": \"mobile\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/me"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "O[2UZ5ij-e\/dl4m{o,",
    "legal_first_name": "dqamniihfqcoynlazghdt",
    "legal_last_name": "qtqxbajwbpilpmufinllw",
    "status": "consequatur",
    "phones": [
        {
            "type": "mobile"
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/users/me

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

password   string  optional  

Must be at least 8 characters. Example: O[2UZ5ij-e/dl4m{o,

legal_first_name   string  optional  

Must not be greater than 255 characters. Example: dqamniihfqcoynlazghdt

legal_last_name   string  optional  

Must not be greater than 255 characters. Example: qtqxbajwbpilpmufinllw

preferred_first_name   string  optional  
preferred_last_name   string  optional  
date_of_birth   string  optional  
phone   string  optional  
ssn   string  optional  
upper_first_name   string  optional  
upper_last_name   string  optional  
salutation   string  optional  
address   string  optional  
status   string  optional  

Example: consequatur

Must be one of:
  • setup
  • pending
  • training
  • active
  • clinical_hold
  • standby
  • deactivated
phones   object[]  optional  
number   string  optional  
type   string  optional  

Example: mobile

Must be one of:
  • main
  • home
  • work
  • mobile

POST api/users/profile-image/{user_id}

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/profile-image/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "profile_image=@/tmp/phpgETqMu" 
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/profile-image/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('profile_image', document.querySelector('input[name="profile_image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request   

POST api/users/profile-image/{user_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

profile_image   file   

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpgETqMu

POST api/users/me/profile-image

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/me/profile-image" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "profile_image=@/tmp/phph7PY1g" 
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/me/profile-image"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('profile_image', document.querySelector('input[name="profile_image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request   

POST api/users/me/profile-image

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

profile_image   file   

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phph7PY1g

GET api/users/profile-image/{user_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/profile-image/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/profile-image/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/profile-image/{user_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

POST api/users

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"email\": \"kunde.eloisa@example.com\",
    \"password\": \"4[*UyPJ\\\"}6\",
    \"role\": {
        \"id\": 17
    },
    \"legal_first_name\": \"mqeopfuudtdsufvyvddqa\",
    \"legal_last_name\": \"mniihfqcoynlazghdtqtq\",
    \"user_type\": \"consequatur\",
    \"caseload\": 45,
    \"payee_type\": \"consequatur\",
    \"employment_type\": \"consequatur\",
    \"status\": \"consequatur\",
    \"compensation_type\": \"consequatur\",
    \"pay_period\": \"consequatur\",
    \"deduct_drive_time\": false,
    \"phones\": [
        {
            \"number\": \"mqeopfuudtdsufvyvddqa\",
            \"type\": \"work\"
        }
    ],
    \"emails\": [
        {
            \"address\": \"mniihfqcoynlazghdtqtq\",
            \"type\": \"secondary\"
        }
    ],
    \"tags\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "email": "kunde.eloisa@example.com",
    "password": "4[*UyPJ\"}6",
    "role": {
        "id": 17
    },
    "legal_first_name": "mqeopfuudtdsufvyvddqa",
    "legal_last_name": "mniihfqcoynlazghdtqtq",
    "user_type": "consequatur",
    "caseload": 45,
    "payee_type": "consequatur",
    "employment_type": "consequatur",
    "status": "consequatur",
    "compensation_type": "consequatur",
    "pay_period": "consequatur",
    "deduct_drive_time": false,
    "phones": [
        {
            "number": "mqeopfuudtdsufvyvddqa",
            "type": "work"
        }
    ],
    "emails": [
        {
            "address": "mniihfqcoynlazghdtqtq",
            "type": "secondary"
        }
    ],
    "tags": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

email   string   

Must be a valid email address. Example: kunde.eloisa@example.com

password   string  optional  

Must be at least 8 characters. Example: 4[*UyPJ"}6

roles   object  optional  
role   object  optional  
id   integer  optional  

This field is required when role is present. The id of an existing record in the roles table. Example: 17

capabilities   object  optional  
legal_first_name   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

legal_last_name   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

preferred_first_name   string  optional  
preferred_last_name   string  optional  
date_of_birth   string  optional  
phone   string  optional  
emails   object[]  optional  
address   string  optional  

This field is required when emails is present. Must be a valid email address. Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

type   string  optional  

Example: secondary

Must be one of:
  • main
  • personal
  • work
  • secondary
ssn   string  optional  
start_date   string  optional  
startdate   string  optional  
work_status   string  optional  
last_day_of_work   string  optional  
user_type   string  optional  

Example: consequatur

Must be one of:
  • clinical
  • internal
usertype   string  optional  
upper_first_name   string  optional  
upper_last_name   string  optional  
salutation   string  optional  
addresses   string  optional  
personas   string  optional  
tags   object[]  optional  
id   integer   

The id of an existing record in the tags table. Example: 17

caseload   integer  optional  

Must be at least 0. Example: 45

payee_type   string  optional  

Example: consequatur

Must be one of:
  • independent_contractor_individual
  • independent_contractor_company
  • employee
employment_type   string  optional  

Example: consequatur

Must be one of:
  • w2_full_time
  • 1099_contractor
status   string  optional  

Example: consequatur

compensation_type   string  optional  

Example: consequatur

Must be one of:
  • salary
  • hourly
  • piece_work
pay_period   string  optional  

Example: consequatur

Must be one of:
  • monthly
  • semi_monthly
deduct_drive_time   boolean  optional  

Example: false

professional_designations   string[]  optional  
id   integer  optional  

The id of an existing record in the professional_designations table. Example: 17

code   string  optional  

The code of an existing record in the professional_designations table. Example: consequatur

obtained_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

phones   object[]  optional  
number   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

type   string  optional  

Example: work

Must be one of:
  • main
  • home
  • work
  • mobile

Create a new user from the dashboard with Auth0-first workflow.

requires authentication

This endpoint creates the user in Auth0 first (sending invite email), then creates the database record with the returned auth0_id. If the database creation fails, the Auth0 user is automatically deleted (rollback).

Access Requirements:

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/invite" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_id\": 17,
    \"email\": \"carolyne.luettgen@example.org\",
    \"legal_first_name\": \"fuudtdsufvyvddqamniih\",
    \"legal_last_name\": \"fqcoynlazghdtqtqxbajw\",
    \"name\": \"bpilpmufinllwloauydls\",
    \"preferred_first_name\": \"msjuryvojcybzvrbyickz\",
    \"preferred_last_name\": \"nkygloigmkwxphlvazjrc\",
    \"date_of_birth\": \"2026-05-14T17:42:31\",
    \"ssn\": \"consequatur\",
    \"usertype\": \"consequatur\",
    \"status\": \"consequatur\",
    \"phone\": \"consequatur\",
    \"role\": {
        \"id\": 17
    },
    \"payee_type\": \"consequatur\",
    \"employment_type\": \"consequatur\",
    \"compensation_type\": \"consequatur\",
    \"pay_period\": \"consequatur\",
    \"deduct_drive_time\": true,
    \"phones\": [
        {
            \"number\": \"consequatur\",
            \"type\": \"home\",
            \"sms\": false
        }
    ],
    \"emails\": [
        {
            \"address\": \"mqeopfuudtdsufvyvddqa\",
            \"type\": \"personal\"
        }
    ],
    \"tags\": [
        {
            \"id\": 17
        }
    ],
    \"roles\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/invite"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "client_id": 17,
    "email": "carolyne.luettgen@example.org",
    "legal_first_name": "fuudtdsufvyvddqamniih",
    "legal_last_name": "fqcoynlazghdtqtqxbajw",
    "name": "bpilpmufinllwloauydls",
    "preferred_first_name": "msjuryvojcybzvrbyickz",
    "preferred_last_name": "nkygloigmkwxphlvazjrc",
    "date_of_birth": "2026-05-14T17:42:31",
    "ssn": "consequatur",
    "usertype": "consequatur",
    "status": "consequatur",
    "phone": "consequatur",
    "role": {
        "id": 17
    },
    "payee_type": "consequatur",
    "employment_type": "consequatur",
    "compensation_type": "consequatur",
    "pay_period": "consequatur",
    "deduct_drive_time": true,
    "phones": [
        {
            "number": "consequatur",
            "type": "home",
            "sms": false
        }
    ],
    "emails": [
        {
            "address": "mqeopfuudtdsufvyvddqa",
            "type": "personal"
        }
    ],
    "tags": [
        {
            "id": 17
        }
    ],
    "roles": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/users/invite

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

client_id   integer  optional  

The id of an existing record in the clients table. Example: 17

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: carolyne.luettgen@example.org

legal_first_name   string  optional  

This field is required when preferred_first_name is not present. Must not be greater than 255 characters. Example: fuudtdsufvyvddqamniih

legal_last_name   string  optional  

This field is required when preferred_last_name is not present. Must not be greater than 255 characters. Example: fqcoynlazghdtqtqxbajw

name   string  optional  

Must not be greater than 255 characters. Example: bpilpmufinllwloauydls

preferred_first_name   string  optional  

Must not be greater than 255 characters. Example: msjuryvojcybzvrbyickz

preferred_last_name   string  optional  

Must not be greater than 255 characters. Example: nkygloigmkwxphlvazjrc

date_of_birth   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

ssn   string  optional  

Example: consequatur

usertype   string  optional  

Example: consequatur

Must be one of:
  • clinical
  • internal
status   string  optional  

Example: consequatur

phone   string  optional  

Example: consequatur

phones   object[]  optional  
number   string  optional  

This field is required when phones is present. Example: consequatur

type   string  optional  

Example: home

Must be one of:
  • main
  • home
  • work
  • mobile
sms   boolean  optional  

Example: false

emails   object[]  optional  
address   string  optional  

This field is required when emails is present. Must be a valid email address. Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

type   string  optional  

Example: personal

Must be one of:
  • main
  • personal
  • work
  • secondary
addresses   object  optional  
tags   object[]  optional  
id   integer   

The id of an existing record in the tags table. Example: 17

roles   object[]  optional  
id   integer  optional  

This field is required when roles is present. The id of an existing record in the roles table. Example: 17

role   object  optional  
id   integer  optional  

This field is required when role is present. The id of an existing record in the roles table. Example: 17

payee_type   string  optional  

Example: consequatur

Must be one of:
  • independent_contractor_individual
  • independent_contractor_company
  • employee
employment_type   string  optional  

Example: consequatur

Must be one of:
  • w2_full_time
  • 1099_contractor
compensation_type   string  optional  

Example: consequatur

Must be one of:
  • salary
  • hourly
  • piece_work
pay_period   string  optional  

Example: consequatur

Must be one of:
  • monthly
  • semi_monthly
deduct_drive_time   boolean  optional  

Example: true

professional_designations   string[]  optional  
id   integer  optional  

The id of an existing record in the professional_designations table. Example: 17

code   string  optional  

The code of an existing record in the professional_designations table. Example: consequatur

obtained_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

GET api/users

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"email\": \"kunde.eloisa@example.com\",
    \"phone\": \"hfqcoynlazghdtqtq\",
    \"case_id\": 17,
    \"tag_id\": [
        17
    ],
    \"tag_category_id\": 17,
    \"tag_type\": \"mqeopfuudtdsufvyvddqa\",
    \"case_load\": true,
    \"sort_by\": \"city\",
    \"sort_order\": \"asc\",
    \"page\": 45,
    \"per_page\": 13,
    \"limit\": 8,
    \"offset\": 30,
    \"role_id\": 17,
    \"role_ids\": [
        17
    ],
    \"role_names\": [
        \"mqeopfuudtdsufvyvddqa\"
    ],
    \"case_assignment\": false,
    \"has_client\": false,
    \"internal_only\": false,
    \"status\": [
        \"standby\"
    ],
    \"domain\": [
        \"Client Services\"
    ],
    \"filter_mode\": \"or\",
    \"valid_license\": false,
    \"work_status\": [
        \"Training\"
    ],
    \"city\": \"mniihfqcoynlazghdtqtq\",
    \"state\": \"xb\",
    \"zip\": \"ajwbpilpm\",
    \"first_name\": \"ufinllwloauydlsmsjury\",
    \"last_name\": \"vojcybzvrbyickznkyglo\",
    \"middle_name\": \"igmkwxphlvazjrcnfbaqy\",
    \"address\": \"wuxhgjjmzuxjubqouzswi\",
    \"capability\": \"wxtrkimfcatbxspzmrazs\",
    \"periscope_id\": 63,
    \"payee_type\": \"independent_contractor_individual\",
    \"compensation_type\": \"salary\",
    \"pay_period\": \"monthly\",
    \"direct_deposit\": true,
    \"account_type\": \"HR\",
    \"document_types\": \"oyjpxmqesedyghenqcopw\",
    \"document_expiration_start\": \"2026-05-14T17:42:31\",
    \"document_expiration_end\": \"2026-05-14T17:42:31\",
    \"context\": \"assessor\",
    \"filters\": {
        \"logic\": \"AND\"
    },
    \"licenses\": [
        {
            \"id\": 17
        }
    ],
    \"professions\": [
        {
            \"id\": 17
        }
    ],
    \"trainings\": [
        {
            \"id\": 17
        }
    ],
    \"request_types\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "email": "kunde.eloisa@example.com",
    "phone": "hfqcoynlazghdtqtq",
    "case_id": 17,
    "tag_id": [
        17
    ],
    "tag_category_id": 17,
    "tag_type": "mqeopfuudtdsufvyvddqa",
    "case_load": true,
    "sort_by": "city",
    "sort_order": "asc",
    "page": 45,
    "per_page": 13,
    "limit": 8,
    "offset": 30,
    "role_id": 17,
    "role_ids": [
        17
    ],
    "role_names": [
        "mqeopfuudtdsufvyvddqa"
    ],
    "case_assignment": false,
    "has_client": false,
    "internal_only": false,
    "status": [
        "standby"
    ],
    "domain": [
        "Client Services"
    ],
    "filter_mode": "or",
    "valid_license": false,
    "work_status": [
        "Training"
    ],
    "city": "mniihfqcoynlazghdtqtq",
    "state": "xb",
    "zip": "ajwbpilpm",
    "first_name": "ufinllwloauydlsmsjury",
    "last_name": "vojcybzvrbyickznkyglo",
    "middle_name": "igmkwxphlvazjrcnfbaqy",
    "address": "wuxhgjjmzuxjubqouzswi",
    "capability": "wxtrkimfcatbxspzmrazs",
    "periscope_id": 63,
    "payee_type": "independent_contractor_individual",
    "compensation_type": "salary",
    "pay_period": "monthly",
    "direct_deposit": true,
    "account_type": "HR",
    "document_types": "oyjpxmqesedyghenqcopw",
    "document_expiration_start": "2026-05-14T17:42:31",
    "document_expiration_end": "2026-05-14T17:42:31",
    "context": "assessor",
    "filters": {
        "logic": "AND"
    },
    "licenses": [
        {
            "id": 17
        }
    ],
    "professions": [
        {
            "id": 17
        }
    ],
    "trainings": [
        {
            "id": 17
        }
    ],
    "request_types": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

email   string  optional  

Must not be greater than 255 characters. Example: kunde.eloisa@example.com

phone   string  optional  

Must not be greater than 20 characters. Example: hfqcoynlazghdtqtq

case_id   integer  optional  

The id of an existing record in the cases table. Example: 17

tag_id   integer[]  optional  

The id of an existing record in the tags table.

tag_category_id   integer  optional  

The id of an existing record in the tag_categories table. Example: 17

tag_type   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

case_load   boolean  optional  

Example: true

sort_by   string  optional  

Example: city

Must be one of:
  • name
  • email
  • created_at
  • updated_at
  • caseload
  • start_date
  • last_day_of_work
  • legal_first_name
  • legal_last_name
  • preferred_first_name
  • preferred_last_name
  • work_status
  • status
  • role
  • city
  • state
  • zip
  • travel_distance_miles
  • travel_duration_seconds
sort_order   string  optional  

Example: asc

Must be one of:
  • asc
  • desc
page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 13

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 8

offset   integer  optional  

Must be at least 0. Example: 30

licenses   object[]  optional  
id   integer  optional  

The id of an existing record in the licenses table. Example: 17

professions   object[]  optional  
id   integer  optional  

The id of an existing record in the expertise_areas table. Example: 17

trainings   object[]  optional  
id   integer  optional  

The id of an existing record in the credentials table. Example: 17

request_types   object[]  optional  
id   integer  optional  

The id of an existing record in the case_types table. Example: 17

role_id   integer  optional  

The id of an existing record in the roles table. Example: 17

role_ids   integer[]  optional  

The id of an existing record in the roles table.

role_names   string[]  optional  

Must not be greater than 255 characters.

case_assignment   boolean  optional  

Example: false

has_client   boolean  optional  

Example: false

internal_only   boolean  optional  

Example: false

status   string[]  optional  
Must be one of:
  • setup
  • pending
  • training
  • active
  • clinical_hold
  • standby
  • deactivated
domain   string[]  optional  
Must be one of:
  • clinical
  • Clinical
  • client_services
  • Client Services
  • finance
  • Finance
  • human_resources
  • Human Resources
  • HR
  • engineering
  • Engineering
  • executive_suite
  • Executive Suite
  • Executive
  • client
  • Client
filter_mode   string  optional  

Example: or

Must be one of:
  • and
  • or
valid_license   boolean  optional  

Example: false

work_status   string[]  optional  
Must be one of:
  • Training
  • Active
  • Pending
  • Disabled
city   string  optional  

Must not be greater than 100 characters. Example: mniihfqcoynlazghdtqtq

state   string  optional  

Must be 2 characters. Example: xb

zip   string  optional  

Must not be greater than 10 characters. Example: ajwbpilpm

first_name   string  optional  

Must not be greater than 255 characters. Example: ufinllwloauydlsmsjury

last_name   string  optional  

Must not be greater than 255 characters. Example: vojcybzvrbyickznkyglo

middle_name   string  optional  

Must not be greater than 255 characters. Example: igmkwxphlvazjrcnfbaqy

address   string  optional  

Must not be greater than 500 characters. Example: wuxhgjjmzuxjubqouzswi

capability   string  optional  

Must not be greater than 255 characters. Example: wxtrkimfcatbxspzmrazs

periscope_id   integer  optional  

Must be at least 1. Example: 63

payee_type   string  optional  

Example: independent_contractor_individual

Must be one of:
  • independent_contractor_individual
  • independent_contractor_company
  • employee
compensation_type   string  optional  

Example: salary

Must be one of:
  • salary
  • hourly
  • piece_work
pay_period   string  optional  

Example: monthly

Must be one of:
  • monthly
  • semi_monthly
direct_deposit   boolean  optional  

Example: true

account_type   string  optional  

Example: HR

Must be one of:
  • clinical
  • Clinical
  • client_services
  • Client Services
  • finance
  • Finance
  • human_resources
  • Human Resources
  • HR
  • engineering
  • Engineering
  • executive_suite
  • Executive Suite
  • Executive
  • client
  • Client
document_types   string  optional  

Must not be greater than 255 characters. Example: oyjpxmqesedyghenqcopw

document_expiration_start   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

document_expiration_end   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

context   string  optional  

Example: assessor

Must be one of:
  • assessor
  • consultant
filters   object  optional  
logic   string  optional  

This field is required when filters is present. Example: AND

Must be one of:
  • AND
  • OR
conditions   object  optional  

This field is required when filters is present. Must have at least 1 items.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"email\": \"kunde.eloisa@example.com\",
    \"phone\": \"hfqcoynlazghdtqtq\",
    \"case_id\": 17,
    \"tag_id\": [
        17
    ],
    \"tag_category_id\": 17,
    \"tag_type\": \"mqeopfuudtdsufvyvddqa\",
    \"case_load\": false,
    \"sort_by\": \"city\",
    \"sort_order\": \"asc\",
    \"page\": 45,
    \"per_page\": 13,
    \"limit\": 8,
    \"offset\": 30,
    \"role_id\": 17,
    \"role_ids\": [
        17
    ],
    \"role_names\": [
        \"mqeopfuudtdsufvyvddqa\"
    ],
    \"case_assignment\": true,
    \"has_client\": true,
    \"internal_only\": false,
    \"status\": [
        \"pending\"
    ],
    \"domain\": [
        \"clinical\"
    ],
    \"filter_mode\": \"and\",
    \"valid_license\": true,
    \"work_status\": [
        \"Active\"
    ],
    \"city\": \"mniihfqcoynlazghdtqtq\",
    \"state\": \"xb\",
    \"zip\": \"ajwbpilpm\",
    \"first_name\": \"ufinllwloauydlsmsjury\",
    \"last_name\": \"vojcybzvrbyickznkyglo\",
    \"middle_name\": \"igmkwxphlvazjrcnfbaqy\",
    \"address\": \"wuxhgjjmzuxjubqouzswi\",
    \"capability\": \"wxtrkimfcatbxspzmrazs\",
    \"periscope_id\": 63,
    \"payee_type\": \"employee\",
    \"compensation_type\": \"piece_work\",
    \"pay_period\": \"monthly\",
    \"direct_deposit\": true,
    \"account_type\": \"executive_suite\",
    \"document_types\": \"oyjpxmqesedyghenqcopw\",
    \"document_expiration_start\": \"2026-05-14T17:42:31\",
    \"document_expiration_end\": \"2026-05-14T17:42:31\",
    \"context\": \"consultant\",
    \"filters\": {
        \"logic\": \"OR\"
    },
    \"licenses\": [
        {
            \"id\": 17
        }
    ],
    \"professions\": [
        {
            \"id\": 17
        }
    ],
    \"trainings\": [
        {
            \"id\": 17
        }
    ],
    \"request_types\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/search"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "email": "kunde.eloisa@example.com",
    "phone": "hfqcoynlazghdtqtq",
    "case_id": 17,
    "tag_id": [
        17
    ],
    "tag_category_id": 17,
    "tag_type": "mqeopfuudtdsufvyvddqa",
    "case_load": false,
    "sort_by": "city",
    "sort_order": "asc",
    "page": 45,
    "per_page": 13,
    "limit": 8,
    "offset": 30,
    "role_id": 17,
    "role_ids": [
        17
    ],
    "role_names": [
        "mqeopfuudtdsufvyvddqa"
    ],
    "case_assignment": true,
    "has_client": true,
    "internal_only": false,
    "status": [
        "pending"
    ],
    "domain": [
        "clinical"
    ],
    "filter_mode": "and",
    "valid_license": true,
    "work_status": [
        "Active"
    ],
    "city": "mniihfqcoynlazghdtqtq",
    "state": "xb",
    "zip": "ajwbpilpm",
    "first_name": "ufinllwloauydlsmsjury",
    "last_name": "vojcybzvrbyickznkyglo",
    "middle_name": "igmkwxphlvazjrcnfbaqy",
    "address": "wuxhgjjmzuxjubqouzswi",
    "capability": "wxtrkimfcatbxspzmrazs",
    "periscope_id": 63,
    "payee_type": "employee",
    "compensation_type": "piece_work",
    "pay_period": "monthly",
    "direct_deposit": true,
    "account_type": "executive_suite",
    "document_types": "oyjpxmqesedyghenqcopw",
    "document_expiration_start": "2026-05-14T17:42:31",
    "document_expiration_end": "2026-05-14T17:42:31",
    "context": "consultant",
    "filters": {
        "logic": "OR"
    },
    "licenses": [
        {
            "id": 17
        }
    ],
    "professions": [
        {
            "id": 17
        }
    ],
    "trainings": [
        {
            "id": 17
        }
    ],
    "request_types": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Export users to CSV.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"email\": \"kunde.eloisa@example.com\",
    \"phone\": \"hfqcoynlazghdtqtq\",
    \"case_id\": 17,
    \"tag_id\": [
        17
    ],
    \"tag_category_id\": 17,
    \"tag_type\": \"mqeopfuudtdsufvyvddqa\",
    \"case_load\": false,
    \"sort_by\": \"state\",
    \"sort_order\": \"desc\",
    \"page\": 45,
    \"per_page\": 13,
    \"limit\": 8,
    \"offset\": 30,
    \"role_id\": 17,
    \"role_ids\": [
        17
    ],
    \"role_names\": [
        \"mqeopfuudtdsufvyvddqa\"
    ],
    \"case_assignment\": false,
    \"has_client\": false,
    \"internal_only\": false,
    \"status\": [
        \"standby\"
    ],
    \"domain\": [
        \"Engineering\"
    ],
    \"filter_mode\": \"or\",
    \"valid_license\": true,
    \"work_status\": [
        \"Active\"
    ],
    \"city\": \"mniihfqcoynlazghdtqtq\",
    \"state\": \"xb\",
    \"zip\": \"ajwbpilpm\",
    \"first_name\": \"ufinllwloauydlsmsjury\",
    \"last_name\": \"vojcybzvrbyickznkyglo\",
    \"middle_name\": \"igmkwxphlvazjrcnfbaqy\",
    \"address\": \"wuxhgjjmzuxjubqouzswi\",
    \"capability\": \"wxtrkimfcatbxspzmrazs\",
    \"periscope_id\": 63,
    \"payee_type\": \"employee\",
    \"compensation_type\": \"salary\",
    \"pay_period\": \"semi_monthly\",
    \"direct_deposit\": true,
    \"account_type\": \"Client Services\",
    \"document_types\": \"oyjpxmqesedyghenqcopw\",
    \"document_expiration_start\": \"2026-05-14T17:42:31\",
    \"document_expiration_end\": \"2026-05-14T17:42:31\",
    \"context\": \"assessor\",
    \"filters\": {
        \"logic\": \"OR\"
    },
    \"fields\": [
        \"vownkbamlnfngefbeilfz\"
    ],
    \"field_order\": [
        \"syuxoezbdtabptcyyerev\"
    ],
    \"licenses\": [
        {
            \"id\": 17
        }
    ],
    \"professions\": [
        {
            \"id\": 17
        }
    ],
    \"trainings\": [
        {
            \"id\": 17
        }
    ],
    \"request_types\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/export"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "email": "kunde.eloisa@example.com",
    "phone": "hfqcoynlazghdtqtq",
    "case_id": 17,
    "tag_id": [
        17
    ],
    "tag_category_id": 17,
    "tag_type": "mqeopfuudtdsufvyvddqa",
    "case_load": false,
    "sort_by": "state",
    "sort_order": "desc",
    "page": 45,
    "per_page": 13,
    "limit": 8,
    "offset": 30,
    "role_id": 17,
    "role_ids": [
        17
    ],
    "role_names": [
        "mqeopfuudtdsufvyvddqa"
    ],
    "case_assignment": false,
    "has_client": false,
    "internal_only": false,
    "status": [
        "standby"
    ],
    "domain": [
        "Engineering"
    ],
    "filter_mode": "or",
    "valid_license": true,
    "work_status": [
        "Active"
    ],
    "city": "mniihfqcoynlazghdtqtq",
    "state": "xb",
    "zip": "ajwbpilpm",
    "first_name": "ufinllwloauydlsmsjury",
    "last_name": "vojcybzvrbyickznkyglo",
    "middle_name": "igmkwxphlvazjrcnfbaqy",
    "address": "wuxhgjjmzuxjubqouzswi",
    "capability": "wxtrkimfcatbxspzmrazs",
    "periscope_id": 63,
    "payee_type": "employee",
    "compensation_type": "salary",
    "pay_period": "semi_monthly",
    "direct_deposit": true,
    "account_type": "Client Services",
    "document_types": "oyjpxmqesedyghenqcopw",
    "document_expiration_start": "2026-05-14T17:42:31",
    "document_expiration_end": "2026-05-14T17:42:31",
    "context": "assessor",
    "filters": {
        "logic": "OR"
    },
    "fields": [
        "vownkbamlnfngefbeilfz"
    ],
    "field_order": [
        "syuxoezbdtabptcyyerev"
    ],
    "licenses": [
        {
            "id": 17
        }
    ],
    "professions": [
        {
            "id": 17
        }
    ],
    "trainings": [
        {
            "id": 17
        }
    ],
    "request_types": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/users/export

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

email   string  optional  

Must not be greater than 255 characters. Example: kunde.eloisa@example.com

phone   string  optional  

Must not be greater than 20 characters. Example: hfqcoynlazghdtqtq

case_id   integer  optional  

The id of an existing record in the cases table. Example: 17

tag_id   integer[]  optional  

The id of an existing record in the tags table.

tag_category_id   integer  optional  

The id of an existing record in the tag_categories table. Example: 17

tag_type   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

case_load   boolean  optional  

Example: false

sort_by   string  optional  

Example: state

Must be one of:
  • name
  • email
  • created_at
  • updated_at
  • caseload
  • start_date
  • last_day_of_work
  • legal_first_name
  • legal_last_name
  • preferred_first_name
  • preferred_last_name
  • work_status
  • status
  • role
  • city
  • state
  • zip
  • travel_distance_miles
  • travel_duration_seconds
sort_order   string  optional  

Example: desc

Must be one of:
  • asc
  • desc
page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 13

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 8

offset   integer  optional  

Must be at least 0. Example: 30

licenses   object[]  optional  
id   integer  optional  

The id of an existing record in the licenses table. Example: 17

professions   object[]  optional  
id   integer  optional  

The id of an existing record in the expertise_areas table. Example: 17

trainings   object[]  optional  
id   integer  optional  

The id of an existing record in the credentials table. Example: 17

request_types   object[]  optional  
id   integer  optional  

The id of an existing record in the case_types table. Example: 17

role_id   integer  optional  

The id of an existing record in the roles table. Example: 17

role_ids   integer[]  optional  

The id of an existing record in the roles table.

role_names   string[]  optional  

Must not be greater than 255 characters.

case_assignment   boolean  optional  

Example: false

has_client   boolean  optional  

Example: false

internal_only   boolean  optional  

Example: false

status   string[]  optional  
Must be one of:
  • setup
  • pending
  • training
  • active
  • clinical_hold
  • standby
  • deactivated
domain   string[]  optional  
Must be one of:
  • clinical
  • Clinical
  • client_services
  • Client Services
  • finance
  • Finance
  • human_resources
  • Human Resources
  • HR
  • engineering
  • Engineering
  • executive_suite
  • Executive Suite
  • Executive
  • client
  • Client
filter_mode   string  optional  

Example: or

Must be one of:
  • and
  • or
valid_license   boolean  optional  

Example: true

work_status   string[]  optional  
Must be one of:
  • Training
  • Active
  • Pending
  • Disabled
city   string  optional  

Must not be greater than 100 characters. Example: mniihfqcoynlazghdtqtq

state   string  optional  

Must be 2 characters. Example: xb

zip   string  optional  

Must not be greater than 10 characters. Example: ajwbpilpm

first_name   string  optional  

Must not be greater than 255 characters. Example: ufinllwloauydlsmsjury

last_name   string  optional  

Must not be greater than 255 characters. Example: vojcybzvrbyickznkyglo

middle_name   string  optional  

Must not be greater than 255 characters. Example: igmkwxphlvazjrcnfbaqy

address   string  optional  

Must not be greater than 500 characters. Example: wuxhgjjmzuxjubqouzswi

capability   string  optional  

Must not be greater than 255 characters. Example: wxtrkimfcatbxspzmrazs

periscope_id   integer  optional  

Must be at least 1. Example: 63

payee_type   string  optional  

Example: employee

Must be one of:
  • independent_contractor_individual
  • independent_contractor_company
  • employee
compensation_type   string  optional  

Example: salary

Must be one of:
  • salary
  • hourly
  • piece_work
pay_period   string  optional  

Example: semi_monthly

Must be one of:
  • monthly
  • semi_monthly
direct_deposit   boolean  optional  

Example: true

account_type   string  optional  

Example: Client Services

Must be one of:
  • clinical
  • Clinical
  • client_services
  • Client Services
  • finance
  • Finance
  • human_resources
  • Human Resources
  • HR
  • engineering
  • Engineering
  • executive_suite
  • Executive Suite
  • Executive
  • client
  • Client
document_types   string  optional  

Must not be greater than 255 characters. Example: oyjpxmqesedyghenqcopw

document_expiration_start   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

document_expiration_end   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

context   string  optional  

Example: assessor

Must be one of:
  • assessor
  • consultant
filters   object  optional  
logic   string  optional  

This field is required when filters is present. Example: OR

Must be one of:
  • AND
  • OR
conditions   object  optional  

This field is required when filters is present. Must have at least 1 items.

fields   string[]  optional  

Must not be greater than 255 characters.

field_order   string[]  optional  

Must not be greater than 255 characters.

GET api/users/searchable-fields

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/searchable-fields" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/searchable-fields"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/searchable-fields

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/users/sortable-fields

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/sortable-fields" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/sortable-fields"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/sortable-fields

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/users/{user_id}/compliance-documents

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/compliance-documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/compliance-documents"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/compliance-documents

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

GET api/users/{user_id}/workmarket-expenses

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/workmarket-expenses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/workmarket-expenses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/workmarket-expenses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Get the capabilities assigned to a user.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/capabilities" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/capabilities"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/capabilities

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Assign capabilities to a user.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/capabilities" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"capabilities\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/capabilities"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "capabilities": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/users/{user_id}/capabilities

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

capabilities   object[]   

Must have at least 1 items.
id   integer   

The id of an existing record in the roles table. Example: 17

Remove a capability from a user.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/capabilities/24" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/capabilities/24"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/users/{user_id}/capabilities/{capability_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

capability_id   integer   

The ID of the capability. Example: 24

PATCH api/users/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"email\": \"kunde.eloisa@example.com\",
    \"password\": \"4[*UyPJ\\\"}6\",
    \"caseload\": 26,
    \"legal_first_name\": \"dtqtqxbajwbpilpmufinl\",
    \"legal_last_name\": \"lwloauydlsmsjuryvojcy\",
    \"preferred_first_name\": \"bzvrbyickznkygloigmkw\",
    \"preferred_last_name\": \"xphlvazjrcnfbaqywuxhg\",
    \"date_of_birth\": \"2026-05-14T17:42:31\",
    \"phone\": \"consequatur\",
    \"ssn\": \"mqeopfuudtdsufvyvddqa\",
    \"start_date\": \"2026-05-14T17:42:31\",
    \"work_status\": \"mniihfqcoynlazghdtqtq\",
    \"last_day_of_work\": \"2026-05-14T17:42:31\",
    \"user_type\": \"consequatur\",
    \"upper_first_name\": \"mqeopfuudtdsufvyvddqa\",
    \"upper_last_name\": \"mniihfqcoynlazghdtqtq\",
    \"salutation\": \"xbajwbpilpmufinllwloa\",
    \"payee_type\": \"consequatur\",
    \"employment_type\": \"consequatur\",
    \"status\": \"consequatur\",
    \"compensation_type\": \"consequatur\",
    \"pay_period\": \"consequatur\",
    \"deduct_drive_time\": true,
    \"workmarket_id\": \"lILn\",
    \"phones\": [
        {
            \"number\": \"consequatur\",
            \"type\": \"mobile\"
        }
    ],
    \"emails\": [
        {
            \"address\": \"mqeopfuudtdsufvyvddqa\",
            \"type\": \"main\"
        }
    ],
    \"tags\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "email": "kunde.eloisa@example.com",
    "password": "4[*UyPJ\"}6",
    "caseload": 26,
    "legal_first_name": "dtqtqxbajwbpilpmufinl",
    "legal_last_name": "lwloauydlsmsjuryvojcy",
    "preferred_first_name": "bzvrbyickznkygloigmkw",
    "preferred_last_name": "xphlvazjrcnfbaqywuxhg",
    "date_of_birth": "2026-05-14T17:42:31",
    "phone": "consequatur",
    "ssn": "mqeopfuudtdsufvyvddqa",
    "start_date": "2026-05-14T17:42:31",
    "work_status": "mniihfqcoynlazghdtqtq",
    "last_day_of_work": "2026-05-14T17:42:31",
    "user_type": "consequatur",
    "upper_first_name": "mqeopfuudtdsufvyvddqa",
    "upper_last_name": "mniihfqcoynlazghdtqtq",
    "salutation": "xbajwbpilpmufinllwloa",
    "payee_type": "consequatur",
    "employment_type": "consequatur",
    "status": "consequatur",
    "compensation_type": "consequatur",
    "pay_period": "consequatur",
    "deduct_drive_time": true,
    "workmarket_id": "lILn",
    "phones": [
        {
            "number": "consequatur",
            "type": "mobile"
        }
    ],
    "emails": [
        {
            "address": "mqeopfuudtdsufvyvddqa",
            "type": "main"
        }
    ],
    "tags": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user. Example: 1

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

email   string  optional  

Must be a valid email address. Example: kunde.eloisa@example.com

password   string  optional  

Must be at least 8 characters. Example: 4[*UyPJ"}6

caseload   integer  optional  

Must be at least 0. Example: 26

role   object  optional  
id   string  optional  

The id of an existing record in the roles table.

roles   object[]  optional  
id   string  optional  

The id of an existing record in the roles table.

capabilities   object  optional  
legal_first_name   string  optional  

Must not be greater than 255 characters. Example: dtqtqxbajwbpilpmufinl

legal_last_name   string  optional  

Must not be greater than 255 characters. Example: lwloauydlsmsjuryvojcy

preferred_first_name   string  optional  

Must not be greater than 255 characters. Example: bzvrbyickznkygloigmkw

preferred_last_name   string  optional  

Must not be greater than 255 characters. Example: xphlvazjrcnfbaqywuxhg

date_of_birth   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

phone   string  optional  

Example: consequatur

phones   object[]  optional  
number   string  optional  

Example: consequatur

type   string  optional  

Example: mobile

Must be one of:
  • main
  • home
  • work
  • mobile
emails   object[]  optional  
address   string  optional  

This field is required when emails is present. Must be a valid email address. Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

type   string  optional  

Example: main

Must be one of:
  • main
  • personal
  • work
  • secondary
ssn   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

start_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

startdate   string  optional  
work_status   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

last_day_of_work   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

user_type   string  optional  

Example: consequatur

Must be one of:
  • clinical
  • internal
usertype   string  optional  
upper_first_name   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

upper_last_name   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

salutation   string  optional  

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

addresses   object  optional  
personas   object  optional  
tags   object[]  optional  
id   integer  optional  

The id of an existing record in the tags table. Example: 17

payee_type   string  optional  

Example: consequatur

Must be one of:
  • independent_contractor_individual
  • independent_contractor_company
  • employee
employment_type   string  optional  

Example: consequatur

Must be one of:
  • w2_full_time
  • 1099_contractor
status   string  optional  

Example: consequatur

compensation_type   string  optional  

Example: consequatur

Must be one of:
  • salary
  • hourly
  • piece_work
pay_period   string  optional  

Example: consequatur

Must be one of:
  • monthly
  • semi_monthly
deduct_drive_time   boolean  optional  

Example: true

workmarket_id   string  optional  

Must match the regex /^[a-zA-Z0-9]+$/. Example: lILn

professional_designations   string[]  optional  
id   integer  optional  

The id of an existing record in the professional_designations table. Example: 17

code   string  optional  

The code of an existing record in the professional_designations table. Example: consequatur

obtained_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

GET api/users/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user. Example: 1

DELETE api/users/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the user. Example: 1

GET api/users/{user_id}/visible-clients

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/visible-clients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/visible-clients"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/visible-clients

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

POST api/users/{user_id}/visible-clients

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/visible-clients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"visibleClients\": [
        {
            \"id\": 17,
            \"includeDescendants\": false
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/visible-clients"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "visibleClients": [
        {
            "id": 17,
            "includeDescendants": false
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/users/{user_id}/visible-clients

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

visibleClients   object[]   

Must have at least 1 items.
id   integer   

The id of an existing record in the clients table. Example: 17

includeDescendants   boolean  optional  

Example: false

GET api/users/{user_id}/visible-clients/{client_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/visible-clients/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/visible-clients/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/visible-clients/{client_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

client_id   integer   

The ID of the client. Example: 1

PATCH api/users/{user_id}/visible-clients

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/visible-clients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"visibleClients\": [
        {
            \"id\": 17,
            \"includeDescendants\": false
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/visible-clients"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "visibleClients": [
        {
            "id": 17,
            "includeDescendants": false
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/users/{user_id}/visible-clients

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

visibleClients   object[]   
id   integer   

The id of an existing record in the clients table. Example: 17

includeDescendants   boolean  optional  

Example: false

DELETE api/users/{user_id}/visible-clients/{client_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/visible-clients/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/visible-clients/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/users/{user_id}/visible-clients/{client_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

client_id   integer   

The ID of the client. Example: 1

Display a listing of the user's unavailability records.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/unavailability" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-05-14\",
    \"end_date\": \"2026-05-14\",
    \"include_past\": false,
    \"per_page\": 21
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/unavailability"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "start_date": "2026-05-14",
    "end_date": "2026-05-14",
    "include_past": false,
    "per_page": 21
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/unavailability

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

start_date   string  optional  

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2026-05-14

end_date   string  optional  

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2026-05-14

include_past   boolean  optional  

Example: false

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 21

Store a newly created user unavailability record.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/unavailability" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2020-09-09\",
    \"end_date\": \"2107-06-13\",
    \"type\": \"single_date\",
    \"reason\": \"mqeopfuudtdsufvyvddqa\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/unavailability"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "start_date": "2020-09-09",
    "end_date": "2107-06-13",
    "type": "single_date",
    "reason": "mqeopfuudtdsufvyvddqa"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/users/{user_id}/unavailability

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

start_date   string   

Must be a valid date. Must be a date before or equal to end_date. Example: 2020-09-09

end_date   string   

Must be a valid date. Must be a date after or equal to start_date. Example: 2107-06-13

type   string  optional  

Example: single_date

Must be one of:
  • single_date
  • date_range
reason   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

Update the specified user unavailability record.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/unavailability/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2020-09-09\",
    \"end_date\": \"2107-06-13\",
    \"type\": \"single_date\",
    \"reason\": \"mqeopfuudtdsufvyvddqa\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/unavailability/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "start_date": "2020-09-09",
    "end_date": "2107-06-13",
    "type": "single_date",
    "reason": "mqeopfuudtdsufvyvddqa"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/users/{user_id}/unavailability/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

id   integer   

The ID of the unavailability. Example: 1

Body Parameters

start_date   string  optional  

Must be a valid date. Must be a date before or equal to end_date. Example: 2020-09-09

end_date   string  optional  

Must be a valid date. Must be a date after or equal to start_date. Example: 2107-06-13

type   string  optional  

Example: single_date

Must be one of:
  • single_date
  • date_range
reason   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

Remove the specified user unavailability record.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/unavailability/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/unavailability/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/users/{user_id}/unavailability/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

id   integer   

The ID of the unavailability. Example: 1

GET api/clinician-casework-preferences

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clinician-casework-preferences

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/clinician-casework-preferences

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 17,
    \"client_id\": 17,
    \"preference_flag\": \"Preferred\",
    \"mentor_id\": 17,
    \"caseload\": 45,
    \"assessor_note\": \"consequatur\",
    \"consultant_note\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 17,
    "client_id": 17,
    "preference_flag": "Preferred",
    "mentor_id": 17,
    "caseload": 45,
    "assessor_note": "consequatur",
    "consultant_note": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clinician-casework-preferences

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   integer   

The id of an existing record in the users table. Example: 17

client_id   integer  optional  

The id of an existing record in the clients table. Example: 17

preference_flag   string  optional  

Example: Preferred

Must be one of:
  • Preferred
  • Last Resort
mentor_id   integer  optional  

The id of an existing record in the users table. Example: 17

caseload   integer  optional  

Must be at least 0. Example: 45

assessor_note   string  optional  

Example: consequatur

consultant_note   string  optional  

Example: consequatur

GET api/clinician-casework-preferences/user/{userId}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences/user/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences/user/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clinician-casework-preferences/user/{userId}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

Example: 1

GET api/clinician-casework-preferences/{clinicianCaseworkPreference_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clinician-casework-preferences/{clinicianCaseworkPreference_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicianCaseworkPreference_id   integer   

The ID of the clinicianCaseworkPreference. Example: 1

PATCH api/clinician-casework-preferences/{clinicianCaseworkPreference_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 17,
    \"client_id\": 17,
    \"preference_flag\": \"Last Resort\",
    \"mentor_id\": 17,
    \"caseload\": 45,
    \"assessor_note\": \"consequatur\",
    \"consultant_note\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 17,
    "client_id": 17,
    "preference_flag": "Last Resort",
    "mentor_id": 17,
    "caseload": 45,
    "assessor_note": "consequatur",
    "consultant_note": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/clinician-casework-preferences/{clinicianCaseworkPreference_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicianCaseworkPreference_id   integer   

The ID of the clinicianCaseworkPreference. Example: 1

Body Parameters

user_id   integer  optional  

The id of an existing record in the users table. Example: 17

client_id   integer  optional  

The id of an existing record in the clients table. Example: 17

preference_flag   string  optional  

Example: Last Resort

Must be one of:
  • Preferred
  • Last Resort
mentor_id   integer  optional  

The id of an existing record in the users table. Example: 17

caseload   integer  optional  

Must be at least 0. Example: 45

assessor_note   string  optional  

Example: consequatur

consultant_note   string  optional  

Example: consequatur

DELETE api/clinician-casework-preferences/{clinicianCaseworkPreference_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-casework-preferences/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/clinician-casework-preferences/{clinicianCaseworkPreference_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicianCaseworkPreference_id   integer   

The ID of the clinicianCaseworkPreference. Example: 1

Display a listing of the user's notes.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/notes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/notes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/notes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Display the specified user note.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/notes/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/notes/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/notes/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

id   integer   

The ID of the note. Example: 17

Store a newly created note for the user.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/notes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"note\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/notes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "note": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/users/{user_id}/notes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

note   string   

Must not be greater than 65535 characters. Example: vmqeopfuudtdsufvyvddq

Update the specified user note.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/notes/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"note\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/notes/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "note": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/users/{user_id}/notes/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

id   integer   

The ID of the note. Example: 17

Body Parameters

note   string  optional  

Must not be greater than 65535 characters. Example: vmqeopfuudtdsufvyvddq

Remove the specified user note.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/notes/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/notes/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/users/{user_id}/notes/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

id   integer   

The ID of the note. Example: 17

Display a paginated listing of profile change requests for a user.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/profile-change-requests" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/profile-change-requests"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/profile-change-requests

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Store a newly created profile change request.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/profile-change-requests" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requested_changes\": {
        \"name\": \"vmqeopfuudtdsufvyvddq\",
        \"email\": \"kunde.eloisa@example.com\",
        \"legal_first_name\": \"hfqcoynlazghdtqtqxbaj\",
        \"legal_last_name\": \"wbpilpmufinllwloauydl\",
        \"preferred_first_name\": \"smsjuryvojcybzvrbyick\",
        \"preferred_last_name\": \"znkygloigmkwxphlvazjr\",
        \"date_of_birth\": \"2026-05-14T17:42:31\",
        \"salutation\": \"cnfbaqywuxhgjjmzuxjub\",
        \"status\": \"consequatur\",
        \"mentor_id\": 17,
        \"roles\": [
            {
                \"id\": 17
            }
        ],
        \"emails\": [
            {
                \"address\": \"mqeopfuudtdsufvyvddqa\",
                \"type\": \"secondary\"
            }
        ],
        \"phones\": [
            {
                \"number\": \"mniihfqcoynlazghd\",
                \"sms\": true,
                \"type\": \"mobile\"
            }
        ],
        \"addresses\": [
            {
                \"line_1\": \"tqtqxbajwbpilpmufinll\",
                \"line_2\": \"wloauydlsmsjuryvojcyb\",
                \"city\": \"zvrbyickznkygloigmkwx\",
                \"state\": \"phlvazjrcnfbaqywuxhgj\",
                \"zip\": \"jmzuxjubqouzswiwx\",
                \"county_name\": \"trkimfcatbxspzmrazsro\",
                \"is_primary\": false,
                \"type\": \"shipping\"
            }
        ]
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/profile-change-requests"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "requested_changes": {
        "name": "vmqeopfuudtdsufvyvddq",
        "email": "kunde.eloisa@example.com",
        "legal_first_name": "hfqcoynlazghdtqtqxbaj",
        "legal_last_name": "wbpilpmufinllwloauydl",
        "preferred_first_name": "smsjuryvojcybzvrbyick",
        "preferred_last_name": "znkygloigmkwxphlvazjr",
        "date_of_birth": "2026-05-14T17:42:31",
        "salutation": "cnfbaqywuxhgjjmzuxjub",
        "status": "consequatur",
        "mentor_id": 17,
        "roles": [
            {
                "id": 17
            }
        ],
        "emails": [
            {
                "address": "mqeopfuudtdsufvyvddqa",
                "type": "secondary"
            }
        ],
        "phones": [
            {
                "number": "mniihfqcoynlazghd",
                "sms": true,
                "type": "mobile"
            }
        ],
        "addresses": [
            {
                "line_1": "tqtqxbajwbpilpmufinll",
                "line_2": "wloauydlsmsjuryvojcyb",
                "city": "zvrbyickznkygloigmkwx",
                "state": "phlvazjrcnfbaqywuxhgj",
                "zip": "jmzuxjubqouzswiwx",
                "county_name": "trkimfcatbxspzmrazsro",
                "is_primary": false,
                "type": "shipping"
            }
        ]
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/users/{user_id}/profile-change-requests

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

requested_changes   object   

Must have at least 1 items.
name   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: kunde.eloisa@example.com

legal_first_name   string  optional  

Must not be greater than 255 characters. Example: hfqcoynlazghdtqtqxbaj

legal_last_name   string  optional  

Must not be greater than 255 characters. Example: wbpilpmufinllwloauydl

preferred_first_name   string  optional  

Must not be greater than 255 characters. Example: smsjuryvojcybzvrbyick

preferred_last_name   string  optional  

Must not be greater than 255 characters. Example: znkygloigmkwxphlvazjr

date_of_birth   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

salutation   string  optional  

Must not be greater than 50 characters. Example: cnfbaqywuxhgjjmzuxjub

status   string  optional  

Example: consequatur

Must be one of:
  • setup
  • pending
  • training
  • active
  • clinical_hold
  • standby
  • deactivated
mentor_id   integer  optional  

The id of an existing record in the users table. Example: 17

roles   object[]  optional  
id   integer   

The id of an existing record in the roles table. Example: 17

emails   object[]  optional  

Must have at least 1 items.
address   string   

Must be a valid email address. Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

type   string   

Example: secondary

Must be one of:
  • main
  • personal
  • work
  • secondary
phones   object[]  optional  

Must have at least 1 items.
number   string   

Must not be greater than 20 characters. Example: mniihfqcoynlazghd

sms   boolean  optional  

Example: true

type   string   

Example: mobile

Must be one of:
  • main
  • home
  • work
  • mobile
addresses   object[]  optional  

Must have at least 1 items.
line_1   string   

Must not be greater than 255 characters. Example: tqtqxbajwbpilpmufinll

line_2   string  optional  

Must not be greater than 255 characters. Example: wloauydlsmsjuryvojcyb

city   string   

Must not be greater than 255 characters. Example: zvrbyickznkygloigmkwx

state   string   

Must not be greater than 255 characters. Example: phlvazjrcnfbaqywuxhgj

zip   string   

Must not be greater than 20 characters. Example: jmzuxjubqouzswiwx

county_name   string  optional  

Must not be greater than 255 characters. Example: trkimfcatbxspzmrazsro

is_primary   boolean  optional  

Example: false

type   string   

Example: shipping

Must be one of:
  • home
  • work
  • billing
  • shipping
professional_designations   string[]  optional  
id   integer  optional  

The id of an existing record in the professional_designations table. Example: 17

code   string  optional  

The code of an existing record in the professional_designations table. Example: consequatur

obtained_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

Display the specified profile change request.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/profile-change-requests/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/profile-change-requests/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/profile-change-requests/{profileChangeRequest_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

profileChangeRequest_id   integer   

The ID of the profileChangeRequest. Example: 1

Display a paginated listing of all profile change requests.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/profile-change-requests" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"approved\",
    \"user_id\": 17,
    \"requester_id\": 17,
    \"reviewer_id\": 17,
    \"created_from\": \"2026-05-14\",
    \"created_to\": \"2107-06-13\",
    \"sort_by\": \"status\",
    \"sort_order\": \"desc\",
    \"per_page\": 13,
    \"page\": 56,
    \"limit\": 5,
    \"offset\": 50
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/profile-change-requests"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": "approved",
    "user_id": 17,
    "requester_id": 17,
    "reviewer_id": 17,
    "created_from": "2026-05-14",
    "created_to": "2107-06-13",
    "sort_by": "status",
    "sort_order": "desc",
    "per_page": 13,
    "page": 56,
    "limit": 5,
    "offset": 50
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/profile-change-requests

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

status   string  optional  

Example: approved

Must be one of:
  • pending
  • approved
  • denied
  • cancelled
user_id   integer  optional  

The id of an existing record in the users table. Example: 17

requester_id   integer  optional  

The id of an existing record in the users table. Example: 17

reviewer_id   integer  optional  

The id of an existing record in the users table. Example: 17

created_from   string  optional  

Must be a valid date. Must be a valid date in the format Y-m-d. Example: 2026-05-14

created_to   string  optional  

Must be a valid date. Must be a valid date in the format Y-m-d. Must be a date after or equal to created_from. Example: 2107-06-13

sort_by   string  optional  

Example: status

Must be one of:
  • created_at
  • updated_at
  • status
sort_order   string  optional  

Example: desc

Must be one of:
  • asc
  • desc
per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 13

page   integer  optional  

Must be at least 1. Example: 56

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 5

offset   integer  optional  

Must be at least 0. Example: 50

Display the specified profile change request by ID.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/profile-change-requests/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/profile-change-requests/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/profile-change-requests/{profileChangeRequest_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

profileChangeRequest_id   integer   

The ID of the profileChangeRequest. Example: 1

Approve a profile change request.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/profile-change-requests/1/approve" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reviewer_notes\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/profile-change-requests/1/approve"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reviewer_notes": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/profile-change-requests/{profileChangeRequest_id}/approve

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

profileChangeRequest_id   integer   

The ID of the profileChangeRequest. Example: 1

Body Parameters

reviewer_notes   string  optional  

Must not be greater than 1000 characters. Example: vmqeopfuudtdsufvyvddq

Cancel a profile change request.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/profile-change-requests/1/cancel" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/profile-change-requests/1/cancel"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH api/profile-change-requests/{profileChangeRequest_id}/cancel

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

profileChangeRequest_id   integer   

The ID of the profileChangeRequest. Example: 1

Deny a profile change request.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/profile-change-requests/1/deny" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reviewer_notes\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/profile-change-requests/1/deny"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reviewer_notes": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/profile-change-requests/{profileChangeRequest_id}/deny

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

profileChangeRequest_id   integer   

The ID of the profileChangeRequest. Example: 1

Body Parameters

reviewer_notes   string  optional  

Must not be greater than 1000 characters. Example: vmqeopfuudtdsufvyvddq

Display a listing of document change requests for a user.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/document-change-requests" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/document-change-requests"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/document-change-requests

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Store a newly created document change request.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/document-change-requests" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "action_type=update"\
    --form "document_id=17"\
    --form "requested_changes[title]=mqeopfuudtdsufvyvddqa"\
    --form "requested_changes[document_label]=mniihfqcoynlazghdtqtq"\
    --form "requested_changes[document_type]=xbajwbpilpmufinllwloa"\
    --form "requested_changes[state]=uydlsmsjuryvojcybzvrb"\
    --form "requested_changes[expiration_date]=2026-05-14T17:42:31"\
    --form "requested_changes[description]=Dolores dolorum amet iste laborum eius est dolor."\
    --form "file=@/tmp/phpeqrLzE" 
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/document-change-requests"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('action_type', 'update');
body.append('document_id', '17');
body.append('requested_changes[title]', 'mqeopfuudtdsufvyvddqa');
body.append('requested_changes[document_label]', 'mniihfqcoynlazghdtqtq');
body.append('requested_changes[document_type]', 'xbajwbpilpmufinllwloa');
body.append('requested_changes[state]', 'uydlsmsjuryvojcybzvrb');
body.append('requested_changes[expiration_date]', '2026-05-14T17:42:31');
body.append('requested_changes[description]', 'Dolores dolorum amet iste laborum eius est dolor.');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request   

POST api/users/{user_id}/document-change-requests

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Body Parameters

action_type   string   

Example: update

Must be one of:
  • create
  • update
  • delete
document_id   integer  optional  

This field is required when action_type is update or delete. The id of an existing record in the documents table. Example: 17

file   file  optional  

This field is required when action_type is create. Must be a file. Must not be greater than 10240 kilobytes. Example: /tmp/phpeqrLzE

requested_changes   object  optional  

This field is required when action_type is create or update.
title   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

document_label   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

document_type   string  optional  

Must not be greater than 100 characters. Example: xbajwbpilpmufinllwloa

state   string  optional  

Must not be greater than 50 characters. Example: uydlsmsjuryvojcybzvrb

expiration_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

Display the specified document change request.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/document-change-requests/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/document-change-requests/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/document-change-requests/{documentChangeRequest_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

documentChangeRequest_id   integer   

The ID of the documentChangeRequest. Example: 1

Update the specified document change request.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/document-change-requests/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "action_type=create"\
    --form "requested_changes[title]=vmqeopfuudtdsufvyvddq"\
    --form "requested_changes[document_label]=amniihfqcoynlazghdtqt"\
    --form "requested_changes[document_type]=qxbajwbpilpmufinllwlo"\
    --form "requested_changes[state]=auydlsmsjuryvojcybzvr"\
    --form "requested_changes[expiration_date]=2026-05-14T17:42:31"\
    --form "requested_changes[description]=Dolores dolorum amet iste laborum eius est dolor."\
    --form "file=@/tmp/phpQQvXVo" 
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/document-change-requests/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('action_type', 'create');
body.append('requested_changes[title]', 'vmqeopfuudtdsufvyvddq');
body.append('requested_changes[document_label]', 'amniihfqcoynlazghdtqt');
body.append('requested_changes[document_type]', 'qxbajwbpilpmufinllwlo');
body.append('requested_changes[state]', 'auydlsmsjuryvojcybzvr');
body.append('requested_changes[expiration_date]', '2026-05-14T17:42:31');
body.append('requested_changes[description]', 'Dolores dolorum amet iste laborum eius est dolor.');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "PATCH",
    headers,
    body,
}).then(response => response.json());

Request   

PATCH api/users/{user_id}/document-change-requests/{documentChangeRequest_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

documentChangeRequest_id   integer   

The ID of the documentChangeRequest. Example: 1

Body Parameters

action_type   string  optional  

Example: create

Must be one of:
  • create
  • update
  • delete
file   file  optional  

Must be a file. Must not be greater than 10240 kilobytes. Example: /tmp/phpQQvXVo

requested_changes   object  optional  
title   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

document_label   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

document_type   string  optional  

Must not be greater than 100 characters. Example: qxbajwbpilpmufinllwlo

state   string  optional  

Must not be greater than 50 characters. Example: auydlsmsjuryvojcybzvr

expiration_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

Remove the specified document change request.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/document-change-requests/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/document-change-requests/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/users/{user_id}/document-change-requests/{documentChangeRequest_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

documentChangeRequest_id   integer   

The ID of the documentChangeRequest. Example: 1

Return all blackout/unavailability dates for a specific user.

requires authentication

Used by the Clinician Profile tab to display unavailability.

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/blackouts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/users/1/blackouts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/users/{user_id}/blackouts

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   integer   

The ID of the user. Example: 1

Display a paginated listing of all document change requests.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/document-change-requests" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"denied\",
    \"request_type\": \"update\",
    \"user_id\": 17,
    \"requested_by\": 17,
    \"reviewed_by\": 17,
    \"document_id\": 17,
    \"created_from\": \"2026-05-14T17:42:31\",
    \"created_to\": \"2026-05-14T17:42:31\",
    \"sort_by\": \"request_type\",
    \"sort_order\": \"desc\",
    \"per_page\": 13
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/document-change-requests"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": "denied",
    "request_type": "update",
    "user_id": 17,
    "requested_by": 17,
    "reviewed_by": 17,
    "document_id": 17,
    "created_from": "2026-05-14T17:42:31",
    "created_to": "2026-05-14T17:42:31",
    "sort_by": "request_type",
    "sort_order": "desc",
    "per_page": 13
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/document-change-requests

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

status   string  optional  

Example: denied

Must be one of:
  • pending
  • approved
  • denied
  • cancelled
request_type   string  optional  

Example: update

Must be one of:
  • create
  • update
  • delete
user_id   integer  optional  

The id of an existing record in the users table. Example: 17

requested_by   integer  optional  

The id of an existing record in the users table. Example: 17

reviewed_by   integer  optional  

The id of an existing record in the users table. Example: 17

document_id   integer  optional  

The id of an existing record in the documents table. Example: 17

created_from   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

created_to   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:31

sort_by   string  optional  

Example: request_type

Must be one of:
  • created_at
  • updated_at
  • status
  • request_type
sort_order   string  optional  

Example: desc

Must be one of:
  • asc
  • desc
per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 13

Display the specified document change request by ID.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/document-change-requests/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/document-change-requests/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/document-change-requests/{documentChangeRequest_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentChangeRequest_id   integer   

The ID of the documentChangeRequest. Example: 1

Approve a document change request.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/document-change-requests/1/approve" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reviewer_notes\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/document-change-requests/1/approve"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reviewer_notes": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/document-change-requests/{documentChangeRequest_id}/approve

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentChangeRequest_id   integer   

The ID of the documentChangeRequest. Example: 1

Body Parameters

reviewer_notes   string  optional  

Must not be greater than 1000 characters. Example: vmqeopfuudtdsufvyvddq

Deny a document change request.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/document-change-requests/1/deny" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"denial_reason\": \"vmqeopfuudtdsufvyvddq\",
    \"reviewer_notes\": \"amniihfqcoynlazghdtqt\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/document-change-requests/1/deny"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "denial_reason": "vmqeopfuudtdsufvyvddq",
    "reviewer_notes": "amniihfqcoynlazghdtqt"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/document-change-requests/{documentChangeRequest_id}/deny

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentChangeRequest_id   integer   

The ID of the documentChangeRequest. Example: 1

Body Parameters

denial_reason   string   

Must be at least 10 characters. Must not be greater than 1000 characters. Example: vmqeopfuudtdsufvyvddq

reviewer_notes   string  optional  

Must not be greater than 1000 characters. Example: amniihfqcoynlazghdtqt

Cancel a document change request.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/document-change-requests/1/cancel" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/document-change-requests/1/cancel"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH api/document-change-requests/{documentChangeRequest_id}/cancel

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentChangeRequest_id   integer   

The ID of the documentChangeRequest. Example: 1

GET api/roles

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/roles

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"user_type\": \"consequatur\",
    \"permissions\": [
        17
    ],
    \"permission_groups\": [
        17
    ],
    \"api_id\": \"consequatur\",
    \"persona_abbreviation\": \"consequatur\",
    \"persona_type\": \"consequatur\",
    \"is_capability\": true,
    \"is_specialty\": false,
    \"case_assignment\": false,
    \"bypasses_document_approval\": true,
    \"visibility_scope\": \"consequatur\",
    \"notes\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "user_type": "consequatur",
    "permissions": [
        17
    ],
    "permission_groups": [
        17
    ],
    "api_id": "consequatur",
    "persona_abbreviation": "consequatur",
    "persona_type": "consequatur",
    "is_capability": true,
    "is_specialty": false,
    "case_assignment": false,
    "bypasses_document_approval": true,
    "visibility_scope": "consequatur",
    "notes": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

user_type   string   

Example: consequatur

Must be one of:
  • Clinical
  • Client Services
  • Finance
  • Human Resources
  • Engineering
  • Executive Suite
  • Client
permissions   integer[]  optional  
permission_groups   integer[]  optional  
api_id   string  optional  

Example: consequatur

persona_abbreviation   string  optional  

Example: consequatur

persona_type   string  optional  

Example: consequatur

is_capability   boolean  optional  

Example: true

is_specialty   boolean  optional  

Example: false

case_assignment   boolean  optional  

Example: false

bypasses_document_approval   boolean  optional  

Example: true

visibility_scope   string  optional  

Example: consequatur

notes   string  optional  

Example: consequatur

GET api/roles/capabilities

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/capabilities" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search\": \"vmqeopfuudtdsufvyvddq\",
    \"sort_by\": \"last_updated_by\",
    \"sort_order\": \"asc\",
    \"page\": 2,
    \"per_page\": 13
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/capabilities"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search": "vmqeopfuudtdsufvyvddq",
    "sort_by": "last_updated_by",
    "sort_order": "asc",
    "page": 2,
    "per_page": 13
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/roles/capabilities

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

search   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

sort_by   string  optional  

Example: last_updated_by

Must be one of:
  • name
  • domain
  • last_updated_at
  • last_updated_by
sort_order   string  optional  

Example: asc

Must be one of:
  • asc
  • desc
page   integer  optional  

Must be at least 1. Example: 2

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 13

POST api/roles/capabilities

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/capabilities" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\",
    \"domains\": [
        \"Engineering\"
    ],
    \"permissions\": [
        17
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/capabilities"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit.",
    "domains": [
        "Engineering"
    ],
    "permissions": [
        17
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/roles/capabilities

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 2000 characters. Example: Dolores molestias ipsam sit.

domains   string[]   
Must be one of:
  • Clinical
  • Client Services
  • Finance
  • Human Resources
  • Engineering
  • Executive Suite
  • Client
permissions   integer[]  optional  

The id of an existing record in the permissions table.

GET api/roles/capabilities/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/capabilities/24" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/capabilities/24"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/roles/capabilities/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the capability. Example: 24

PATCH api/roles/capabilities/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/capabilities/24" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"version\": 73,
    \"name\": \"mqeopfuudtdsufvyvddqa\",
    \"description\": \"Molestias ipsam sit veniam sed fuga aspernatur.\",
    \"domains\": [
        \"Client\"
    ],
    \"permissions\": [
        17
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/capabilities/24"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "version": 73,
    "name": "mqeopfuudtdsufvyvddqa",
    "description": "Molestias ipsam sit veniam sed fuga aspernatur.",
    "domains": [
        "Client"
    ],
    "permissions": [
        17
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/roles/capabilities/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the capability. Example: 24

Body Parameters

version   integer   

Must be at least 1. Example: 73

name   string   

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

description   string  optional  

Must not be greater than 2000 characters. Example: Molestias ipsam sit veniam sed fuga aspernatur.

domains   string[]   
Must be one of:
  • Clinical
  • Client Services
  • Finance
  • Human Resources
  • Engineering
  • Executive Suite
  • Client
permissions   integer[]  optional  

The id of an existing record in the permissions table.

DELETE api/roles/capabilities/{capability_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/capabilities/24" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/capabilities/24"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/roles/capabilities/{capability_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

capability_id   integer   

The ID of the capability. Example: 24

GET api/roles/domains

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/domains" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/domains"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/roles/domains

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/roles/grouped-by-domain

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/grouped-by-domain" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/grouped-by-domain"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/roles/grouped-by-domain

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/roles/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/roles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the role. Example: 24

Get all users assigned to a role.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/roles/{role_id}/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   integer   

The ID of the role. Example: 24

PATCH api/roles/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"version\": 73,
    \"name\": \"mqeopfuudtdsufvyvddqa\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"user_type\": \"consequatur\",
    \"permissions\": [
        17
    ],
    \"permission_groups\": [
        17
    ],
    \"api_id\": \"consequatur\",
    \"persona_abbreviation\": \"consequatur\",
    \"persona_type\": \"consequatur\",
    \"is_capability\": true,
    \"is_specialty\": true,
    \"case_assignment\": false,
    \"bypasses_document_approval\": true,
    \"visibility_scope\": \"consequatur\",
    \"notes\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "version": 73,
    "name": "mqeopfuudtdsufvyvddqa",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "user_type": "consequatur",
    "permissions": [
        17
    ],
    "permission_groups": [
        17
    ],
    "api_id": "consequatur",
    "persona_abbreviation": "consequatur",
    "persona_type": "consequatur",
    "is_capability": true,
    "is_specialty": true,
    "case_assignment": false,
    "bypasses_document_approval": true,
    "visibility_scope": "consequatur",
    "notes": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/roles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the role. Example: 24

Body Parameters

version   integer   

Must be at least 1. Example: 73

name   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

user_type   string  optional  

Example: consequatur

Must be one of:
  • Clinical
  • Client Services
  • Finance
  • Human Resources
  • Engineering
  • Executive Suite
  • Client
permissions   integer[]  optional  
permission_groups   integer[]  optional  
api_id   string  optional  

Example: consequatur

persona_abbreviation   string  optional  

Example: consequatur

persona_type   string  optional  

Example: consequatur

is_capability   boolean  optional  

Example: true

is_specialty   boolean  optional  

Example: true

case_assignment   boolean  optional  

Example: false

bypasses_document_approval   boolean  optional  

Example: true

visibility_scope   string  optional  

Example: consequatur

notes   string  optional  

Example: consequatur

DELETE api/roles/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/roles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the role. Example: 24

GET api/roles/{role_id}/expense-types

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24/expense-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24/expense-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/roles/{role_id}/expense-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   integer   

The ID of the role. Example: 24

POST api/roles/{role_id}/expense-types

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24/expense-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"expense_type_codes\": [
        \"consequatur\"
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24/expense-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "expense_type_codes": [
        "consequatur"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/roles/{role_id}/expense-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   integer   

The ID of the role. Example: 24

Body Parameters

expense_type_codes   string[]   

The code of an existing record in the expense_types table.

PATCH api/roles/{role_id}/expense-types

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24/expense-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"expense_type_codes\": [
        \"consequatur\"
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24/expense-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "expense_type_codes": [
        "consequatur"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/roles/{role_id}/expense-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   integer   

The ID of the role. Example: 24

Body Parameters

expense_type_codes   string[]   

The code of an existing record in the expense_types table.

DELETE api/roles/{role_id}/expense-types

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24/expense-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"expense_type_codes\": [
        \"consequatur\"
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/roles/24/expense-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "expense_type_codes": [
        "consequatur"
    ]
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

DELETE api/roles/{role_id}/expense-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   integer   

The ID of the role. Example: 24

Body Parameters

expense_type_codes   string[]   

The code of an existing record in the expense_types table.

GET api/permissions

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get permissions grouped by module and subgroup.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/permissions/grouped-by-group" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/permissions/grouped-by-group"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/permissions/grouped-by-group

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/permissions/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/permissions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/permissions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/permissions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the permission. Example: 1

GET api/permission-groups

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/permission-groups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/permission-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/permission-groups

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/permission-groups/{permissionGroup_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/permission-groups/202" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/permission-groups/202"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/permission-groups/{permissionGroup_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

permissionGroup_id   integer   

The ID of the permissionGroup. Example: 202

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/lines-of-business

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Show the form for creating a new resource.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"slug\": \"consequatur\",
    \"is_active\": true,
    \"has_tat\": false,
    \"has_tat_default\": true,
    \"client_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "slug": "consequatur",
    "is_active": true,
    "has_tat": false,
    "has_tat_default": true,
    "client_id": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/lines-of-business

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: consequatur

description   string   

Example: Dolores dolorum amet iste laborum eius est dolor.

slug   string  optional  

Example: consequatur

is_active   boolean  optional  

Example: true

has_tat   boolean  optional  

Example: false

has_tat_default   boolean  optional  

Example: true

client_id   integer   

The id of an existing record in the clients table. Example: 17

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/lines-of-business/{linesOfBusiness_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

linesOfBusiness_id   integer   

The ID of the linesOfBusiness. Example: 1

Show the form for editing the specified resource.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"slug\": \"consequatur\",
    \"is_active\": false,
    \"has_tat\": false,
    \"has_tat_default\": false,
    \"client_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "consequatur",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "slug": "consequatur",
    "is_active": false,
    "has_tat": false,
    "has_tat_default": false,
    "client_id": 17
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/lines-of-business/{linesOfBusiness_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

linesOfBusiness_id   integer   

The ID of the linesOfBusiness. Example: 1

Body Parameters

name   string  optional  

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

slug   string  optional  

Example: consequatur

is_active   boolean  optional  

Example: false

has_tat   boolean  optional  

Example: false

has_tat_default   boolean  optional  

Example: false

client_id   integer  optional  

The id of an existing record in the clients table. Example: 17

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/lines-of-business/{linesOfBusiness_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

linesOfBusiness_id   integer   

The ID of the linesOfBusiness. Example: 1

GET api/lines-of-business/by-client/{client_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business/by-client/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/lines-of-business/by-client/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/lines-of-business/by-client/{client_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

client_id   integer   

The ID of the client. Example: 1

GET api/banners

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/banners" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"audience\": \"client\",
    \"search\": \"consequatur\",
    \"page\": 45,
    \"perPage\": 16,
    \"sortBy\": \"title\",
    \"sortOrder\": \"desc\",
    \"per_page\": 5,
    \"sort_by\": \"consequatur\",
    \"sort_order\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/banners"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "audience": "client",
    "search": "consequatur",
    "page": 45,
    "perPage": 16,
    "sortBy": "title",
    "sortOrder": "desc",
    "per_page": 5,
    "sort_by": "consequatur",
    "sort_order": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/banners

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

audience   string   

Must not be one of site. Example: client

Must be one of:
  • client
  • clinician
  • site
search   string  optional  

Example: consequatur

page   integer  optional  

Must be at least 1. Example: 45

perPage   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

sortBy   string  optional  

Example: title

Must be one of:
  • createdAt
  • title
  • type
  • updatedAt
sortOrder   string  optional  

Example: desc

Must be one of:
  • asc
  • desc
per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 5

sort_by   string  optional  

Example: consequatur

sort_order   string  optional  

Example: consequatur

POST api/banners

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/banners" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"messageBody\": \"consequatur\",
    \"type\": \"warning\",
    \"audience\": \"clinician\",
    \"isActive\": false,
    \"isDismissable\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/banners"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "messageBody": "consequatur",
    "type": "warning",
    "audience": "clinician",
    "isActive": false,
    "isDismissable": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/banners

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

messageBody   string   

Example: consequatur

type   string   

Example: warning

Must be one of:
  • warning
  • info
  • urgent
audience   string   

Must not be one of site. Example: clinician

Must be one of:
  • client
  • clinician
  • site
isActive   boolean   

Example: false

isDismissable   boolean   

Example: true

GET api/banners/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/banners/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/banners/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/banners/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the banner. Example: 17

PATCH api/banners/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/banners/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"messageBody\": \"consequatur\",
    \"type\": \"warning\",
    \"audience\": \"site\",
    \"isActive\": true,
    \"isDismissable\": false
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/banners/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "messageBody": "consequatur",
    "type": "warning",
    "audience": "site",
    "isActive": true,
    "isDismissable": false
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/banners/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the banner. Example: 17

Body Parameters

title   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

messageBody   string  optional  

Example: consequatur

type   string  optional  

Example: warning

Must be one of:
  • warning
  • info
  • urgent
audience   string  optional  

Must not be one of site. Example: site

Must be one of:
  • client
  • clinician
  • site
isActive   boolean  optional  

Example: true

isDismissable   boolean  optional  

Example: false

DELETE api/banners/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/banners/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/banners/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/banners/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the banner. Example: 17

GET api/admin/banners/site

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/banners/site" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/banners/site"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/admin/banners/site

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

PUT api/admin/banners/site/{siteBanner_id}

requires authentication

Example request:
curl --request PUT \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/banners/site/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"body\": \"consequatur\",
    \"type\": \"warning\",
    \"active\": false,
    \"dismissable\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/banners/site/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "body": "consequatur",
    "type": "warning",
    "active": false,
    "dismissable": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PUT api/admin/banners/site/{siteBanner_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

siteBanner_id   integer   

The ID of the siteBanner. Example: 17

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

body   string   

Example: consequatur

type   string   

Example: warning

Must be one of:
  • warning
  • info
  • urgent
active   boolean  optional  

Example: false

dismissable   boolean  optional  

Example: true

GET api/global-settings

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/global-settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/global-settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/global-settings

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/global-settings

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/global-settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"system_settings\": {
        \"timeout_period\": 73,
        \"disable_credentials_after_inactive_days\": 45,
        \"invitation_email_expiry_hours\": 56
    },
    \"clinician_settings\": {
        \"deactivate_clinician_no_assessment_days\": 17
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/global-settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "system_settings": {
        "timeout_period": 73,
        "disable_credentials_after_inactive_days": 45,
        "invitation_email_expiry_hours": 56
    },
    "clinician_settings": {
        "deactivate_clinician_no_assessment_days": 17
    }
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/global-settings

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

system_settings   object  optional  
timeout_period   integer  optional  

Must be at least 1. Example: 73

disable_credentials_after_inactive_days   integer  optional  

Must be at least 1. Example: 45

invitation_email_expiry_hours   integer  optional  

Must be at least 1. Example: 56

clinician_settings   object  optional  
deactivate_clinician_no_assessment_days   integer  optional  

Must be at least 1. Example: 17

GET api/clinical-criteria

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinical-criteria" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinical-criteria"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clinical-criteria

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

search   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

POST api/clinical-criteria

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinical-criteria" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinical-criteria"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores dolorum amet iste laborum eius est dolor."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clinical-criteria

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string   

Example: Dolores dolorum amet iste laborum eius est dolor.

GET api/clinical-criteria/{clinicalCriteria_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinical-criteria/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinical-criteria/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clinical-criteria/{clinicalCriteria_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicalCriteria_id   integer   

The ID of the clinicalCriteria. Example: 17

PATCH api/clinical-criteria/{clinicalCriteria_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinical-criteria/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"is_active\": false
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinical-criteria/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "is_active": false
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/clinical-criteria/{clinicalCriteria_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicalCriteria_id   integer   

The ID of the clinicalCriteria. Example: 17

Body Parameters

title   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string   

Example: Dolores dolorum amet iste laborum eius est dolor.

is_active   boolean  optional  

Example: false

DELETE api/clinical-criteria/{clinicalCriteria_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinical-criteria/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinical-criteria/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/clinical-criteria/{clinicalCriteria_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicalCriteria_id   integer   

The ID of the clinicalCriteria. Example: 17

GET api/default-email-templates

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/default-email-templates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/default-email-templates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/default-email-templates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/default-email-templates/{defaultEmailTemplate_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/default-email-templates/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/default-email-templates/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/default-email-templates/{defaultEmailTemplate_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

defaultEmailTemplate_id   integer   

The ID of the defaultEmailTemplate. Example: 17

PATCH api/default-email-templates/{defaultEmailTemplate_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/default-email-templates/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"subject\": \"vmqeopfuudtdsufvyvddq\",
    \"body\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/default-email-templates/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "subject": "vmqeopfuudtdsufvyvddq",
    "body": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/default-email-templates/{defaultEmailTemplate_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

defaultEmailTemplate_id   integer   

The ID of the defaultEmailTemplate. Example: 17

Body Parameters

subject   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

body   string   

Example: consequatur

DELETE api/default-email-templates/{defaultEmailTemplate_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/default-email-templates/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/default-email-templates/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/default-email-templates/{defaultEmailTemplate_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

defaultEmailTemplate_id   integer   

The ID of the defaultEmailTemplate. Example: 17

POST api/default-email-templates/{defaultEmailTemplate_id}/reset

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/default-email-templates/17/reset" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/default-email-templates/17/reset"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/default-email-templates/{defaultEmailTemplate_id}/reset

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

defaultEmailTemplate_id   integer   

The ID of the defaultEmailTemplate. Example: 17

GET api/system-rules

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"consequatur\",
    \"rule_family\": \"mqeopfuudtdsufvyvddqa\",
    \"status\": \"draft\",
    \"page\": 45,
    \"per_page\": 13,
    \"sort_by\": \"rule_family\",
    \"sort_order\": \"desc\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "query": "consequatur",
    "rule_family": "mqeopfuudtdsufvyvddqa",
    "status": "draft",
    "page": 45,
    "per_page": 13,
    "sort_by": "rule_family",
    "sort_order": "desc"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/system-rules

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

query   string  optional  

Example: consequatur

rule_family   string  optional  

Must not be greater than 100 characters. Example: mqeopfuudtdsufvyvddqa

status   string  optional  

Example: draft

Must be one of:
  • draft
  • active
  • inactive
page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 13

sort_by   string  optional  

Example: rule_family

Must be one of:
  • priority
  • rule_family
  • status
  • title
  • updated_at
sort_order   string  optional  

Example: desc

Must be one of:
  • asc
  • desc

POST api/system-rules

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rule_family\": \"vmqeopfuudtdsufvyvddq\",
    \"title\": \"amniihfqcoynlazghdtqt\",
    \"status\": \"draft\",
    \"priority\": 56,
    \"conditions\": [
        {
            \"field\": \"vmqeopfuudtdsufvyvddq\",
            \"operator\": \"amniihfqcoynlazghdtqt\",
            \"boolean\": \"or\",
            \"source\": \"qxbajwbpilpmufinllwlo\",
            \"path\": \"auydlsmsjuryvojcybzvr\"
        }
    ],
    \"actions\": [
        {
            \"type\": \"byickznkygloigmkwxphl\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "rule_family": "vmqeopfuudtdsufvyvddq",
    "title": "amniihfqcoynlazghdtqt",
    "status": "draft",
    "priority": 56,
    "conditions": [
        {
            "field": "vmqeopfuudtdsufvyvddq",
            "operator": "amniihfqcoynlazghdtqt",
            "boolean": "or",
            "source": "qxbajwbpilpmufinllwlo",
            "path": "auydlsmsjuryvojcybzvr"
        }
    ],
    "actions": [
        {
            "type": "byickznkygloigmkwxphl"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/system-rules

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

rule_family   string   

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

title   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

status   string  optional  

Example: draft

Must be one of:
  • draft
  • active
  • inactive
priority   integer  optional  

Must be at least 0. Example: 56

conditions   object[]   

Must have at least 1 items.
field   string   

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

operator   string   

Must not be greater than 50 characters. Example: amniihfqcoynlazghdtqt

value   string  optional  
boolean   string  optional  

Example: or

Must be one of:
  • and
  • or
source   string  optional  

Must not be greater than 100 characters. Example: qxbajwbpilpmufinllwlo

path   string  optional  

Must not be greater than 255 characters. Example: auydlsmsjuryvojcybzvr

actions   object[]   

Must have at least 1 items.
type   string   

Must not be greater than 100 characters. Example: byickznkygloigmkwxphl

params   object  optional  

POST api/system-rules/{systemRule_id}/duplicate

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules/17/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules/17/duplicate"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/system-rules/{systemRule_id}/duplicate

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

systemRule_id   integer   

The ID of the systemRule. Example: 17

GET api/system-rules/{systemRule_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/system-rules/{systemRule_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

systemRule_id   integer   

The ID of the systemRule. Example: 17

PATCH api/system-rules/{systemRule_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rule_family\": \"vmqeopfuudtdsufvyvddq\",
    \"title\": \"amniihfqcoynlazghdtqt\",
    \"status\": \"active\",
    \"priority\": 56,
    \"version\": 81,
    \"conditions\": [
        {
            \"field\": \"bajwbpilpmufinllwloau\",
            \"operator\": \"ydlsmsjuryvojcybzvrby\",
            \"boolean\": \"or\",
            \"source\": \"ickznkygloigmkwxphlva\",
            \"path\": \"zjrcnfbaqywuxhgjjmzux\"
        }
    ],
    \"actions\": [
        {
            \"type\": \"jubqouzswiwxtrkimfcat\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "rule_family": "vmqeopfuudtdsufvyvddq",
    "title": "amniihfqcoynlazghdtqt",
    "status": "active",
    "priority": 56,
    "version": 81,
    "conditions": [
        {
            "field": "bajwbpilpmufinllwloau",
            "operator": "ydlsmsjuryvojcybzvrby",
            "boolean": "or",
            "source": "ickznkygloigmkwxphlva",
            "path": "zjrcnfbaqywuxhgjjmzux"
        }
    ],
    "actions": [
        {
            "type": "jubqouzswiwxtrkimfcat"
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/system-rules/{systemRule_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

systemRule_id   integer   

The ID of the systemRule. Example: 17

Body Parameters

rule_family   string  optional  

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

title   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

status   string  optional  

Example: active

Must be one of:
  • draft
  • active
  • inactive
priority   integer  optional  

Must be at least 0. Example: 56

conditions   object[]  optional  

Must have at least 1 items.
field   string  optional  

This field is required when conditions is present. Must not be greater than 100 characters. Example: bajwbpilpmufinllwloau

operator   string  optional  

This field is required when conditions is present. Must not be greater than 50 characters. Example: ydlsmsjuryvojcybzvrby

value   string  optional  
boolean   string  optional  

Example: or

Must be one of:
  • and
  • or
source   string  optional  

Must not be greater than 100 characters. Example: ickznkygloigmkwxphlva

path   string  optional  

Must not be greater than 255 characters. Example: zjrcnfbaqywuxhgjjmzux

actions   object[]  optional  

Must have at least 1 items.
type   string  optional  

This field is required when actions is present. Must not be greater than 100 characters. Example: jubqouzswiwxtrkimfcat

params   object  optional  
version   integer   

Must be at least 1. Example: 81

DELETE api/system-rules/{systemRule_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/system-rules/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/system-rules/{systemRule_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

systemRule_id   integer   

The ID of the systemRule. Example: 17

GET api/alert-templates/available-tags

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates/available-tags" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message_type\": \"tls_secure\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates/available-tags"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message_type": "tls_secure"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/alert-templates/available-tags

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

message_type   string   

Example: tls_secure

Must be one of:
  • default
  • tls_secure

GET api/alert-templates

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"logic\": \"AND\"
    },
    \"search\": \"consequatur\",
    \"page\": 45,
    \"per_page\": 16
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filters": {
        "logic": "AND"
    },
    "search": "consequatur",
    "page": 45,
    "per_page": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/alert-templates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

filters   object  optional  
logic   string  optional  

This field is required when filters is present. Example: AND

Must be one of:
  • AND
  • OR
conditions   object  optional  

This field is required when filters is present. Must have at least 1 items.

search   string  optional  

Example: consequatur

page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates/search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"logic\": \"OR\"
    },
    \"search\": \"consequatur\",
    \"page\": 45,
    \"per_page\": 16
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates/search"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filters": {
        "logic": "OR"
    },
    "search": "consequatur",
    "page": 45,
    "per_page": 16
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/alert-templates

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"default_message\": \"amniihfqcoynlazghdtqt\",
    \"tls_secure_message\": \"qxbajwbpilpmufinllwlo\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "default_message": "amniihfqcoynlazghdtqt",
    "tls_secure_message": "qxbajwbpilpmufinllwlo"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/alert-templates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must match the regex /\S/. Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

default_message   string  optional  

Must not be greater than 65535 characters. Example: amniihfqcoynlazghdtqt

tls_secure_message   string  optional  

Must not be greater than 65535 characters. Example: qxbajwbpilpmufinllwlo

POST api/alert-templates/{alertTemplate_id}/render

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates/17/render" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message_type\": \"default\",
    \"output_format\": \"html\",
    \"reference_id\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates/17/render"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message_type": "default",
    "output_format": "html",
    "reference_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/alert-templates/{alertTemplate_id}/render

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

alertTemplate_id   integer   

The ID of the alertTemplate. Example: 17

Body Parameters

message_type   string   

Example: default

Must be one of:
  • default
  • tls_secure
output_format   string   

Example: html

Must be one of:
  • html
  • pdf
reference_id   string   

Example: consequatur

GET api/alert-templates/{alertTemplate_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alert-templates/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/alert-templates/{alertTemplate_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

alertTemplate_id   integer   

The ID of the alertTemplate. Example: 17

GET api/admin/alert-templates

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/alert-templates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"logic\": \"OR\"
    },
    \"search\": \"consequatur\",
    \"page\": 45,
    \"per_page\": 16
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/alert-templates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filters": {
        "logic": "OR"
    },
    "search": "consequatur",
    "page": 45,
    "per_page": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/admin/alert-templates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

filters   object  optional  
logic   string  optional  

This field is required when filters is present. Example: OR

Must be one of:
  • AND
  • OR
conditions   object  optional  

This field is required when filters is present. Must have at least 1 items.

search   string  optional  

Example: consequatur

page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/alert-templates/search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"logic\": \"OR\"
    },
    \"search\": \"consequatur\",
    \"page\": 45,
    \"per_page\": 16
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/alert-templates/search"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filters": {
        "logic": "OR"
    },
    "search": "consequatur",
    "page": 45,
    "per_page": 16
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/admin/alert-templates/{alertTemplate_id}/render

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/alert-templates/17/render" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message_type\": \"default\",
    \"output_format\": \"pdf\",
    \"reference_id\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/alert-templates/17/render"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message_type": "default",
    "output_format": "pdf",
    "reference_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/admin/alert-templates/{alertTemplate_id}/render

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

alertTemplate_id   integer   

The ID of the alertTemplate. Example: 17

Body Parameters

message_type   string   

Example: default

Must be one of:
  • default
  • tls_secure
output_format   string   

Example: pdf

Must be one of:
  • html
  • pdf
reference_id   string   

Example: consequatur

GET api/admin/alert-templates/{alertTemplate_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/alert-templates/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/admin/alert-templates/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/admin/alert-templates/{alertTemplate_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

alertTemplate_id   integer   

The ID of the alertTemplate. Example: 17

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/member-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"vmqeopfuudtdsufvyvddq\",
    \"client_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/member-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "vmqeopfuudtdsufvyvddq",
    "client_id": 17
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/member-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

client_id   integer  optional  

Example: 17

Show the form for creating a new resource.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/member-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"consequatur\",
    \"client_id\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/member-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "consequatur",
    "client_id": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/member-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string   

Example: consequatur

client_id   string   

The id of an existing record in the clients table. Example: consequatur

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/member-types/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/member-types/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/member-types/{memberType_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

memberType_id   integer   

The ID of the memberType. Example: 1

Show the form for editing the specified resource.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/member-types/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/member-types/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/member-types/{memberType_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

memberType_id   integer   

The ID of the memberType. Example: 1

Body Parameters

type   string  optional  

Example: consequatur

client_id   string  optional  

The id of an existing record in the clients table.

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/member-types/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/member-types/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/member-types/{memberType_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

memberType_id   integer   

The ID of the memberType. Example: 1

GET api/activities

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/activities" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search\": \"consequatur\",
    \"start_date\": \"2026-05-14T17:42:32\",
    \"end_date\": \"2026-05-14T17:42:32\",
    \"entity\": [
        \"consequatur\"
    ],
    \"entity_id\": 17,
    \"user_id\": 17,
    \"causer_type_name\": \"consequatur\",
    \"user_ids\": [
        17
    ],
    \"page\": 45,
    \"per_page\": 16,
    \"sort_by\": \"field\",
    \"sort_order\": \"asc\",
    \"subject_type_name\": \"consequatur\",
    \"subject_id\": 17,
    \"causer_id\": 17,
    \"causer_ids\": \"consequatur\",
    \"limit\": 13,
    \"offset\": 56
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/activities"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search": "consequatur",
    "start_date": "2026-05-14T17:42:32",
    "end_date": "2026-05-14T17:42:32",
    "entity": [
        "consequatur"
    ],
    "entity_id": 17,
    "user_id": 17,
    "causer_type_name": "consequatur",
    "user_ids": [
        17
    ],
    "page": 45,
    "per_page": 16,
    "sort_by": "field",
    "sort_order": "asc",
    "subject_type_name": "consequatur",
    "subject_id": 17,
    "causer_id": 17,
    "causer_ids": "consequatur",
    "limit": 13,
    "offset": 56
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/activities

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

search   string  optional  

Example: consequatur

start_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

end_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

entity   string[]  optional  
entity_id   integer  optional  

Example: 17

user_id   integer  optional  

Example: 17

causer_type_name   string  optional  

Example: consequatur

user_ids   integer[]  optional  
page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

sort_by   string  optional  

Example: field

Must be one of:
  • change_date
  • entity
  • entity_id
  • field
  • user
sort_order   string  optional  

Example: asc

Must be one of:
  • asc
  • desc
subject_type_name   string  optional  

Example: consequatur

subject_id   integer  optional  

Example: 17

causer_id   integer  optional  

Example: 17

causer_ids   string  optional  

Example: consequatur

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 13

offset   integer  optional  

Must be at least 0. Example: 56

POST api/members/gryphon-activities/{member_id}

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"user\": {
        \"id\": 17
    },
    \"visibility\": \"consequatur\",
    \"parent\": {
        \"id\": 17
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message": "consequatur",
    "priority": "consequatur",
    "user": {
        "id": 17
    },
    "visibility": "consequatur",
    "parent": {
        "id": 17
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/members/gryphon-activities/{member_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

member_id   integer   

The ID of the member. Example: 1

Body Parameters

message   string   

Example: consequatur

priority   string   

Example: consequatur

user   object  optional  
id   integer  optional  

The id of an existing record in the users table. Example: 17

visibility   string   

Example: consequatur

parent   object  optional  
id   integer  optional  

The id of an existing record in the gryphon_activities table. Example: 17

GET api/members/gryphon-activities/{member_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search\": \"consequatur\",
    \"start_date\": \"2026-05-14T17:42:32\",
    \"end_date\": \"2026-05-14T17:42:32\",
    \"created_at\": \"2026-05-14T17:42:32\",
    \"activity_type\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"visibility\": \"consequatur\",
    \"user_id\": 17,
    \"parent_id\": 17,
    \"updated_at\": \"2026-05-14T17:42:32\",
    \"page\": 45,
    \"per_page\": 16,
    \"limit\": 5,
    \"offset\": 50,
    \"sort\": \"consequatur\",
    \"order\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search": "consequatur",
    "start_date": "2026-05-14T17:42:32",
    "end_date": "2026-05-14T17:42:32",
    "created_at": "2026-05-14T17:42:32",
    "activity_type": "consequatur",
    "priority": "consequatur",
    "visibility": "consequatur",
    "user_id": 17,
    "parent_id": 17,
    "updated_at": "2026-05-14T17:42:32",
    "page": 45,
    "per_page": 16,
    "limit": 5,
    "offset": 50,
    "sort": "consequatur",
    "order": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/members/gryphon-activities/{member_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

member_id   integer   

The ID of the member. Example: 1

Body Parameters

search   string  optional  

Example: consequatur

start_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

end_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

created_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

activity_type   string  optional  

Example: consequatur

priority   string  optional  

Example: consequatur

visibility   string  optional  

Example: consequatur

user_id   integer  optional  

Example: 17

parent_id   integer  optional  

Example: 17

updated_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 5

offset   integer  optional  

Must be at least 0. Example: 50

sort   string  optional  

Example: consequatur

order   string  optional  

Example: consequatur

people   string  optional  

POST api/members

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"first_name\": \"amniihfqcoynlazghdtqt\",
    \"middle_initial\": \"q\",
    \"last_name\": \"xbajwbpilpmufinllwloa\",
    \"ssn\": \"2662\",
    \"gender\": \"other\",
    \"language\": \"Indonesian\",
    \"date_of_birth\": \"2026-05-14T17:42:32\",
    \"client\": {
        \"member_type\": [],
        \"lines_of_business\": [],
        \"client_member_id\": \"uudtdsufvyvddqamniihf\"
    },
    \"safety_flag\": \"aggressive_behavior\",
    \"notes\": \"consequatur\",
    \"phones\": [
        {
            \"number\": \"mqeopfuudtdsufvyvddqa\",
            \"type\": \"main\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "first_name": "amniihfqcoynlazghdtqt",
    "middle_initial": "q",
    "last_name": "xbajwbpilpmufinllwloa",
    "ssn": "2662",
    "gender": "other",
    "language": "Indonesian",
    "date_of_birth": "2026-05-14T17:42:32",
    "client": {
        "member_type": [],
        "lines_of_business": [],
        "client_member_id": "uudtdsufvyvddqamniihf"
    },
    "safety_flag": "aggressive_behavior",
    "notes": "consequatur",
    "phones": [
        {
            "number": "mqeopfuudtdsufvyvddqa",
            "type": "main"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/members

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

first_name   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

middle_initial   string  optional  

Must not be greater than 1 character. Example: q

last_name   string   

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

ssn   string  optional  

Must match the regex /^[0-9-]+$/. Example: 2662

gender   string  optional  

Example: other

Must be one of:
  • male
  • female
  • other
language   string  optional  

Example: Indonesian

Must be one of:
  • English
  • Spanish
  • French
  • German
  • Italian
  • Portuguese
  • Dutch
  • Russian
  • Japanese
  • Chinese
  • Korean
  • Arabic
  • Hindi
  • Bengali
  • Punjabi
  • Urdu
  • Turkish
  • Vietnamese
  • Thai
  • Indonesian
  • Filipino
  • Malay
  • Swahili
  • Amharic
  • Somali
  • Yoruba
  • Igbo
  • Hausa
  • Zulu
  • Xhosa
  • Afrikaans
  • Other
date_of_birth   string   

Must be a valid date. Example: 2026-05-14T17:42:32

client   object  optional  
client   object  optional  
id   string  optional  

The id of an existing record in the clients table.

member_type   object  optional  
id   string  optional  

The id of an existing record in the member_types table.

lines_of_business   object  optional  
id   string  optional  

The id of an existing record in the lines_of_businesses table.

client_member_id   string  optional  

Must not be greater than 255 characters. Example: uudtdsufvyvddqamniihf

safety_flag   string  optional  

Example: aggressive_behavior

Must be one of:
  • aggressive_behavior
  • aggressive_dog
  • mental_health_issues
  • other
notes   string  optional  

Example: consequatur

emails   string[]  optional  
addresses   string[]  optional  
phones   object[]  optional  
number   string   

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

type   string  optional  

Example: main

Must be one of:
  • main
  • home
  • work
  • mobile

GET api/members

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search\": \"consequatur\",
    \"client_id\": 17,
    \"client_member_id\": \"consequatur\",
    \"page\": 45,
    \"per_page\": 16,
    \"limit\": 5,
    \"offset\": 50,
    \"sort\": \"consequatur\",
    \"order\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search": "consequatur",
    "client_id": 17,
    "client_member_id": "consequatur",
    "page": 45,
    "per_page": 16,
    "limit": 5,
    "offset": 50,
    "sort": "consequatur",
    "order": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/members

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

search   string  optional  

Example: consequatur

client_id   integer  optional  

Example: 17

client_member_id   string  optional  

Example: consequatur

page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 5

offset   integer  optional  

Must be at least 0. Example: 50

sort   string  optional  

Example: consequatur

order   string  optional  

Example: consequatur

GET api/members/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/members/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the member. Example: 1

PATCH api/members/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vmqeopfuudtdsufvyvddq\",
    \"first_name\": \"amniihfqcoynlazghdtqt\",
    \"middle_initial\": \"q\",
    \"last_name\": \"xbajwbpilpmufinllwloa\",
    \"gender\": \"other\",
    \"ssn\": \"2662\",
    \"language\": \"Vietnamese\",
    \"date_of_birth\": \"2026-05-14T17:42:32\",
    \"client\": {
        \"member_type\": [],
        \"lines_of_business\": [],
        \"client_member_id\": \"uudtdsufvyvddqamniihf\"
    },
    \"safety_flag\": \"aggressive_dog\",
    \"notes\": \"consequatur\",
    \"phones\": [
        {
            \"number\": \"mqeopfuudtdsufvyvddqa\",
            \"type\": \"main\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vmqeopfuudtdsufvyvddq",
    "first_name": "amniihfqcoynlazghdtqt",
    "middle_initial": "q",
    "last_name": "xbajwbpilpmufinllwloa",
    "gender": "other",
    "ssn": "2662",
    "language": "Vietnamese",
    "date_of_birth": "2026-05-14T17:42:32",
    "client": {
        "member_type": [],
        "lines_of_business": [],
        "client_member_id": "uudtdsufvyvddqamniihf"
    },
    "safety_flag": "aggressive_dog",
    "notes": "consequatur",
    "phones": [
        {
            "number": "mqeopfuudtdsufvyvddqa",
            "type": "main"
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/members/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the member. Example: 1

Body Parameters

title   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

first_name   string   

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

middle_initial   string  optional  

Must not be greater than 1 character. Example: q

last_name   string   

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

gender   string  optional  

Example: other

Must be one of:
  • male
  • female
  • other
ssn   string  optional  

Must match the regex /^[0-9-]+$/. Example: 2662

language   string  optional  

Example: Vietnamese

Must be one of:
  • English
  • Spanish
  • French
  • German
  • Italian
  • Portuguese
  • Dutch
  • Russian
  • Japanese
  • Chinese
  • Korean
  • Arabic
  • Hindi
  • Bengali
  • Punjabi
  • Urdu
  • Turkish
  • Vietnamese
  • Thai
  • Indonesian
  • Filipino
  • Malay
  • Swahili
  • Amharic
  • Somali
  • Yoruba
  • Igbo
  • Hausa
  • Zulu
  • Xhosa
  • Afrikaans
  • Other
date_of_birth   string   

Must be a valid date. Example: 2026-05-14T17:42:32

emails   string[]  optional  
addresses   string[]  optional  
phones   object[]  optional  
number   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

type   string  optional  

Example: main

Must be one of:
  • main
  • home
  • work
  • mobile
client   object  optional  
client   object  optional  
id   string  optional  

The id of an existing record in the clients table.

member_type   object  optional  
id   string  optional  

The id of an existing record in the member_types table.

lines_of_business   object  optional  
id   string  optional  

The id of an existing record in the lines_of_businesses table.

client_member_id   string  optional  

Must not be greater than 255 characters. Example: uudtdsufvyvddqamniihf

safety_flag   string  optional  

Example: aggressive_dog

Must be one of:
  • aggressive_behavior
  • aggressive_dog
  • mental_health_issues
  • other
notes   string  optional  

Example: consequatur

DELETE api/members/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/members/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the member. Example: 1

Check for duplicates against a member, based on received parameters

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/check-duplicates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ssn\": \"vmqeopfuu\",
    \"date_of_birth\": \"2026-05-14T17:42:32\",
    \"first_name\": \"dtdsufvyvddqamniihfqc\",
    \"last_name\": \"oynlazghdtqtqxbajwbpi\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/check-duplicates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ssn": "vmqeopfuu",
    "date_of_birth": "2026-05-14T17:42:32",
    "first_name": "dtdsufvyvddqamniihfqc",
    "last_name": "oynlazghdtqtqxbajwbpi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/members/check-duplicates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

ssn   string  optional  

Must not be greater than 11 characters. Example: vmqeopfuu

date_of_birth   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

first_name   string  optional  

Must not be greater than 255 characters. Example: dtdsufvyvddqamniihfqc

last_name   string  optional  

Must not be greater than 255 characters. Example: oynlazghdtqtqxbajwbpi

POST api/members/{member_id}/phones

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/phones" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": \"vmqeopfuudtdsufvyvddq\",
    \"type\": \"mobile\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/phones"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "number": "vmqeopfuudtdsufvyvddq",
    "type": "mobile"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/members/{member_id}/phones

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

member_id   integer   

The ID of the member. Example: 1

Body Parameters

number   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

type   string   

Example: mobile

Must be one of:
  • main
  • home
  • work
  • mobile

PATCH api/members/{member_id}/phones/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/phones/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"number\": \"vmqeopfuudtdsufvyvddq\",
    \"type\": \"home\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/phones/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "number": "vmqeopfuudtdsufvyvddq",
    "type": "home"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/members/{member_id}/phones/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

member_id   integer   

The ID of the member. Example: 1

id   integer   

The ID of the phone. Example: 1

Body Parameters

number   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

type   string  optional  

Example: home

Must be one of:
  • main
  • home
  • work
  • mobile

DELETE api/members/{member_id}/phones/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/phones/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/phones/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/members/{member_id}/phones/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

member_id   integer   

The ID of the member. Example: 1

id   integer   

The ID of the phone. Example: 1

POST api/members/{member_id}/emails

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/emails" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"type\": \"work\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/emails"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "qkunze@example.com",
    "type": "work"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/members/{member_id}/emails

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

member_id   integer   

The ID of the member. Example: 1

Body Parameters

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: qkunze@example.com

type   string   

Example: work

Must be one of:
  • main
  • personal
  • work
  • secondary

PATCH api/members/{member_id}/emails/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/emails/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"type\": \"secondary\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/emails/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "qkunze@example.com",
    "type": "secondary"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/members/{member_id}/emails/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

member_id   integer   

The ID of the member. Example: 1

id   integer   

The ID of the email. Example: 1

Body Parameters

email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: qkunze@example.com

type   string  optional  

Example: secondary

Must be one of:
  • main
  • personal
  • work
  • secondary

DELETE api/members/{member_id}/emails/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/emails/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/emails/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/members/{member_id}/emails/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

member_id   integer   

The ID of the member. Example: 1

id   integer   

The ID of the email. Example: 1

POST api/members/{member_id}/addresses

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/addresses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"line_1\": \"vmqeopfuudtdsufvyvddq\",
    \"line_2\": \"amniihfqcoynlazghdtqt\",
    \"city\": \"qxbajwbpilpmufinllwlo\",
    \"state\": \"auydlsmsjuryvojcybzvr\",
    \"zip_code\": \"byickznkygloigmkwxphl\",
    \"is_primary\": false,
    \"type\": \"billing\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/addresses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "line_1": "vmqeopfuudtdsufvyvddq",
    "line_2": "amniihfqcoynlazghdtqt",
    "city": "qxbajwbpilpmufinllwlo",
    "state": "auydlsmsjuryvojcybzvr",
    "zip_code": "byickznkygloigmkwxphl",
    "is_primary": false,
    "type": "billing"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/members/{member_id}/addresses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

member_id   integer   

The ID of the member. Example: 1

Body Parameters

line_1   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

line_2   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

city   string   

Must not be greater than 255 characters. Example: qxbajwbpilpmufinllwlo

state   string   

Must not be greater than 255 characters. Example: auydlsmsjuryvojcybzvr

zip_code   string   

Must not be greater than 255 characters. Example: byickznkygloigmkwxphl

is_primary   boolean   

Example: false

type   string   

Example: billing

Must be one of:
  • home
  • work
  • billing
  • shipping

DELETE api/members/{member_id}/addresses/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/addresses/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/members/1/addresses/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/members/{member_id}/addresses/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

member_id   integer   

The ID of the member. Example: 1

id   integer   

The ID of the address. Example: 1

GET api/gryphon-activities

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search\": \"consequatur\",
    \"start_date\": \"2026-05-14T17:42:32\",
    \"end_date\": \"2026-05-14T17:42:32\",
    \"created_at\": \"2026-05-14T17:42:32\",
    \"activity_type\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"visibility\": \"consequatur\",
    \"user_id\": 17,
    \"parent_id\": 17,
    \"updated_at\": \"2026-05-14T17:42:32\",
    \"page\": 45,
    \"per_page\": 16,
    \"limit\": 5,
    \"offset\": 50,
    \"sort\": \"consequatur\",
    \"order\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search": "consequatur",
    "start_date": "2026-05-14T17:42:32",
    "end_date": "2026-05-14T17:42:32",
    "created_at": "2026-05-14T17:42:32",
    "activity_type": "consequatur",
    "priority": "consequatur",
    "visibility": "consequatur",
    "user_id": 17,
    "parent_id": 17,
    "updated_at": "2026-05-14T17:42:32",
    "page": 45,
    "per_page": 16,
    "limit": 5,
    "offset": 50,
    "sort": "consequatur",
    "order": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/gryphon-activities

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

search   string  optional  

Example: consequatur

start_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

end_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

created_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

activity_type   string  optional  

Example: consequatur

priority   string  optional  

Example: consequatur

visibility   string  optional  

Example: consequatur

user_id   integer  optional  

Example: 17

parent_id   integer  optional  

Example: 17

updated_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 5

offset   integer  optional  

Must be at least 0. Example: 50

sort   string  optional  

Example: consequatur

order   string  optional  

Example: consequatur

people   string  optional  

POST api/gryphon-activities

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"user\": {
        \"id\": 17
    },
    \"visibility\": \"consequatur\",
    \"parent\": {
        \"id\": 17
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message": "consequatur",
    "priority": "consequatur",
    "user": {
        "id": 17
    },
    "visibility": "consequatur",
    "parent": {
        "id": 17
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/gryphon-activities

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

message   string   

Example: consequatur

priority   string   

Example: consequatur

user   object  optional  
id   integer  optional  

The id of an existing record in the users table. Example: 17

visibility   string   

Example: consequatur

parent   object  optional  
id   integer  optional  

The id of an existing record in the gryphon_activities table. Example: 17

POST api/gryphon-activities/watchers/{gryphonActivity_id}

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities/watchers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 17,
    \"notified_at\": \"2026-05-14T17:42:32\",
    \"type\": \"consequatur\",
    \"viewed_at\": \"2026-05-14T17:42:32\",
    \"dismissed_at\": \"2026-05-14T17:42:32\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities/watchers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 17,
    "notified_at": "2026-05-14T17:42:32",
    "type": "consequatur",
    "viewed_at": "2026-05-14T17:42:32",
    "dismissed_at": "2026-05-14T17:42:32"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/gryphon-activities/watchers/{gryphonActivity_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

gryphonActivity_id   integer   

The ID of the gryphonActivity. Example: 1

Body Parameters

user_id   integer   

Example: 17

notified_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

type   string   

Example: consequatur

viewed_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

dismissed_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

GET api/gryphon-activities/watchers/{gryphonActivity_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities/watchers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities/watchers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/gryphon-activities/watchers/{gryphonActivity_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

gryphonActivity_id   integer   

The ID of the gryphonActivity. Example: 1

GET api/gryphon-activities/{gryphonActivity_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/gryphon-activities/{gryphonActivity_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

gryphonActivity_id   integer   

The ID of the gryphonActivity. Example: 1

PATCH api/gryphon-activities/{gryphonActivity_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"visibility\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message": "consequatur",
    "priority": "consequatur",
    "visibility": "consequatur"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/gryphon-activities/{gryphonActivity_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

gryphonActivity_id   integer   

The ID of the gryphonActivity. Example: 1

Body Parameters

message   string   

Example: consequatur

priority   string   

Example: consequatur

visibility   string   

Example: consequatur

DELETE api/gryphon-activities/{gryphonActivity_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/gryphon-activities/{gryphonActivity_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

gryphonActivity_id   integer   

The ID of the gryphonActivity. Example: 1

GET api/watchers

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/watchers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/watchers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/watchers

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/watchers/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/watchers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"notified_at\": \"2026-05-14T17:42:32\",
    \"type\": \"consequatur\",
    \"viewed_at\": \"2026-05-14T17:42:32\",
    \"dismissed_at\": \"2026-05-14T17:42:32\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/watchers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "notified_at": "2026-05-14T17:42:32",
    "type": "consequatur",
    "viewed_at": "2026-05-14T17:42:32",
    "dismissed_at": "2026-05-14T17:42:32"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/watchers/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the watcher. Example: 1

Body Parameters

notified_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

type   string  optional  

Example: consequatur

viewed_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

dismissed_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

DELETE api/watchers/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/watchers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/watchers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/watchers/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the watcher. Example: 1

GET api/alerts

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alerts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alerts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/alerts

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/alerts/count

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alerts/count" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alerts/count"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/alerts/count

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

PATCH api/alerts/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alerts/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"dismissed_at\": \"2026-05-14T17:42:32\",
    \"viewed_at\": \"2026-05-14T17:42:32\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/alerts/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "dismissed_at": "2026-05-14T17:42:32",
    "viewed_at": "2026-05-14T17:42:32"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/alerts/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the alert. Example: 1

Body Parameters

dismissed_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

viewed_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

GET api/case-types

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\",
    \"is_group\": true,
    \"group\": [],
    \"page\": 26,
    \"per_page\": 6,
    \"limit\": 16,
    \"offset\": 8
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit.",
    "is_group": true,
    "group": [],
    "page": 26,
    "per_page": 6,
    "limit": 16,
    "offset": 8
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

is_group   boolean  optional  

Example: true

group   object  optional  
id   string  optional  

The id of an existing record in the case_types table.

page   integer  optional  

Must be at least 1. Example: 26

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 6

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

offset   integer  optional  

Must be at least 0. Example: 8

POST api/case-types

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\",
    \"is_group\": true,
    \"group\": []
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit.",
    "is_group": true,
    "group": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/case-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

is_group   boolean   

Example: true

group   object  optional  
id   string  optional  

The id of an existing record in the case_types table.

hcpcs   object[]  optional  
id   string  optional  

The id of an existing record in the procedure_codes table.

cpt   object[]  optional  
id   string  optional  

The id of an existing record in the procedure_codes table.

case_type_options   object[]  optional  
id   string  optional  

The id of an existing record in the case_type_options table.

GET api/case-types/{caseType_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-types/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-types/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-types/{caseType_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseType_id   integer   

The ID of the caseType. Example: 1

PATCH api/case-types/{caseType_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-types/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\",
    \"is_group\": false,
    \"group\": [],
    \"hcpcs\": [
        []
    ],
    \"cpt\": [
        []
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-types/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit.",
    "is_group": false,
    "group": [],
    "hcpcs": [
        []
    ],
    "cpt": [
        []
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/case-types/{caseType_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseType_id   integer   

The ID of the caseType. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

is_group   boolean  optional  

Example: false

group   object  optional  
id   string  optional  

The id of an existing record in the case_types table.

case_type_options   object[]  optional  
id   string  optional  

The id of an existing record in the case_type_options table.

hcpcs   object[]  optional  
id   string  optional  

The id of an existing record in the procedure_codes table.

cpt   object[]  optional  
id   string  optional  

The id of an existing record in the procedure_codes table.

DELETE api/case-types/{caseType}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-types/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-types/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/case-types/{caseType}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseType   integer   

Example: 1

GET api/modifiers

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/modifiers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/modifiers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/modifiers

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/modifiers

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/modifiers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/modifiers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/modifiers

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

GET api/modifiers/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/modifiers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/modifiers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/modifiers/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the modifier. Example: 1

PATCH api/modifiers/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/modifiers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/modifiers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit."
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/modifiers/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the modifier. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

DELETE api/modifiers/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/modifiers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/modifiers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/modifiers/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the modifier. Example: 1

GET api/case-type-options

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-options" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-options"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-type-options

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/case-type-options

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-options" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-options"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/case-type-options

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

GET api/case-type-options/{caseTypeOption_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-options/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-options/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-type-options/{caseTypeOption_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseTypeOption_id   integer   

The ID of the caseTypeOption. Example: 1

PATCH api/case-type-options/{caseTypeOption_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-options/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-options/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit."
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/case-type-options/{caseTypeOption_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseTypeOption_id   integer   

The ID of the caseTypeOption. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

DELETE api/case-type-options/{caseTypeOption_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-options/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-options/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/case-type-options/{caseTypeOption_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseTypeOption_id   integer   

The ID of the caseTypeOption. Example: 1

GET api/procedure-codes

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/procedure-codes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/procedure-codes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/procedure-codes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/procedure-codes/hcpcs

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/procedure-codes/hcpcs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/procedure-codes/hcpcs"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/procedure-codes/hcpcs

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/procedure-codes/cpt

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/procedure-codes/cpt" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/procedure-codes/cpt"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/procedure-codes/cpt

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/procedure-codes/{procedureCode}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/procedure-codes/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/procedure-codes/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/procedure-codes/{procedureCode}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

procedureCode   string   

Example: consequatur

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-sets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-type-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Show the form for creating a new resource.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-sets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/case-type-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

case_type_options   object[]  optional  
id   string  optional  

The id of an existing record in the case_type_options table.

modifiers   object[]  optional  
id   string  optional  

The id of an existing record in the modifiers table.

hcpcs   object[]  optional  
id   string  optional  

The id of an existing record in the procedure_codes table.

cpt   object[]  optional  
id   string  optional  

The id of an existing record in the procedure_codes table.

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-sets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-type-sets/{caseTypeSet_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseTypeSet_id   integer   

The ID of the caseTypeSet. Example: 1

Update the specified resource in storage.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-sets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit."
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/case-type-sets/{caseTypeSet_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseTypeSet_id   integer   

The ID of the caseTypeSet. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

case_type_options   object[]  optional  
id   string  optional  

The id of an existing record in the case_type_options table.

modifiers   object[]  optional  
id   string  optional  

The id of an existing record in the modifiers table.

hcpcs   object[]  optional  
id   string  optional  
cpt   object[]  optional  
id   string  optional  

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-type-sets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/case-type-sets/{caseTypeSet_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseTypeSet_id   integer   

The ID of the caseTypeSet. Example: 1

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classifications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classifications"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-classifications

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Show the form for creating a new resource.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classifications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classifications"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/case-classifications

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classifications/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classifications/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-classifications/{caseClassification_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseClassification_id   integer   

The ID of the caseClassification. Example: 1

Update the specified resource in storage.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classifications/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classifications/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit."
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/case-classifications/{caseClassification_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseClassification_id   integer   

The ID of the caseClassification. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classifications/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classifications/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/case-classifications/{caseClassification_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseClassification_id   integer   

The ID of the caseClassification. Example: 1

Display a listing of all assessment responses.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-responses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-responses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/assessment-responses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Store a newly created assessment response in storage.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-responses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_id\": 17,
    \"member_id\": 17,
    \"assessment\": 17,
    \"case_id\": 17,
    \"response\": []
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-responses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "client_id": 17,
    "member_id": 17,
    "assessment": 17,
    "case_id": 17,
    "response": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/assessment-responses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

client_id   integer  optional  

This field is required when none of client are present. The id of an existing record in the clients table. Example: 17

client   object  optional  
member_id   integer  optional  

This field is required when none of member are present. The id of an existing record in the members table. Example: 17

member   object  optional  
assessment   integer  optional  

This field is required when none of assessment_model are present. The id of an existing record in the assessments table. Example: 17

assessment_model   object  optional  
case_id   integer  optional  

This field is required when none of case are present. The id of an existing record in the cases table. Example: 17

case   object  optional  
response   object   

Display the specified assessment response.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-responses/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-responses/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/assessment-responses/{assessmentResponse_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

assessmentResponse_id   integer   

The ID of the assessmentResponse. Example: 1

Update the specified assessment response in storage.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-responses/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-responses/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request   

PATCH api/assessment-responses/{assessmentResponse_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

assessmentResponse_id   integer   

The ID of the assessmentResponse. Example: 1

Remove the specified assessment response from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-responses/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-responses/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/assessment-responses/{assessmentResponse_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

assessmentResponse_id   integer   

The ID of the assessmentResponse. Example: 1

GET api/case-classification-sets

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classification-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\",
    \"query\": \"consequatur\",
    \"page\": 45,
    \"per_page\": 16,
    \"limit\": 5,
    \"offset\": 50,
    \"sort_by\": \"consequatur\",
    \"sort_direction\": \"asc\",
    \"with\": \"consequatur\",
    \"with_count\": \"consequatur\",
    \"with_trashed\": false,
    \"only_trashed\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classification-sets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit.",
    "query": "consequatur",
    "page": 45,
    "per_page": 16,
    "limit": 5,
    "offset": 50,
    "sort_by": "consequatur",
    "sort_direction": "asc",
    "with": "consequatur",
    "with_count": "consequatur",
    "with_trashed": false,
    "only_trashed": true
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-classification-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

query   string  optional  

Example: consequatur

page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 5

offset   integer  optional  

Must be at least 0. Example: 50

sort_by   string  optional  

Example: consequatur

sort_direction   string  optional  

Example: asc

Must be one of:
  • asc
  • desc
with   string  optional  

Example: consequatur

with_count   string  optional  

Example: consequatur

with_trashed   boolean  optional  

Example: false

only_trashed   boolean  optional  

Example: true

case_classifications   object[]  optional  
id   string  optional  

The id of an existing record in the case_classifications table.

POST api/case-classification-sets

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classification-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classification-sets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/case-classification-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

case_classifications   object[]  optional  
id   string  optional  

The id of an existing record in the case_classifications table.

GET api/case-classification-sets/{caseClassificationSet_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classification-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classification-sets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-classification-sets/{caseClassificationSet_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseClassificationSet_id   integer   

The ID of the caseClassificationSet. Example: 1

PATCH api/case-classification-sets/{caseClassificationSet_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classification-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classification-sets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit."
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/case-classification-sets/{caseClassificationSet_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseClassificationSet_id   integer   

The ID of the caseClassificationSet. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 255 characters. Example: Dolores molestias ipsam sit.

case_classifications   object[]  optional  
id   string  optional  

The id of an existing record in the case_classifications table.

DELETE api/case-classification-sets/{caseClassificationSet_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classification-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-classification-sets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/case-classification-sets/{caseClassificationSet_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseClassificationSet_id   integer   

The ID of the caseClassificationSet. Example: 1

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-class-relationship" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-class-relationship"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-class-relationship

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/case-class-relationship

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-class-relationship" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"case_type\": {
        \"id\": 17
    },
    \"case_type_set\": {
        \"id\": 17
    },
    \"case_classification_set\": {
        \"id\": 17
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-class-relationship"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "case_type": {
        "id": 17
    },
    "case_type_set": {
        "id": 17
    },
    "case_classification_set": {
        "id": 17
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/case-class-relationship

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

case_type   object  optional  
id   integer   

The id of an existing record in the case_types table. Example: 17

case_type_set   object  optional  
id   integer   

The id of an existing record in the case_type_sets table. Example: 17

case_classification_set   object  optional  
id   integer   

The id of an existing record in the case_class_sets table. Example: 17

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-class-relationship/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-class-relationship/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-class-relationship/{caseClassRelationship_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseClassRelationship_id   integer   

The ID of the caseClassRelationship. Example: 1

Update the specified resource in storage.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-class-relationship/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"case_type\": {
        \"id\": 17
    },
    \"case_type_set\": {
        \"id\": 17
    },
    \"case_classification_set\": {
        \"id\": 17
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-class-relationship/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "case_type": {
        "id": 17
    },
    "case_type_set": {
        "id": 17
    },
    "case_classification_set": {
        "id": 17
    }
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/case-class-relationship/{caseClassRelationship_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseClassRelationship_id   integer   

The ID of the caseClassRelationship. Example: 1

Body Parameters

case_type   object  optional  
id   integer   

The id of an existing record in the case_types table. Example: 17

case_type_set   object  optional  
id   integer   

The id of an existing record in the case_type_sets table. Example: 17

case_classification_set   object  optional  
id   integer   

The id of an existing record in the case_class_sets table. Example: 17

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-class-relationship/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-class-relationship/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/case-class-relationship/{caseClassRelationship_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseClassRelationship_id   integer   

The ID of the caseClassRelationship. Example: 1

GET api/documents

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/documents

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/documents

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "user_id=17"\
    --form "document_label=consequatur"\
    --form "title=consequatur"\
    --form "description=Dolores dolorum amet iste laborum eius est dolor."\
    --form "document_type=consequatur"\
    --form "state=mq"\
    --form "expiration_date=2026-05-14T17:42:32"\
    --form "completion_date=2020-09-09"\
    --form "signature_files=consequatur"\
    --form "certification_type=consequatur"\
    --form "documentable_type=consequatur"\
    --form "documentable_id=17"\
    --form "file=@/tmp/phpfWoYUs" 
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('user_id', '17');
body.append('document_label', 'consequatur');
body.append('title', 'consequatur');
body.append('description', 'Dolores dolorum amet iste laborum eius est dolor.');
body.append('document_type', 'consequatur');
body.append('state', 'mq');
body.append('expiration_date', '2026-05-14T17:42:32');
body.append('completion_date', '2020-09-09');
body.append('signature_files', 'consequatur');
body.append('certification_type', 'consequatur');
body.append('documentable_type', 'consequatur');
body.append('documentable_id', '17');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request   

POST api/documents

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

file   file   

Must be a file. Must not be greater than 10240 kilobytes. Example: /tmp/phpfWoYUs

user_id   integer  optional  

The id of an existing record in the users table. Example: 17

document_label   string  optional  

Example: consequatur

title   string  optional  

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

document_type   string  optional  

Example: consequatur

state   string  optional  

Must be 2 characters. Example: mq

expiration_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

completion_date   string  optional  

Must be a valid date. Must be a date before or equal to today. Example: 2020-09-09

signature_files   string  optional  

Example: consequatur

certification_type   string  optional  

Example: consequatur

documentable_type   string  optional  

Example: consequatur

documentable_id   integer  optional  

Example: 17

GET api/documents/download/{document_id}/{filename}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents/download/1/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents/download/1/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/documents/download/{document_id}/{filename}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

filename   string   

Example: consequatur

GET api/documents/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/documents/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the document. Example: 1

Get change request history for a specific document.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents/1/change-history" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents/1/change-history"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/documents/{document_id}/change-history

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

document_id   integer   

The ID of the document. Example: 1

PATCH api/documents/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "document_label=consequatur"\
    --form "document_type=consequatur"\
    --form "state=mqeopfuud"\
    --form "expiration_date=2026-05-14T17:42:32"\
    --form "completion_date=2020-09-09"\
    --form "signature_files=consequatur"\
    --form "certification_type=consequatur"\
    --form "title=consequatur"\
    --form "description=Dolores dolorum amet iste laborum eius est dolor."\
    --form "documentable_type=consequatur"\
    --form "documentable_id=17"\
    --form "file=@/tmp/php0teL1T" 
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('document_label', 'consequatur');
body.append('document_type', 'consequatur');
body.append('state', 'mqeopfuud');
body.append('expiration_date', '2026-05-14T17:42:32');
body.append('completion_date', '2020-09-09');
body.append('signature_files', 'consequatur');
body.append('certification_type', 'consequatur');
body.append('title', 'consequatur');
body.append('description', 'Dolores dolorum amet iste laborum eius est dolor.');
body.append('documentable_type', 'consequatur');
body.append('documentable_id', '17');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "PATCH",
    headers,
    body,
}).then(response => response.json());

Request   

PATCH api/documents/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the document. Example: 1

Body Parameters

document_label   string  optional  

Example: consequatur

document_type   string  optional  

Example: consequatur

state   string  optional  

Must not be greater than 10 characters. Example: mqeopfuud

expiration_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

completion_date   string  optional  

Must be a valid date. Must be a date before or equal to today. Example: 2020-09-09

signature_files   string  optional  

Example: consequatur

certification_type   string  optional  

Example: consequatur

file   file  optional  

Must be a file. Must not be greater than 10240 kilobytes. Example: /tmp/php0teL1T

title   string  optional  

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

documentable_type   string  optional  

Example: consequatur

documentable_id   integer  optional  

Example: 17

DELETE api/documents/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/documents/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/documents/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the document. Example: 1

Get map data for a specific address.

requires authentication

GET /api/google-maps/map-data?address=...

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/google-maps/map-data" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"address\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/google-maps/map-data"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "address": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/google-maps/map-data

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

address   string   

Example: consequatur

Get locations info based on addresses.

requires authentication

POST /api/google-maps/locations/addresses

Expected JSON: { "origin": "123 Main St, Anytown, USA", "locations": [ "456 Oak St, Othertown, USA", "789 Pine St, Thistown, USA" ], "sort_by": "distance" // optional, or "drive_time" }

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/google-maps/locations/addresses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"origin\": \"consequatur\",
    \"locations\": [
        \"consequatur\"
    ],
    \"sort_by\": \"distance\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/google-maps/locations/addresses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "origin": "consequatur",
    "locations": [
        "consequatur"
    ],
    "sort_by": "distance"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/google-maps/locations/addresses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

origin   string   

Example: consequatur

locations   string[]   
sort_by   string  optional  

Example: distance

Must be one of:
  • distance
  • drive_time

Get locations info based on coordinates.

requires authentication

POST /api/google-maps/locations/coordinates

Expected JSON: { "origin": {"lat": 37.421, "lng": -122.083}, "locations": [ {"lat": 37.422, "lng": -122.084}, {"lat": 37.423, "lng": -122.085} ], "sort_by": "drive_time" // optional, or "distance" }

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/google-maps/locations/coordinates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"origin\": {
        \"lat\": 11613.31890586,
        \"lng\": 11613.31890586
    },
    \"locations\": [
        {
            \"lat\": 11613.31890586,
            \"lng\": 11613.31890586
        }
    ],
    \"sort_by\": \"drive_time\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/google-maps/locations/coordinates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "origin": {
        "lat": 11613.31890586,
        "lng": 11613.31890586
    },
    "locations": [
        {
            "lat": 11613.31890586,
            "lng": 11613.31890586
        }
    ],
    "sort_by": "drive_time"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/google-maps/locations/coordinates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

origin   object   
lat   number   

Example: 11613.31890586

lng   number   

Example: 11613.31890586

locations   object[]   

Must have at least 1 items.
lat   number   

Example: 11613.31890586

lng   number   

Example: 11613.31890586

sort_by   string  optional  

Example: drive_time

Must be one of:
  • distance
  • drive_time

Validate and "correct" an address.

requires authentication

This endpoint accepts a user‑provided address and returns:

Endpoint: GET /api/google-maps/correct-address?address=...

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/google-maps/correct-address" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"address\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/google-maps/correct-address"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "address": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/google-maps/correct-address

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

address   string   

Example: consequatur

POST api/cases/gryphon-activities/{caseModel_id}

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"user\": {
        \"id\": 17
    },
    \"visibility\": \"consequatur\",
    \"parent\": {
        \"id\": 17
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "message": "consequatur",
    "priority": "consequatur",
    "user": {
        "id": 17
    },
    "visibility": "consequatur",
    "parent": {
        "id": 17
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/cases/gryphon-activities/{caseModel_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseModel_id   integer   

The ID of the caseModel. Example: 1

Body Parameters

message   string   

Example: consequatur

priority   string   

Example: consequatur

user   object  optional  
id   integer  optional  

The id of an existing record in the users table. Example: 17

visibility   string   

Example: consequatur

parent   object  optional  
id   integer  optional  

The id of an existing record in the gryphon_activities table. Example: 17

GET api/cases/gryphon-activities/{caseModel_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/gryphon-activities/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search\": \"consequatur\",
    \"start_date\": \"2026-05-14T17:42:32\",
    \"end_date\": \"2026-05-14T17:42:32\",
    \"created_at\": \"2026-05-14T17:42:32\",
    \"activity_type\": \"consequatur\",
    \"priority\": \"consequatur\",
    \"visibility\": \"consequatur\",
    \"user_id\": 17,
    \"parent_id\": 17,
    \"updated_at\": \"2026-05-14T17:42:32\",
    \"page\": 45,
    \"per_page\": 16,
    \"limit\": 5,
    \"offset\": 50,
    \"sort\": \"consequatur\",
    \"order\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/gryphon-activities/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search": "consequatur",
    "start_date": "2026-05-14T17:42:32",
    "end_date": "2026-05-14T17:42:32",
    "created_at": "2026-05-14T17:42:32",
    "activity_type": "consequatur",
    "priority": "consequatur",
    "visibility": "consequatur",
    "user_id": 17,
    "parent_id": 17,
    "updated_at": "2026-05-14T17:42:32",
    "page": 45,
    "per_page": 16,
    "limit": 5,
    "offset": 50,
    "sort": "consequatur",
    "order": "consequatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/cases/gryphon-activities/{caseModel_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseModel_id   integer   

The ID of the caseModel. Example: 1

Body Parameters

search   string  optional  

Example: consequatur

start_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

end_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

created_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

activity_type   string  optional  

Example: consequatur

priority   string  optional  

Example: consequatur

visibility   string  optional  

Example: consequatur

user_id   integer  optional  

Example: 17

parent_id   integer  optional  

Example: 17

updated_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

page   integer  optional  

Must be at least 1. Example: 45

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 16

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 5

offset   integer  optional  

Must be at least 0. Example: 50

sort   string  optional  

Example: consequatur

order   string  optional  

Example: consequatur

people   string  optional  

GET api/cases

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"logic\": \"OR\"
    },
    \"query\": \"vmqeopfuudtdsufvyvddq\",
    \"client_id\": 17,
    \"member_id\": 17,
    \"member\": {
        \"name\": \"mqeopfuudtdsufvyvddqa\"
    },
    \"tag\": [],
    \"due_date\": \"2026-05-14T17:42:32\",
    \"received_date_start\": \"2026-05-14T17:42:32\",
    \"received_date_end\": \"2026-05-14T17:42:32\",
    \"due_date_start\": \"2026-05-14T17:42:32\",
    \"due_date_end\": \"2026-05-14T17:42:32\",
    \"appointment_scheduled_start\": \"2026-05-14T17:42:32\",
    \"appointment_scheduled_end\": \"2107-06-13\",
    \"safety_flag\": \"mqeopfuudtdsufvyvddqa\",
    \"member_address\": \"mniihfqcoynlazghdtqtq\",
    \"date_range\": [
        \"2026-05-14T17:42:32\"
    ],
    \"page\": 81,
    \"per_page\": 2,
    \"limit\": 1,
    \"offset\": 33,
    \"sort\": \"consequatur\",
    \"order\": \"consequatur\",
    \"status\": \"scheduled\",
    \"search_by_tag\": \"mqeopfuudtdsufvyvddqa\",
    \"case_types\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filters": {
        "logic": "OR"
    },
    "query": "vmqeopfuudtdsufvyvddq",
    "client_id": 17,
    "member_id": 17,
    "member": {
        "name": "mqeopfuudtdsufvyvddqa"
    },
    "tag": [],
    "due_date": "2026-05-14T17:42:32",
    "received_date_start": "2026-05-14T17:42:32",
    "received_date_end": "2026-05-14T17:42:32",
    "due_date_start": "2026-05-14T17:42:32",
    "due_date_end": "2026-05-14T17:42:32",
    "appointment_scheduled_start": "2026-05-14T17:42:32",
    "appointment_scheduled_end": "2107-06-13",
    "safety_flag": "mqeopfuudtdsufvyvddqa",
    "member_address": "mniihfqcoynlazghdtqtq",
    "date_range": [
        "2026-05-14T17:42:32"
    ],
    "page": 81,
    "per_page": 2,
    "limit": 1,
    "offset": 33,
    "sort": "consequatur",
    "order": "consequatur",
    "status": "scheduled",
    "search_by_tag": "mqeopfuudtdsufvyvddqa",
    "case_types": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/cases

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

filters   object  optional  
logic   string  optional  

This field is required when filters is present. Example: OR

Must be one of:
  • AND
  • OR
conditions   object  optional  

This field is required when filters is present. Must have at least 1 items.

query   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

case_types   object[]  optional  
id   integer  optional  

Example: 17

client_id   integer  optional  

Example: 17

member_id   integer  optional  

Example: 17

member   object  optional  
name   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

assigned_to   string  optional  

The id of an existing record in the users table.

created_by   string  optional  

The id of an existing record in the users table.

updated_by   string  optional  

The id of an existing record in the users table.

tag_string   string  optional  

The name of an existing record in the tags table.

tag   object  optional  
id   string  optional  

The id of an existing record in the tags table.

due_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

received_date_start   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

received_date_end   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

due_date_start   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

due_date_end   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

appointment_scheduled_start   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

appointment_scheduled_end   string  optional  

Must be a valid date. Must be a date after or equal to appointment_scheduled_start. Example: 2107-06-13

safety_flag   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

reviewer   string  optional  

The id of an existing record in the users table.

assessor   string  optional  

The id of an existing record in the users table.

member_address   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

date_range   string[]  optional  

Must be a valid date.

page   integer  optional  

Must be at least 1. Example: 81

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 2

limit   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 1

offset   integer  optional  

Must be at least 0. Example: 33

sort   string  optional  

Example: consequatur

order   string  optional  

Example: consequatur

status   string  optional  

Example: scheduled

Must be one of:
  • open
  • closed
  • pending
  • in_progress
  • draft
  • submitted
  • received
  • assigned
  • scheduled
  • assessing
  • reviewing
  • completed
  • on_hold
  • cancelled
  • paused
search_by_tag   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"logic\": \"AND\"
    },
    \"query\": \"vmqeopfuudtdsufvyvddq\",
    \"client_id\": 17,
    \"member_id\": 17,
    \"member\": {
        \"name\": \"mqeopfuudtdsufvyvddqa\"
    },
    \"tag\": [],
    \"due_date\": \"2026-05-14T17:42:32\",
    \"received_date_start\": \"2026-05-14T17:42:32\",
    \"received_date_end\": \"2026-05-14T17:42:32\",
    \"due_date_start\": \"2026-05-14T17:42:32\",
    \"due_date_end\": \"2026-05-14T17:42:32\",
    \"appointment_scheduled_start\": \"2026-05-14T17:42:32\",
    \"appointment_scheduled_end\": \"2107-06-13\",
    \"safety_flag\": \"mqeopfuudtdsufvyvddqa\",
    \"member_address\": \"mniihfqcoynlazghdtqtq\",
    \"date_range\": [
        \"2026-05-14T17:42:32\"
    ],
    \"page\": 81,
    \"per_page\": 2,
    \"limit\": 1,
    \"offset\": 33,
    \"sort\": \"consequatur\",
    \"order\": \"consequatur\",
    \"status\": \"draft\",
    \"search_by_tag\": \"mqeopfuudtdsufvyvddqa\",
    \"case_types\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/search"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filters": {
        "logic": "AND"
    },
    "query": "vmqeopfuudtdsufvyvddq",
    "client_id": 17,
    "member_id": 17,
    "member": {
        "name": "mqeopfuudtdsufvyvddqa"
    },
    "tag": [],
    "due_date": "2026-05-14T17:42:32",
    "received_date_start": "2026-05-14T17:42:32",
    "received_date_end": "2026-05-14T17:42:32",
    "due_date_start": "2026-05-14T17:42:32",
    "due_date_end": "2026-05-14T17:42:32",
    "appointment_scheduled_start": "2026-05-14T17:42:32",
    "appointment_scheduled_end": "2107-06-13",
    "safety_flag": "mqeopfuudtdsufvyvddqa",
    "member_address": "mniihfqcoynlazghdtqtq",
    "date_range": [
        "2026-05-14T17:42:32"
    ],
    "page": 81,
    "per_page": 2,
    "limit": 1,
    "offset": 33,
    "sort": "consequatur",
    "order": "consequatur",
    "status": "draft",
    "search_by_tag": "mqeopfuudtdsufvyvddqa",
    "case_types": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Export cases to CSV.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"logic\": \"AND\"
    },
    \"query\": \"vmqeopfuudtdsufvyvddq\",
    \"client_id\": 17,
    \"member_id\": 17,
    \"member\": {
        \"name\": \"mqeopfuudtdsufvyvddqa\"
    },
    \"tag\": [],
    \"due_date\": \"2026-05-14T17:42:32\",
    \"received_date_start\": \"2026-05-14T17:42:32\",
    \"received_date_end\": \"2026-05-14T17:42:32\",
    \"due_date_start\": \"2026-05-14T17:42:32\",
    \"due_date_end\": \"2026-05-14T17:42:32\",
    \"safety_flag\": \"mniihfqcoynlazghdtqtq\",
    \"member_address\": \"xbajwbpilpmufinllwloa\",
    \"status\": \"reviewing\",
    \"sort_by\": \"uydlsmsjuryvojcybzvrb\",
    \"sort_order\": \"desc\",
    \"fields\": [
        \"yickznkygloigmkwxphlv\"
    ],
    \"field_order\": [
        \"azjrcnfbaqywuxhgjjmzu\"
    ],
    \"case_types\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/export"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filters": {
        "logic": "AND"
    },
    "query": "vmqeopfuudtdsufvyvddq",
    "client_id": 17,
    "member_id": 17,
    "member": {
        "name": "mqeopfuudtdsufvyvddqa"
    },
    "tag": [],
    "due_date": "2026-05-14T17:42:32",
    "received_date_start": "2026-05-14T17:42:32",
    "received_date_end": "2026-05-14T17:42:32",
    "due_date_start": "2026-05-14T17:42:32",
    "due_date_end": "2026-05-14T17:42:32",
    "safety_flag": "mniihfqcoynlazghdtqtq",
    "member_address": "xbajwbpilpmufinllwloa",
    "status": "reviewing",
    "sort_by": "uydlsmsjuryvojcybzvrb",
    "sort_order": "desc",
    "fields": [
        "yickznkygloigmkwxphlv"
    ],
    "field_order": [
        "azjrcnfbaqywuxhgjjmzu"
    ],
    "case_types": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/cases/export

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

filters   object  optional  
logic   string  optional  

This field is required when filters is present. Example: AND

Must be one of:
  • AND
  • OR
conditions   object  optional  

This field is required when filters is present. Must have at least 1 items.

query   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

case_types   object[]  optional  
id   integer  optional  

Example: 17

client_id   integer  optional  

Example: 17

member_id   integer  optional  

Example: 17

member   object  optional  
name   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

assigned_to   string  optional  

The id of an existing record in the users table.

created_by   string  optional  

The id of an existing record in the users table.

updated_by   string  optional  

The id of an existing record in the users table.

tag_string   string  optional  

The name of an existing record in the tags table.

tag   object  optional  
id   string  optional  

The id of an existing record in the tags table.

due_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

received_date_start   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

received_date_end   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

due_date_start   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

due_date_end   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

safety_flag   string  optional  

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

reviewer   string  optional  

The id of an existing record in the users table.

assessor   string  optional  

The id of an existing record in the users table.

member_address   string  optional  

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

status   string  optional  

Example: reviewing

Must be one of:
  • draft
  • submitted
  • received
  • assigned
  • scheduled
  • assessing
  • reviewing
  • completed
  • on_hold
  • cancelled
  • paused
sort_by   string  optional  

Must not be greater than 255 characters. Example: uydlsmsjuryvojcybzvrb

sort_order   string  optional  

Example: desc

Must be one of:
  • asc
  • desc
fields   string[]  optional  

Must not be greater than 255 characters.

field_order   string[]  optional  

Must not be greater than 255 characters.

POST api/cases

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unique_id\": \"vmqeopfuudtdsufvyvddq\",
    \"client_id\": 17,
    \"member_id\": 17,
    \"line_of_business_id\": 17,
    \"case_class_id\": 17,
    \"due_date\": \"2026-05-14T17:42:32\",
    \"status\": \"paused\",
    \"is_appeal\": true,
    \"case_types\": [
        {
            \"id\": 17
        }
    ],
    \"diagnostic_codes\": [
        {
            \"id\": 17
        }
    ],
    \"documents\": [
        {
            \"id\": 17,
            \"description\": \"Dolorum amet iste laborum eius est dolor.\",
            \"title\": \"dtdsufvyvddqamniihfqc\"
        }
    ],
    \"tags\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "unique_id": "vmqeopfuudtdsufvyvddq",
    "client_id": 17,
    "member_id": 17,
    "line_of_business_id": 17,
    "case_class_id": 17,
    "due_date": "2026-05-14T17:42:32",
    "status": "paused",
    "is_appeal": true,
    "case_types": [
        {
            "id": 17
        }
    ],
    "diagnostic_codes": [
        {
            "id": 17
        }
    ],
    "documents": [
        {
            "id": 17,
            "description": "Dolorum amet iste laborum eius est dolor.",
            "title": "dtdsufvyvddqamniihfqc"
        }
    ],
    "tags": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/cases

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

unique_id   string   

Must match the regex /^[a-zA-Z0-9-_.]+$/. Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

case_types   object[]  optional  
id   integer  optional  

The id of an existing record in the case_types table. Example: 17

client_id   integer  optional  

The id of an existing record in the clients table. Example: 17

member_id   integer  optional  

The id of an existing record in the members table. Example: 17

line_of_business_id   integer  optional  

The id of an existing record in the lines_of_businesses table. Example: 17

case_class_id   integer  optional  

The id of an existing record in the case_classifications table. Example: 17

diagnostic_codes   object[]  optional  
id   integer  optional  

The id of an existing record in the diagnostic_codes table. Example: 17

due_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

status   string  optional  

Example: paused

Must be one of:
  • draft
  • submitted
  • received
  • assigned
  • scheduled
  • assessing
  • reviewing
  • completed
  • on_hold
  • cancelled
  • paused
tags   object[]  optional  
id   integer  optional  

The id of an existing record in the tags table. Example: 17

is_appeal   boolean  optional  

Example: true

documents   object[]  optional  
id   integer  optional  

The id of an existing record in the documents table. Example: 17

description   string  optional  

Must not be greater than 255 characters. Example: Dolorum amet iste laborum eius est dolor.

title   string  optional  

Must not be greater than 255 characters. Example: dtdsufvyvddqamniihfqc

GET api/cases/{caseModel_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/cases/{caseModel_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseModel_id   integer   

The ID of the caseModel. Example: 1

PATCH api/cases/{caseModel_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unique_id\": \"vmqeopfuudtdsufvyvddq\",
    \"client_id\": 17,
    \"member_id\": 17,
    \"line_of_business_id\": 17,
    \"case_class_id\": 17,
    \"due_date\": \"2026-05-14T17:42:32\",
    \"status\": \"assigned\",
    \"is_appeal\": false,
    \"case_types\": [
        {
            \"id\": 17
        }
    ],
    \"diagnostic_codes\": [
        {
            \"id\": 17
        }
    ],
    \"documents\": [
        {
            \"id\": 17,
            \"description\": \"Dolorum amet iste laborum eius est dolor.\",
            \"title\": \"dtdsufvyvddqamniihfqc\"
        }
    ],
    \"tags\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "unique_id": "vmqeopfuudtdsufvyvddq",
    "client_id": 17,
    "member_id": 17,
    "line_of_business_id": 17,
    "case_class_id": 17,
    "due_date": "2026-05-14T17:42:32",
    "status": "assigned",
    "is_appeal": false,
    "case_types": [
        {
            "id": 17
        }
    ],
    "diagnostic_codes": [
        {
            "id": 17
        }
    ],
    "documents": [
        {
            "id": 17,
            "description": "Dolorum amet iste laborum eius est dolor.",
            "title": "dtdsufvyvddqamniihfqc"
        }
    ],
    "tags": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/cases/{caseModel_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseModel_id   integer   

The ID of the caseModel. Example: 1

Body Parameters

unique_id   string  optional  

Must match the regex /^[a-zA-Z0-9-_.]+$/. Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

case_types   object[]  optional  
id   integer  optional  

The id of an existing record in the case_types table. Example: 17

client_id   integer  optional  

The id of an existing record in the clients table. Example: 17

member_id   integer  optional  

The id of an existing record in the members table. Example: 17

line_of_business_id   integer  optional  

The id of an existing record in the lines_of_businesses table. Example: 17

case_class_id   integer  optional  

The id of an existing record in the case_classifications table. Example: 17

diagnostic_codes   object[]  optional  
id   integer  optional  

The id of an existing record in the diagnostic_codes table. Example: 17

due_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

status   string  optional  

Example: assigned

Must be one of:
  • draft
  • submitted
  • received
  • assigned
  • scheduled
  • assessing
  • reviewing
  • completed
  • on_hold
  • cancelled
  • paused
tags   object[]  optional  
id   integer  optional  

The id of an existing record in the tags table. Example: 17

is_appeal   boolean  optional  

Example: false

documents   object[]  optional  
id   integer  optional  

The id of an existing record in the documents table. Example: 17

description   string  optional  

Must not be greater than 255 characters. Example: Dolorum amet iste laborum eius est dolor.

title   string  optional  

Must not be greater than 255 characters. Example: dtdsufvyvddqamniihfqc

DELETE api/cases/{caseModel_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/cases/{caseModel_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseModel_id   integer   

The ID of the caseModel. Example: 1

POST api/cases/{caseModel_id}/documents

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/1/documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unique_id\": \"vmqeopfuudtdsufvyvddq\",
    \"client_id\": 17,
    \"member_id\": 17,
    \"line_of_business_id\": 17,
    \"case_class_id\": 17,
    \"due_date\": \"2026-05-14T17:42:32\",
    \"status\": \"on_hold\",
    \"is_appeal\": false,
    \"case_types\": [
        {
            \"id\": 17
        }
    ],
    \"diagnostic_codes\": [
        {
            \"id\": 17
        }
    ],
    \"documents\": [
        {
            \"id\": 17,
            \"description\": \"Dolorum amet iste laborum eius est dolor.\",
            \"title\": \"dtdsufvyvddqamniihfqc\"
        }
    ],
    \"tags\": [
        {
            \"id\": 17
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/1/documents"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "unique_id": "vmqeopfuudtdsufvyvddq",
    "client_id": 17,
    "member_id": 17,
    "line_of_business_id": 17,
    "case_class_id": 17,
    "due_date": "2026-05-14T17:42:32",
    "status": "on_hold",
    "is_appeal": false,
    "case_types": [
        {
            "id": 17
        }
    ],
    "diagnostic_codes": [
        {
            "id": 17
        }
    ],
    "documents": [
        {
            "id": 17,
            "description": "Dolorum amet iste laborum eius est dolor.",
            "title": "dtdsufvyvddqamniihfqc"
        }
    ],
    "tags": [
        {
            "id": 17
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/cases/{caseModel_id}/documents

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseModel_id   integer   

The ID of the caseModel. Example: 1

Body Parameters

unique_id   string  optional  

Must match the regex /^[a-zA-Z0-9-_.]+$/. Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

case_types   object[]  optional  
id   integer  optional  

The id of an existing record in the case_types table. Example: 17

client_id   integer  optional  

The id of an existing record in the clients table. Example: 17

member_id   integer  optional  

The id of an existing record in the members table. Example: 17

line_of_business_id   integer  optional  

The id of an existing record in the lines_of_businesses table. Example: 17

case_class_id   integer  optional  

The id of an existing record in the case_classifications table. Example: 17

diagnostic_codes   object[]  optional  
id   integer  optional  

The id of an existing record in the diagnostic_codes table. Example: 17

due_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

status   string  optional  

Example: on_hold

Must be one of:
  • draft
  • submitted
  • received
  • assigned
  • scheduled
  • assessing
  • reviewing
  • completed
  • on_hold
  • cancelled
  • paused
tags   object[]  optional  
id   integer  optional  

The id of an existing record in the tags table. Example: 17

is_appeal   boolean  optional  

Example: false

documents   object[]  optional  
id   integer  optional  

The id of an existing record in the documents table. Example: 17

description   string  optional  

Must not be greater than 255 characters. Example: Dolorum amet iste laborum eius est dolor.

title   string  optional  

Must not be greater than 255 characters. Example: dtdsufvyvddqamniihfqc

DELETE api/cases/{caseModel_id}/documents/{document_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/1/documents/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/cases/1/documents/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/cases/{caseModel_id}/documents/{document_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseModel_id   integer   

The ID of the caseModel. Example: 1

document_id   integer   

The ID of the document. Example: 1

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clinician-blackouts

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clinician-blackouts/{clinicianBlackout_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicianBlackout_id   integer   

The ID of the clinicianBlackout. Example: 1

Return all blackout dates for a specific clinician (including computed occurrences).

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts/clinician/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts/clinician/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/clinician-blackouts/clinician/{clinicianId}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicianId   string   

Example: consequatur

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"clinician_id\": \"consequatur\",
    \"start_date\": \"2026-05-14T17:42:32\",
    \"start_time\": \"17:42\",
    \"end_date\": \"2107-06-13\",
    \"end_time\": \"17:42\",
    \"is_recurring\": \"1\",
    \"recurrence_details\": {
        \"pattern\": \"weekly_friday\",
        \"custom\": {
            \"repeat_interval_type\": \"month\",
            \"repeat_interval_difference\": 45,
            \"repeat_days\": [
                \"Thu\"
            ],
            \"repeat_dates\": [
                1
            ]
        },
        \"ending_date\": \"2026-05-14T17:42:32\",
        \"ending_ocurrences_count\": 17
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "clinician_id": "consequatur",
    "start_date": "2026-05-14T17:42:32",
    "start_time": "17:42",
    "end_date": "2107-06-13",
    "end_time": "17:42",
    "is_recurring": "1",
    "recurrence_details": {
        "pattern": "weekly_friday",
        "custom": {
            "repeat_interval_type": "month",
            "repeat_interval_difference": 45,
            "repeat_days": [
                "Thu"
            ],
            "repeat_dates": [
                1
            ]
        },
        "ending_date": "2026-05-14T17:42:32",
        "ending_ocurrences_count": 17
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clinician-blackouts

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

clinician_id   string   

The id of an existing record in the users table. Example: consequatur

start_date   string   

Must be a valid date. Example: 2026-05-14T17:42:32

start_time   string  optional  

Must be a valid date in the format H:i. Example: 17:42

end_date   string   

Must be a valid date. Must be a date after or equal to start_date. Example: 2107-06-13

end_time   string  optional  

Must be a valid date in the format H:i. Example: 17:42

is_recurring   string   

Example: 1

Must be one of:
  • 0
  • 1
recurrence_details   object  optional  
pattern   string  optional  

This field is required when is_recurring is 1. Example: weekly_friday

Must be one of:
  • daily
  • weekly_friday
  • monthly_first_friday
  • monthly_last_friday
  • custom
custom   object  optional  
repeat_interval_type   string  optional  

This field is required when recurrence_details.pattern is custom. Example: month

Must be one of:
  • day
  • week
  • month
repeat_interval_difference   integer  optional  

This field is required when recurrence_details.pattern is custom. Must be at least 1. Example: 45

repeat_days   string[]  optional  

This field is required when recurrence_details.custom.repeat_interval_type is week.

Must be one of:
  • Mon
  • Tue
  • Wed
  • Thu
  • Fri
  • Sat
  • Sun
repeat_dates   integer[]  optional  

This field is required when recurrence_details.custom.repeat_interval_type is month. Must be between 1 and 31.

ending_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

ending_ocurrences_count   integer  optional  

Example: 17

recurrence   string[]  optional  

This field is required when recurrence is custom.

Update the specified resource in storage.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-05-14T17:42:32\",
    \"start_time\": \"17:42\",
    \"end_date\": \"2107-06-13\",
    \"end_time\": \"17:42\",
    \"is_recurring\": \"0\",
    \"recurrence_details\": {
        \"pattern\": \"custom\",
        \"custom\": {
            \"repeat_interval_type\": \"day\",
            \"repeat_interval_difference\": 17,
            \"repeat_days\": [
                \"Thu\"
            ],
            \"repeat_dates\": [
                13
            ]
        },
        \"ending_date\": \"2026-05-14T17:42:32\",
        \"ending_ocurrences_count\": 17
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "start_date": "2026-05-14T17:42:32",
    "start_time": "17:42",
    "end_date": "2107-06-13",
    "end_time": "17:42",
    "is_recurring": "0",
    "recurrence_details": {
        "pattern": "custom",
        "custom": {
            "repeat_interval_type": "day",
            "repeat_interval_difference": 17,
            "repeat_days": [
                "Thu"
            ],
            "repeat_dates": [
                13
            ]
        },
        "ending_date": "2026-05-14T17:42:32",
        "ending_ocurrences_count": 17
    }
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/clinician-blackouts/{clinicianBlackout_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicianBlackout_id   integer   

The ID of the clinicianBlackout. Example: 1

Body Parameters

clinician_id   string  optional  

The id of an existing record in the users table.

start_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

start_time   string  optional  

Must be a valid date in the format H:i. Example: 17:42

end_date   string  optional  

Must be a valid date. Must be a date after or equal to start_date. Example: 2107-06-13

end_time   string  optional  

Must be a valid date in the format H:i. Example: 17:42

is_recurring   string  optional  

Example: 0

Must be one of:
  • 0
  • 1
recurrence_details   object  optional  
pattern   string  optional  

This field is required when is_recurring is 1. Example: custom

Must be one of:
  • daily
  • weekly_friday
  • monthly_first_friday
  • monthly_last_friday
  • custom
custom   object  optional  
repeat_interval_type   string  optional  

This field is required when recurrence_details.pattern is custom. Example: day

Must be one of:
  • day
  • week
  • month
repeat_interval_difference   integer  optional  

This field is required when recurrence_details.pattern is custom. Example: 17

repeat_days   string[]  optional  

This field is required when recurrence_details.custom.repeat_interval_type is week.

Must be one of:
  • Mon
  • Tue
  • Wed
  • Thu
  • Fri
  • Sat
  • Sun
repeat_dates   integer[]  optional  

This field is required when recurrence_details.custom.repeat_interval_type is month. Must be at least 1. Must not be greater than 31.

ending_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

ending_ocurrences_count   integer  optional  

Example: 17

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinician-blackouts/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/clinician-blackouts/{clinicianBlackout_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicianBlackout_id   integer   

The ID of the clinicianBlackout. Example: 1

GET api/invoices

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoices" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoices"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/invoices

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/invoices

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoices" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invoice_number\": \"consequatur\",
    \"member_id\": \"consequatur\",
    \"client_id\": \"consequatur\",
    \"invoice_date\": \"2026-05-14T17:42:32\",
    \"due_date\": \"2107-06-13\",
    \"status\": \"sent\",
    \"created_by\": \"consequatur\",
    \"sent_on\": \"2026-05-14T17:42:32\",
    \"notes\": \"consequatur\",
    \"quickbooks_ref\": \"consequatur\",
    \"addresses\": [
        {
            \"type\": \"billing\",
            \"line_1\": \"consequatur\",
            \"line_2\": \"consequatur\",
            \"city\": \"consequatur\",
            \"state\": \"consequatur\",
            \"zip_code\": \"consequatur\",
            \"country\": \"consequatur\",
            \"contact_name\": \"consequatur\",
            \"contact_phone\": \"consequatur\",
            \"contact_email\": \"carolyne.luettgen@example.org\"
        }
    ],
    \"line_items\": [
        {
            \"case_id\": \"consequatur\",
            \"line_amount\": 45,
            \"line_tax\": 56,
            \"status\": \"closed\",
            \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoices"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "invoice_number": "consequatur",
    "member_id": "consequatur",
    "client_id": "consequatur",
    "invoice_date": "2026-05-14T17:42:32",
    "due_date": "2107-06-13",
    "status": "sent",
    "created_by": "consequatur",
    "sent_on": "2026-05-14T17:42:32",
    "notes": "consequatur",
    "quickbooks_ref": "consequatur",
    "addresses": [
        {
            "type": "billing",
            "line_1": "consequatur",
            "line_2": "consequatur",
            "city": "consequatur",
            "state": "consequatur",
            "zip_code": "consequatur",
            "country": "consequatur",
            "contact_name": "consequatur",
            "contact_phone": "consequatur",
            "contact_email": "carolyne.luettgen@example.org"
        }
    ],
    "line_items": [
        {
            "case_id": "consequatur",
            "line_amount": 45,
            "line_tax": 56,
            "status": "closed",
            "description": "Dolores dolorum amet iste laborum eius est dolor."
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/invoices

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

invoice_number   string   

Example: consequatur

member_id   string   

The id of an existing record in the members table. Example: consequatur

client_id   string   

The id of an existing record in the clients table. Example: consequatur

invoice_date   string   

Must be a valid date. Example: 2026-05-14T17:42:32

due_date   string  optional  

Must be a valid date. Must be a date after or equal to invoice_date. Example: 2107-06-13

status   string   

Example: sent

Must be one of:
  • draft
  • sent
  • paid
  • overdue
created_by   string   

The id of an existing record in the users table. Example: consequatur

sent_on   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

notes   string  optional  

Example: consequatur

quickbooks_ref   string  optional  

Example: consequatur

addresses   object[]   

Must have at least 1 items.
type   string   

Example: billing

Must be one of:
  • billing
  • shipping
address_id   string  optional  

The address_id of an existing record in the address_client table.

line_1   string  optional  

This field is required when addresses.*.address_id is not present. Example: consequatur

line_2   string  optional  

Example: consequatur

city   string  optional  

This field is required when addresses.*.address_id is not present. Example: consequatur

state   string  optional  

Example: consequatur

zip_code   string  optional  

Example: consequatur

country   string  optional  

Example: consequatur

contact_name   string  optional  

Example: consequatur

contact_phone   string  optional  

Example: consequatur

contact_email   string  optional  

Must be a valid email address. Example: carolyne.luettgen@example.org

line_items   object[]   

Must have at least 1 items.
case_id   string   

Example: consequatur

line_amount   number   

Must be at least 0. Example: 45

line_tax   number  optional  

Must be at least 0. Example: 56

status   string  optional  

Example: closed

Must be one of:
  • pending
  • billable
  • paid
  • closed
description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

GET api/invoices/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoices/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoices/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/invoices/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the invoice. Example: 17

PATCH api/invoices/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoices/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invoice_number\": \"consequatur\",
    \"invoice_date\": \"2026-05-14T17:42:32\",
    \"due_date\": \"2107-06-13\",
    \"status\": \"paid\",
    \"sent_on\": \"2026-05-14T17:42:32\",
    \"notes\": \"consequatur\",
    \"quickbooks_ref\": \"consequatur\",
    \"addresses\": [
        {
            \"type\": \"billing\",
            \"line_1\": \"consequatur\",
            \"line_2\": \"consequatur\",
            \"city\": \"consequatur\",
            \"state\": \"consequatur\",
            \"zip_code\": \"consequatur\",
            \"country\": \"consequatur\",
            \"contact_name\": \"consequatur\",
            \"contact_phone\": \"consequatur\",
            \"contact_email\": \"carolyne.luettgen@example.org\"
        }
    ],
    \"line_items\": [
        {
            \"line_amount\": 19,
            \"line_tax\": 70,
            \"status\": \"paid\",
            \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoices/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "invoice_number": "consequatur",
    "invoice_date": "2026-05-14T17:42:32",
    "due_date": "2107-06-13",
    "status": "paid",
    "sent_on": "2026-05-14T17:42:32",
    "notes": "consequatur",
    "quickbooks_ref": "consequatur",
    "addresses": [
        {
            "type": "billing",
            "line_1": "consequatur",
            "line_2": "consequatur",
            "city": "consequatur",
            "state": "consequatur",
            "zip_code": "consequatur",
            "country": "consequatur",
            "contact_name": "consequatur",
            "contact_phone": "consequatur",
            "contact_email": "carolyne.luettgen@example.org"
        }
    ],
    "line_items": [
        {
            "line_amount": 19,
            "line_tax": 70,
            "status": "paid",
            "description": "Dolores dolorum amet iste laborum eius est dolor."
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/invoices/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the invoice. Example: 17

Body Parameters

invoice_number   string  optional  

Example: consequatur

member_id   string  optional  

The id of an existing record in the members table.

client_id   string  optional  

The id of an existing record in the clients table.

invoice_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

due_date   string  optional  

Must be a valid date. Must be a date after or equal to invoice_date. Example: 2107-06-13

status   string  optional  

Example: paid

Must be one of:
  • draft
  • sent
  • paid
  • overdue
created_by   string  optional  

The id of an existing record in the users table.

sent_on   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

notes   string  optional  

Example: consequatur

quickbooks_ref   string  optional  

Example: consequatur

addresses   object[]  optional  

Must have at least 1 items.
type   string  optional  

This field is required when addresses is present. Example: billing

Must be one of:
  • billing
  • shipping
address_id   string  optional  

The address_id of an existing record in the address_client table.

line_1   string  optional  

This field is required when addresses.*.address_id is not present. Example: consequatur

line_2   string  optional  

Example: consequatur

city   string  optional  

This field is required when addresses.*.address_id is not present. Example: consequatur

state   string  optional  

Example: consequatur

zip_code   string  optional  

Example: consequatur

country   string  optional  

Example: consequatur

contact_name   string  optional  

Example: consequatur

contact_phone   string  optional  

Example: consequatur

contact_email   string  optional  

Must be a valid email address. Example: carolyne.luettgen@example.org

line_items   object[]  optional  

Must have at least 1 items.
case_id   string  optional  

This field is required when line_items is present.

line_amount   number  optional  

This field is required when line_items is present. Must be at least 0. Example: 19

line_tax   number  optional  

This field is required when line_items is present. Must be at least 0. Example: 70

status   string  optional  

Example: paid

Must be one of:
  • pending
  • billable
  • paid
  • closed
description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

DELETE api/invoices/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoices/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoices/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/invoices/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the invoice. Example: 17

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-assignments

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"case_id\": 17,
    \"case\": {
        \"id\": 17
    },
    \"assignee_type\": \"observer\",
    \"status\": \"consequatur\",
    \"assignee_id\": 17,
    \"assignee\": {
        \"id\": 17
    },
    \"completed_at\": \"2026-05-14\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "case_id": 17,
    "case": {
        "id": 17
    },
    "assignee_type": "observer",
    "status": "consequatur",
    "assignee_id": 17,
    "assignee": {
        "id": 17
    },
    "completed_at": "2026-05-14"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/case-assignments

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

case_id   integer  optional  

This field is required when case.id is not present. The id of an existing record in the cases table. Example: 17

case   object  optional  
id   integer  optional  

This field is required when case_id is not present. The id of an existing record in the cases table. Example: 17

assignee_type   string   

Example: observer

Must be one of:
  • reviewer
  • approver
  • observer
  • clinician
status   string  optional  

Example: consequatur

assignee_id   integer  optional  

This field is required when assignee.id is not present. The id of an existing record in the users table. Example: 17

assignee   object  optional  
id   integer  optional  

This field is required when assignee_id is not present. The id of an existing record in the users table. Example: 17

completed_at   string  optional  

Must be a valid date in the format Y-m-d. Example: 2026-05-14

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments/search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments/search"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Display the count of case assignments.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments/mine" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments/mine"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-assignments/mine

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-assignments/{caseAssignment_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseAssignment_id   integer   

The ID of the caseAssignment. Example: 17

Update the specified resource in storage.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"assignee_type\": \"reviewer\",
    \"status\": \"consequatur\",
    \"assignee_id\": 17,
    \"assignee\": {
        \"id\": 17
    },
    \"completed_at\": \"2026-05-14\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "assignee_type": "reviewer",
    "status": "consequatur",
    "assignee_id": 17,
    "assignee": {
        "id": 17
    },
    "completed_at": "2026-05-14"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/case-assignments/{caseAssignment_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseAssignment_id   integer   

The ID of the caseAssignment. Example: 17

Body Parameters

assignee_type   string   

Example: reviewer

Must be one of:
  • reviewer
  • approver
  • observer
  • clinician
status   string  optional  

Example: consequatur

assignee_id   integer  optional  

The id of an existing record in the users table. Example: 17

assignee   object  optional  
id   integer  optional  

The id of an existing record in the users table. Example: 17

completed_at   string  optional  

Must be a valid date in the format Y-m-d. Example: 2026-05-14

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-assignments/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/case-assignments/{caseAssignment_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseAssignment_id   integer   

The ID of the caseAssignment. Example: 17

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-appointments

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Show by case ID.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments/case/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments/case/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-appointments/case/{case_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

case_id   integer   

The ID of the case. Example: 1

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"case_id\": 17,
    \"case\": {
        \"id\": 17
    },
    \"appointment_date\": \"2026-05-14T17:42:32\",
    \"appointment_time_start\": \"17:42\",
    \"appointment_time_end\": \"17:42\",
    \"status\": \"cancelled\",
    \"comment\": \"mqeopfuudtdsufvyvddqa\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "case_id": 17,
    "case": {
        "id": 17
    },
    "appointment_date": "2026-05-14T17:42:32",
    "appointment_time_start": "17:42",
    "appointment_time_end": "17:42",
    "status": "cancelled",
    "comment": "mqeopfuudtdsufvyvddqa"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/case-appointments

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

case_id   integer  optional  

This field is required when case.id is not present. The id of an existing record in the cases table. Example: 17

case   object  optional  
id   integer  optional  

This field is required when case_id is not present. The id of an existing record in the cases table. Example: 17

appointment_date   string   

Must be a valid date. Example: 2026-05-14T17:42:32

appointment_time_start   string  optional  

Must be a valid date in the format H:i. Example: 17:42

appointment_time_end   string  optional  

Must be a valid date in the format H:i. Example: 17:42

status   string  optional  

Example: cancelled

Must be one of:
  • scheduled
  • rescheduled
  • completed
  • cancelled
  • no_show
comment   string  optional  

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/case-appointments/{caseAppointment_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseAppointment_id   integer   

The ID of the caseAppointment. Example: 17

Update the specified resource in storage.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"appointment_date\": \"2026-05-14T17:42:32\",
    \"appointment_time_start\": \"17:42\",
    \"appointment_time_end\": \"17:42\",
    \"comment\": \"vmqeopfuudtdsufvyvddq\",
    \"status\": \"cancelled\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "appointment_date": "2026-05-14T17:42:32",
    "appointment_time_start": "17:42",
    "appointment_time_end": "17:42",
    "comment": "vmqeopfuudtdsufvyvddq",
    "status": "cancelled"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/case-appointments/{caseAppointment_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseAppointment_id   integer   

The ID of the caseAppointment. Example: 17

Body Parameters

appointment_date   string   

Must be a valid date. Example: 2026-05-14T17:42:32

appointment_time_start   string  optional  

Must be a valid date in the format H:i. Example: 17:42

appointment_time_end   string  optional  

Must be a valid date in the format H:i. Example: 17:42

comment   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

status   string  optional  

Example: cancelled

Must be one of:
  • scheduled
  • rescheduled
  • completed
  • cancelled
  • no_show

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/case-appointments/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/case-appointments/{caseAppointment_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

caseAppointment_id   integer   

The ID of the caseAppointment. Example: 17

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/contact-logs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/contact-logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/contact-logs

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Show by case ID.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/contact-logs/case/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/contact-logs/case/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/contact-logs/case/{case_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

case_id   integer   

The ID of the case. Example: 1

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/contact-logs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"case_id\": \"consequatur\",
    \"appointment_scheduled\": true,
    \"not_scheduled_reason\": \"consequatur\",
    \"member_phone\": {
        \"type\": \"consequatur\"
    },
    \"change_initiated_by\": \"consequatur\",
    \"called_at\": \"2026-05-14T17:42:32\",
    \"contacted_by\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/contact-logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "case_id": "consequatur",
    "appointment_scheduled": true,
    "not_scheduled_reason": "consequatur",
    "member_phone": {
        "type": "consequatur"
    },
    "change_initiated_by": "consequatur",
    "called_at": "2026-05-14T17:42:32",
    "contacted_by": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/contact-logs

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

case_id   string   

The id of an existing record in the cases table. Example: consequatur

appointment_scheduled   boolean  optional  

Example: true

not_scheduled_reason   string  optional  

Example: consequatur

member_phone   object  optional  
number   string  optional  

The number of an existing record in the phones table.

id   string  optional  

The id of an existing record in the member_phone table.

type   string  optional  

Example: consequatur

member_id   string  optional  

The id of an existing record in the members table.

change_initiated_by   string  optional  

Example: consequatur

called_at   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

contacted_by   string   

Example: consequatur

case_appointment   string  optional  
id   string  optional  

The id of an existing record in the case_appointments table.

appointment_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

appointment_time_start   string  optional  

Must be a valid date in the format H:i. Example: 17:42

appointment_time_end   string  optional  

Must be a valid date in the format H:i. Example: 17:42

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/contact-logs/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/contact-logs/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/contact-logs/{contactLog_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contactLog_id   integer   

The ID of the contactLog. Example: 17

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/contact-logs/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/contact-logs/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/contact-logs/{contactLog_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

contactLog_id   integer   

The ID of the contactLog. Example: 17

GET api/invoice-expenses

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoice-expenses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoice-expenses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/invoice-expenses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/invoice-expenses

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoice-expenses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"consequatur\",
    \"case_id\": \"consequatur\",
    \"amount\": 45,
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoice-expenses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": "consequatur",
    "case_id": "consequatur",
    "amount": 45,
    "description": "Dolores dolorum amet iste laborum eius est dolor."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/invoice-expenses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   string   

The id of an existing record in the users table. Example: consequatur

case_id   string   

The id of an existing record in the cases table. Example: consequatur

invoice_id   string  optional  

The id of an existing record in the invoices table.

amount   number   

Must be at least 0. Example: 45

description   string   

Example: Dolores dolorum amet iste laborum eius est dolor.

GET api/invoice-expenses/{expense_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoice-expenses/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoice-expenses/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/invoice-expenses/{expense_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense_id   integer   

The ID of the expense. Example: 17

PATCH api/invoice-expenses/{expense_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoice-expenses/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"consequatur\",
    \"case_id\": \"consequatur\",
    \"amount\": 45,
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoice-expenses/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": "consequatur",
    "case_id": "consequatur",
    "amount": 45,
    "description": "Dolores dolorum amet iste laborum eius est dolor."
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/invoice-expenses/{expense_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense_id   integer   

The ID of the expense. Example: 17

Body Parameters

user_id   string   

The id of an existing record in the users table. Example: consequatur

case_id   string   

The id of an existing record in the cases table. Example: consequatur

invoice_id   string  optional  

The id of an existing record in the invoices table.

amount   number   

Must be at least 0. Example: 45

description   string   

Example: Dolores dolorum amet iste laborum eius est dolor.

DELETE api/invoice-expenses/{expense_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoice-expenses/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/invoice-expenses/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/invoice-expenses/{expense_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense_id   integer   

The ID of the expense. Example: 17

GET api/expenses/types

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expenses/types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/expenses/searchable-fields

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/searchable-fields" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/searchable-fields"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expenses/searchable-fields

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/expenses/sortable-fields

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/sortable-fields" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/sortable-fields"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expenses/sortable-fields

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get available status filters for current user.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/available-statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/available-statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expenses/available-statuses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/expenses

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"keyword\": \"vmqeopfuudtdsufvyvddq\",
    \"search\": \"amniihfqcoynlazghdtqt\",
    \"query\": \"qxbajwbpilpmufinllwlo\",
    \"status\": \"submitted\",
    \"case_ids\": [
        17
    ],
    \"expense_type\": \"consequatur\",
    \"user_id\": 17,
    \"incurred_at_from\": \"2026-05-14T17:42:32\",
    \"incurred_at_to\": \"2107-06-13\",
    \"paid_at_from\": \"2026-05-14T17:42:32\",
    \"paid_at_to\": \"2107-06-13\",
    \"created_at_from\": \"2026-05-14T17:42:32\",
    \"created_at_to\": \"2107-06-13\",
    \"amount_min\": 45,
    \"amount_max\": 56,
    \"sort_by\": \"incurred_at\",
    \"sort_order\": \"desc\",
    \"per_page\": 5,
    \"page\": 51
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "keyword": "vmqeopfuudtdsufvyvddq",
    "search": "amniihfqcoynlazghdtqt",
    "query": "qxbajwbpilpmufinllwlo",
    "status": "submitted",
    "case_ids": [
        17
    ],
    "expense_type": "consequatur",
    "user_id": 17,
    "incurred_at_from": "2026-05-14T17:42:32",
    "incurred_at_to": "2107-06-13",
    "paid_at_from": "2026-05-14T17:42:32",
    "paid_at_to": "2107-06-13",
    "created_at_from": "2026-05-14T17:42:32",
    "created_at_to": "2107-06-13",
    "amount_min": 45,
    "amount_max": 56,
    "sort_by": "incurred_at",
    "sort_order": "desc",
    "per_page": 5,
    "page": 51
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expenses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

keyword   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

search   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

query   string  optional  

Must not be greater than 255 characters. Example: qxbajwbpilpmufinllwlo

status   string  optional  

Example: submitted

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
case_ids   integer[]  optional  

The id of an existing record in the cases table.

expense_type   string  optional  

The code of an existing record in the expense_types table. Example: consequatur

user_id   integer  optional  

The id of an existing record in the users table. Example: 17

incurred_at_from   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

incurred_at_to   string  optional  

Must be a valid date. Must be a date after or equal to incurred_at_from. Example: 2107-06-13

paid_at_from   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

paid_at_to   string  optional  

Must be a valid date. Must be a date after or equal to paid_at_from. Example: 2107-06-13

created_at_from   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

created_at_to   string  optional  

Must be a valid date. Must be a date after or equal to created_at_from. Example: 2107-06-13

amount_min   number  optional  

Must be at least 0. Example: 45

amount_max   number  optional  

Must be at least 0. Example: 56

sort_by   string  optional  

Example: incurred_at

Must be one of:
  • created_at
  • updated_at
  • status
  • amount
  • incurred_at
  • paid_at
  • description
  • expense_type
sort_order   string  optional  

Example: desc

Must be one of:
  • asc
  • desc
per_page   integer  optional  

Must be at least -1. Must not be greater than 1000. Example: 5

page   integer  optional  

Must be at least 1. Example: 51

POST api/expenses

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"case_ids\": [
        17
    ],
    \"amount\": 11613.31890586,
    \"category\": \"consequatur\",
    \"description\": \"Dolorum amet iste laborum eius est dolor.\",
    \"expense_type\": \"ppe\",
    \"total_time\": 4,
    \"document_id\": 17,
    \"user_id\": 17,
    \"unit_rate\": 45,
    \"incurred_at\": \"2020-09-09\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "case_ids": [
        17
    ],
    "amount": 11613.31890586,
    "category": "consequatur",
    "description": "Dolorum amet iste laborum eius est dolor.",
    "expense_type": "ppe",
    "total_time": 4,
    "document_id": 17,
    "user_id": 17,
    "unit_rate": 45,
    "incurred_at": "2020-09-09"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/expenses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

case_id   string  optional  
case_ids   integer[]  optional  

The id of an existing record in the cases table.

amount   number  optional  

Example: 11613.31890586

category   string   

Example: consequatur

description   string  optional  

Must not be greater than 255 characters. Example: Dolorum amet iste laborum eius est dolor.

expense_type   string   

Example: ppe

Must be one of:
  • bonus
  • car_rental
  • ceu
  • consult
  • credentialing
  • drive_time
  • flight
  • hotel
  • meal
  • meetings
  • no_show
  • other
  • parking
  • ppe
  • toll
  • training
total_time   number  optional  

Must be at least 0.1. Must not be greater than 24. Example: 4

document_id   integer   

The id of an existing record in the documents table. Example: 17

user_id   integer  optional  

The id of an existing record in the users table. Example: 17

unit_rate   number  optional  

Must be at least 0.01. Example: 45

incurred_at   string   

Must be a valid date in the format Y-m-d H:i:s. Must be a date before or equal to now. Example: 2020-09-09

Export expenses to CSV.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"keyword\": \"vmqeopfuudtdsufvyvddq\",
    \"search\": \"amniihfqcoynlazghdtqt\",
    \"query\": \"qxbajwbpilpmufinllwlo\",
    \"status\": \"canceled\",
    \"case_ids\": [
        17
    ],
    \"expense_type\": \"consequatur\",
    \"user_id\": 17,
    \"incurred_at_from\": \"2026-05-14T17:42:32\",
    \"incurred_at_to\": \"2107-06-13\",
    \"paid_at_from\": \"2026-05-14T17:42:32\",
    \"paid_at_to\": \"2107-06-13\",
    \"created_at_from\": \"2026-05-14T17:42:32\",
    \"created_at_to\": \"2107-06-13\",
    \"amount_min\": 45,
    \"amount_max\": 56,
    \"sort_by\": \"updated_at\",
    \"sort_order\": \"desc\",
    \"per_page\": 5,
    \"page\": 51,
    \"fields\": [
        \"pfuudtdsufvyvddqamnii\"
    ],
    \"field_order\": [
        \"hfqcoynlazghdtqtqxbaj\"
    ],
    \"format\": \"csv\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/export"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "keyword": "vmqeopfuudtdsufvyvddq",
    "search": "amniihfqcoynlazghdtqt",
    "query": "qxbajwbpilpmufinllwlo",
    "status": "canceled",
    "case_ids": [
        17
    ],
    "expense_type": "consequatur",
    "user_id": 17,
    "incurred_at_from": "2026-05-14T17:42:32",
    "incurred_at_to": "2107-06-13",
    "paid_at_from": "2026-05-14T17:42:32",
    "paid_at_to": "2107-06-13",
    "created_at_from": "2026-05-14T17:42:32",
    "created_at_to": "2107-06-13",
    "amount_min": 45,
    "amount_max": 56,
    "sort_by": "updated_at",
    "sort_order": "desc",
    "per_page": 5,
    "page": 51,
    "fields": [
        "pfuudtdsufvyvddqamnii"
    ],
    "field_order": [
        "hfqcoynlazghdtqtqxbaj"
    ],
    "format": "csv"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/expenses/export

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

keyword   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

search   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

query   string  optional  

Must not be greater than 255 characters. Example: qxbajwbpilpmufinllwlo

status   string  optional  

Example: canceled

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
case_ids   integer[]  optional  

The id of an existing record in the cases table.

expense_type   string  optional  

The code of an existing record in the expense_types table. Example: consequatur

user_id   integer  optional  

The id of an existing record in the users table. Example: 17

incurred_at_from   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

incurred_at_to   string  optional  

Must be a valid date. Must be a date after or equal to incurred_at_from. Example: 2107-06-13

paid_at_from   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

paid_at_to   string  optional  

Must be a valid date. Must be a date after or equal to paid_at_from. Example: 2107-06-13

created_at_from   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

created_at_to   string  optional  

Must be a valid date. Must be a date after or equal to created_at_from. Example: 2107-06-13

amount_min   number  optional  

Must be at least 0. Example: 45

amount_max   number  optional  

Must be at least 0. Example: 56

sort_by   string  optional  

Example: updated_at

Must be one of:
  • created_at
  • updated_at
  • status
  • amount
  • incurred_at
  • paid_at
  • description
  • expense_type
sort_order   string  optional  

Example: desc

Must be one of:
  • asc
  • desc
per_page   integer  optional  

Must be at least -1. Must not be greater than 1000. Example: 5

page   integer  optional  

Must be at least 1. Example: 51

fields   string[]  optional  

Must not be greater than 255 characters.

field_order   string[]  optional  

Must not be greater than 255 characters.

format   string  optional  

Example: csv

Must be one of:
  • csv

POST api/expenses/bulk/approve

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/bulk/approve" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"expense_ids\": [
        11613.31890586
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/bulk/approve"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "expense_ids": [
        11613.31890586
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/expenses/bulk/approve

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

expense_ids   number[]   

The id of an existing record in the expenses table.

POST api/expenses/bulk/deny

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/bulk/deny" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"expense_ids\": [
        11613.31890586
    ],
    \"reason\": \"opfuudtdsufvyvddqamni\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/bulk/deny"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "expense_ids": [
        11613.31890586
    ],
    "reason": "opfuudtdsufvyvddqamni"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/expenses/bulk/deny

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

expense_ids   number[]   

The id of an existing record in the expenses table.

reason   string  optional  

Must not be greater than 500 characters. Example: opfuudtdsufvyvddqamni

POST api/expenses/{expense_id}/mark-as-paid

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17/mark-as-paid" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17/mark-as-paid"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/expenses/{expense_id}/mark-as-paid

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense_id   integer   

The ID of the expense. Example: 17

GET api/expenses/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expenses/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the expense. Example: 17

Get valid status transitions for an expense.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17/valid-transitions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17/valid-transitions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expenses/{expense_id}/valid-transitions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense_id   integer   

The ID of the expense. Example: 17

PATCH api/expenses/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"case_ids\": [
        17
    ],
    \"amount\": 11613.31890586,
    \"status\": \"approved\",
    \"description\": \"Laborum eius est dolor dolores minus voluptatem.\",
    \"category\": \"consequatur\",
    \"expense_type\": \"meetings\",
    \"total_time\": 12,
    \"document_id\": 17,
    \"unit_rate\": 45,
    \"incurred_at\": \"2020-09-09\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "case_ids": [
        17
    ],
    "amount": 11613.31890586,
    "status": "approved",
    "description": "Laborum eius est dolor dolores minus voluptatem.",
    "category": "consequatur",
    "expense_type": "meetings",
    "total_time": 12,
    "document_id": 17,
    "unit_rate": 45,
    "incurred_at": "2020-09-09"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/expenses/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the expense. Example: 17

Body Parameters

case_id   string  optional  
case_ids   integer[]  optional  

The id of an existing record in the cases table.

amount   number  optional  

Example: 11613.31890586

status   string   

Example: approved

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
description   string  optional  

Must not be greater than 255 characters. Example: Laborum eius est dolor dolores minus voluptatem.

category   string   

Example: consequatur

expense_type   string   

Example: meetings

Must be one of:
  • bonus
  • car_rental
  • ceu
  • consult
  • credentialing
  • drive_time
  • flight
  • hotel
  • meal
  • meetings
  • no_show
  • other
  • parking
  • ppe
  • toll
  • training
total_time   number  optional  

Must be at least 0.1. Must not be greater than 24. Example: 12

document_id   integer  optional  

The id of an existing record in the documents table. Example: 17

unit_rate   number  optional  

Must be at least 0.01. Example: 45

incurred_at   string   

Must be a valid date in the format Y-m-d H:i:s. Must be a date before or equal to now. Example: 2020-09-09

Change expense status using state machine.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17/status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"sent\",
    \"note\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17/status"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": "sent",
    "note": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/expenses/{expense_id}/status

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense_id   integer   

The ID of the expense. Example: 17

Body Parameters

status   string   

Example: sent

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
note   string  optional  

Must not be greater than 1000 characters. Example: vmqeopfuudtdsufvyvddq

Cancel an expense.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17/cancel" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reason\": \"vmqeopfuudtdsufvyvddq\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17/cancel"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason": "vmqeopfuudtdsufvyvddq"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/expenses/{expense_id}/cancel

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense_id   integer   

The ID of the expense. Example: 17

Body Parameters

reason   string   

Must be at least 10 characters. Must not be greater than 1000 characters. Example: vmqeopfuudtdsufvyvddq

DELETE api/expenses/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expenses/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/expenses/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the expense. Example: 17

GET api/expense-config/transitions

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/transitions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/transitions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expense-config/transitions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/expense-config/transitions/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/transitions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/transitions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expense-config/transitions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the transition. Example: 1

POST api/expense-config/transitions

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/transitions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"from_status\": \"completed\",
    \"to_status\": \"denied\",
    \"is_terminal\": true,
    \"requires_note\": true,
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"is_active\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/transitions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "from_status": "completed",
    "to_status": "denied",
    "is_terminal": true,
    "requires_note": true,
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "is_active": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/expense-config/transitions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

from_status   string  optional  

Example: completed

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
to_status   string   

Example: denied

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
is_terminal   boolean   

Example: true

requires_note   boolean   

Example: true

description   string  optional  

Must not be greater than 500 characters. Example: Dolores dolorum amet iste laborum eius est dolor.

is_active   boolean   

Example: true

PATCH api/expense-config/transitions/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/transitions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"from_status\": \"submitted\",
    \"to_status\": \"completed\",
    \"is_terminal\": false,
    \"requires_note\": true,
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
    \"is_active\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/transitions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "from_status": "submitted",
    "to_status": "completed",
    "is_terminal": false,
    "requires_note": true,
    "description": "Dolores dolorum amet iste laborum eius est dolor.",
    "is_active": true
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/expense-config/transitions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the transition. Example: 1

Body Parameters

from_status   string  optional  

Example: submitted

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
to_status   string   

Example: completed

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
is_terminal   boolean   

Example: false

requires_note   boolean   

Example: true

description   string  optional  

Must not be greater than 500 characters. Example: Dolores dolorum amet iste laborum eius est dolor.

is_active   boolean   

Example: true

DELETE api/expense-config/transitions/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/transitions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/transitions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/expense-config/transitions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the transition. Example: 1

GET api/expense-config/visibility

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/visibility" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/visibility"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expense-config/visibility

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/expense-config/visibility/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/visibility/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/visibility/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expense-config/visibility/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the visibility. Example: 1

POST api/expense-config/visibility

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/visibility" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"role_id\": 17,
    \"actual_status\": \"completed\",
    \"displayed_status\": \"submitted\",
    \"is_active\": false
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/visibility"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_id": 17,
    "actual_status": "completed",
    "displayed_status": "submitted",
    "is_active": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/expense-config/visibility

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

role_id   integer   

The id of an existing record in the roles table. Example: 17

actual_status   string   

Example: completed

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
displayed_status   string   

Example: submitted

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
is_active   boolean   

Example: false

PATCH api/expense-config/visibility/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/visibility/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"role_id\": 17,
    \"actual_status\": \"approved\",
    \"displayed_status\": \"completed\",
    \"is_active\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/visibility/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_id": 17,
    "actual_status": "approved",
    "displayed_status": "completed",
    "is_active": true
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/expense-config/visibility/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the visibility. Example: 1

Body Parameters

role_id   integer   

The id of an existing record in the roles table. Example: 17

actual_status   string   

Example: approved

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
displayed_status   string   

Example: completed

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
is_active   boolean   

Example: true

DELETE api/expense-config/visibility/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/visibility/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/visibility/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/expense-config/visibility/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the visibility. Example: 1

GET api/expense-config/permissions

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expense-config/permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/expense-config/permissions/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/permissions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/permissions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/expense-config/permissions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the permission. Example: 1

POST api/expense-config/permissions

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"role_id\": 17,
    \"from_status\": \"canceled\",
    \"to_status\": \"submitted\",
    \"can_transition\": true,
    \"is_active\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_id": 17,
    "from_status": "canceled",
    "to_status": "submitted",
    "can_transition": true,
    "is_active": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/expense-config/permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

role_id   integer   

The id of an existing record in the roles table. Example: 17

from_status   string  optional  

Example: canceled

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
to_status   string   

Example: submitted

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
can_transition   boolean   

Example: true

is_active   boolean   

Example: true

PATCH api/expense-config/permissions/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/permissions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"role_id\": 17,
    \"from_status\": \"completed\",
    \"to_status\": \"investigating\",
    \"can_transition\": true,
    \"is_active\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/permissions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_id": 17,
    "from_status": "completed",
    "to_status": "investigating",
    "can_transition": true,
    "is_active": true
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/expense-config/permissions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the permission. Example: 1

Body Parameters

role_id   integer   

The id of an existing record in the roles table. Example: 17

from_status   string  optional  

Example: completed

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
to_status   string   

Example: investigating

Must be one of:
  • submitted
  • investigating
  • approved
  • denied
  • sent
  • completed
  • canceled
can_transition   boolean   

Example: true

is_active   boolean   

Example: true

DELETE api/expense-config/permissions/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/permissions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/expense-config/permissions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/expense-config/permissions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the permission. Example: 1

POST api/client-rates

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-rates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_id\": \"consequatur\",
    \"rate_type\": \"no_show\",
    \"rate\": 11613.31890586
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-rates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "client_id": "consequatur",
    "rate_type": "no_show",
    "rate": 11613.31890586
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/client-rates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

client_id   string   

The id of an existing record in the clients table. Example: consequatur

rate_type   string   

Example: no_show

Must be one of:
  • standard_rate
  • no_show
rate   number   

Example: 11613.31890586

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-rates/search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_id\": 17,
    \"rate_type\": \"standard_rate\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-rates/search"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "client_id": 17,
    "rate_type": "standard_rate"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

GET api/client-rates/{clientRate_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-rates/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-rates/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/client-rates/{clientRate_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clientRate_id   integer   

The ID of the clientRate. Example: 17

PATCH api/client-rates/{clientRate_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-rates/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rate_type\": \"no_show\",
    \"rate\": 11613.31890586
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-rates/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "rate_type": "no_show",
    "rate": 11613.31890586
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/client-rates/{clientRate_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clientRate_id   integer   

The ID of the clientRate. Example: 17

Body Parameters

rate_type   string   

Example: no_show

Must be one of:
  • standard_rate
  • no_show
rate   number   

Example: 11613.31890586

DELETE api/client-rates/{clientRate_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-rates/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/client-rates/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/client-rates/{clientRate_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clientRate_id   integer   

The ID of the clientRate. Example: 17

Display a listing of conclusions.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/conclusions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/conclusions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/conclusions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Store a newly created conclusion in storage.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/conclusions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": \"consequatur\",
    \"assessment_id\": \"consequatur\",
    \"conclusion_text\": \"consequatur\",
    \"user\": [],
    \"assessment\": []
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/conclusions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": "consequatur",
    "assessment_id": "consequatur",
    "conclusion_text": "consequatur",
    "user": [],
    "assessment": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/conclusions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   string   

The id of an existing record in the users table. Example: consequatur

assessment_id   string   

The id of an existing record in the assessment_responses table. Example: consequatur

conclusion_text   string  optional  

Example: consequatur

user   object  optional  
id   string  optional  

This field is required when user_id is not present. The id of an existing record in the users table.

assessment   object  optional  
id   string  optional  

This field is required when assessment_id is not present. The id of an existing record in the assessment_responses table.

Display the specified conclusion.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/conclusions/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/conclusions/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/conclusions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the conclusion. Example: consequatur

Update the specified conclusion in storage.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/conclusions/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"conclusion_text\": \"consequatur\",
    \"user\": [],
    \"assessment\": []
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/conclusions/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "conclusion_text": "consequatur",
    "user": [],
    "assessment": []
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/conclusions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the conclusion. Example: consequatur

Body Parameters

user_id   string  optional  

The id of an existing record in the users table.

assessment_id   string  optional  
conclusion_text   string  optional  

Example: consequatur

user   object  optional  
id   string  optional  

The id of an existing record in the users table.

assessment   object  optional  
id   string  optional  

The id of an existing record in the assessment_responses table.

Remove the specified conclusion from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/conclusions/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/conclusions/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/conclusions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the conclusion. Example: consequatur

Legacy endpoint for creating payment requests

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/pay-request" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"relay_access_token\": \"consequatur\",
    \"action\": \"wm_createPaymentRequest\",
    \"payer_id\": \"consequatur\",
    \"resource_id\": \"consequatur\",
    \"resource_email\": \"carolyne.luettgen@example.org\",
    \"resource_custom_field_id\": \"consequatur\",
    \"resource_custom_field_value\": \"consequatur\",
    \"create_payment_request\": {
        \"currency\": \"mqe\",
        \"memo\": \"consequatur\",
        \"reference\": \"consequatur\",
        \"invoice_creation_date\": \"2026-05-14T17:42:32\",
        \"order_items\": [
            {
                \"type\": \"WORK\",
                \"title\": \"consequatur\",
                \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\",
                \"quantity\": 13,
                \"amount\": 66,
                \"date\": \"2026-05-14T17:42:32\"
            }
        ],
        \"submit_payments\": true
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/pay-request"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "relay_access_token": "consequatur",
    "action": "wm_createPaymentRequest",
    "payer_id": "consequatur",
    "resource_id": "consequatur",
    "resource_email": "carolyne.luettgen@example.org",
    "resource_custom_field_id": "consequatur",
    "resource_custom_field_value": "consequatur",
    "create_payment_request": {
        "currency": "mqe",
        "memo": "consequatur",
        "reference": "consequatur",
        "invoice_creation_date": "2026-05-14T17:42:32",
        "order_items": [
            {
                "type": "WORK",
                "title": "consequatur",
                "description": "Dolores dolorum amet iste laborum eius est dolor.",
                "quantity": 13,
                "amount": 66,
                "date": "2026-05-14T17:42:32"
            }
        ],
        "submit_payments": true
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/workmarket/pay-request

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

relay_id   string  optional  
relay_access_token   string  optional  

Example: consequatur

action   string   

Example: wm_createPaymentRequest

Must be one of:
  • wm_createPaymentRequest
payer_id   string  optional  

Example: consequatur

resource_id   string  optional  

This field is required when none of resourceEmail, resourceCustomFieldId, and resourceCustomFieldValue are present. Example: consequatur

resource_email   string  optional  

Must be a valid email address. Example: carolyne.luettgen@example.org

resource_custom_field_id   string  optional  

Example: consequatur

resource_custom_field_value   string  optional  

Example: consequatur

create_payment_request   object  optional  
currency   string   

Must be 3 characters. Example: mqe

memo   string   

Example: consequatur

reference   string   

Example: consequatur

invoice_creation_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

order_items   object[]   

Must have at least 1 items.
type   string   

Example: WORK

Must be one of:
  • WORK
  • EXPENSE
  • NON_STATUTORY_DEDUCTION
title   string   

Example: consequatur

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

quantity   integer   

Must be at least 1. Example: 13

amount   number   

Must be at least 0. Example: 66

date   string   

Must be a valid date. Example: 2026-05-14T17:42:32

digital_asset_uuids   object  optional  
fields_and_values   object  optional  
submit_payments   boolean  optional  

Example: true

Get linked WorkMarket account status

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/linked-account" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/linked-account"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 17
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/workmarket/linked-account

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   integer  optional  

The id of an existing record in the users table. Example: 17

Link or update WorkMarket account

requires authentication

Example request:
curl --request PUT \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/linked-account" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"workmarket_id\": \"lILn\",
    \"user_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/linked-account"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "workmarket_id": "lILn",
    "user_id": 17
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PUT api/workmarket/linked-account

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

workmarket_id   string   

Must match the regex /^[a-zA-Z0-9]+$/. Example: lILn

user_id   integer  optional  

The id of an existing record in the users table. Example: 17

Unlink WorkMarket account

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/linked-account" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/linked-account"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 17
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

DELETE api/workmarket/linked-account

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   integer  optional  

The id of an existing record in the users table. Example: 17

Submit a single expense to WorkMarket for payment

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/expenses/17/submit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/expenses/17/submit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST api/workmarket/expenses/{expense_id}/submit

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense_id   integer   

The ID of the expense. Example: 17

Submit multiple expenses to WorkMarket in batch

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/expenses/batch-submit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"expense_ids\": [
        17
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/expenses/batch-submit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "expense_ids": [
        17
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/workmarket/expenses/batch-submit

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

expense_ids   integer[]   

The id of an existing record in the expenses table.

Check payment status for a specific expense

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/expenses/17/status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/expenses/17/status"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/workmarket/expenses/{expense_id}/status

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

expense_id   integer   

The ID of the expense. Example: 17

Sync payment statuses for pending expenses

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/sync-payment-statuses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 17,
    \"force\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/workmarket/sync-payment-statuses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "user_id": 17,
    "force": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/workmarket/sync-payment-statuses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

user_id   integer  optional  

The id of an existing record in the users table. Example: 17

force   boolean  optional  

Example: true

GET api/tags

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tags" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tags"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/tags

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/tags

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tags" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\",
    \"category\": {
        \"id\": \"consequatur\"
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tags"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit.",
    "category": {
        "id": "consequatur"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/tags

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 1000 characters. Example: Dolores molestias ipsam sit.

category   object   
id   string   

The id of an existing record in the tag_categories table. Example: consequatur

GET api/tags/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tags/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tags/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/tags/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the tag. Example: consequatur

PATCH api/tags/{id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tags/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores molestias ipsam sit.\",
    \"category\": {
        \"id\": \"consequatur\"
    }
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tags/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores molestias ipsam sit.",
    "category": {
        "id": "consequatur"
    }
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/tags/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the tag. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Must not be greater than 1000 characters. Example: Dolores molestias ipsam sit.

category   object   
id   string   

The id of an existing record in the tag_categories table. Example: consequatur

DELETE api/tags/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tags/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tags/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/tags/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the tag. Example: 1

GET api/assessments

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/assessments

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/assessments

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"case_type_id\": \"consequatur\",
    \"assessment_sections\": [
        {
            \"id\": \"consequatur\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "case_type_id": "consequatur",
    "assessment_sections": [
        {
            "id": "consequatur"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/assessments

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

case_type_id   string   

The id of an existing record in the case_types table. Example: consequatur

assessment_sections   object[]  optional  
id   string   

The id of an existing record in the assessment_sections table. Example: consequatur

GET api/assessments/{id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/assessments/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the assessment. Example: 1

PUT api/assessments/{id}

requires authentication

Example request:
curl --request PUT \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"case_type_id\": \"consequatur\",
    \"assessment_sections\": [
        {
            \"id\": \"consequatur\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "case_type_id": "consequatur",
    "assessment_sections": [
        {
            "id": "consequatur"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PUT api/assessments/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the assessment. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

case_type_id   string   

The id of an existing record in the case_types table. Example: consequatur

assessment_sections   object[]  optional  
id   string   

The id of an existing record in the assessment_sections table. Example: consequatur

PATCH api/assessments/{assessment_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"case_type_id\": \"consequatur\",
    \"assessment_sections\": [
        {
            \"id\": \"consequatur\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "case_type_id": "consequatur",
    "assessment_sections": [
        {
            "id": "consequatur"
        }
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/assessments/{assessment_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

assessment_id   integer   

The ID of the assessment. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

case_type_id   string   

The id of an existing record in the case_types table. Example: consequatur

assessment_sections   object[]  optional  
id   string   

The id of an existing record in the assessment_sections table. Example: consequatur

DELETE api/assessments/{id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessments/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/assessments/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the assessment. Example: 1

GET api/assessment-sections

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-sections" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-sections"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/assessment-sections

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/assessment-sections

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-sections" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-sections"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores dolorum amet iste laborum eius est dolor."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/assessment-sections

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

GET api/assessment-sections/{assessmentSection_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-sections/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-sections/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/assessment-sections/{assessmentSection_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

assessmentSection_id   integer   

The ID of the assessmentSection. Example: 1

PATCH api/assessment-sections/{assessmentSection_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-sections/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"description\": \"Dolores dolorum amet iste laborum eius est dolor.\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-sections/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "description": "Dolores dolorum amet iste laborum eius est dolor."
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/assessment-sections/{assessmentSection_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

assessmentSection_id   integer   

The ID of the assessmentSection. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

description   string  optional  

Example: Dolores dolorum amet iste laborum eius est dolor.

DELETE api/assessment-sections/{assessmentSection_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-sections/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/assessment-sections/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/assessment-sections/{assessmentSection_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

assessmentSection_id   integer   

The ID of the assessmentSection. Example: 1

GET api/section-rules

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/section-rules" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"assessment_section_id\": 17,
    \"per_page\": 13
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/section-rules"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "assessment_section_id": 17,
    "per_page": 13
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/section-rules

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

assessment_section_id   integer  optional  

Example: 17

per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 13

POST api/section-rules

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/section-rules" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"assessment_section_id\": 17,
    \"state\": \"mq\",
    \"case_type_id\": 17,
    \"client_id\": 17,
    \"sort_order\": 45,
    \"is_required\": false,
    \"is_active\": false
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/section-rules"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "assessment_section_id": 17,
    "state": "mq",
    "case_type_id": 17,
    "client_id": 17,
    "sort_order": 45,
    "is_required": false,
    "is_active": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/section-rules

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

assessment_section_id   integer   

The id of an existing record in the assessment_sections table. Example: 17

state   string  optional  

Must be 2 characters. Example: mq

case_type_id   integer  optional  

The id of an existing record in the case_types table. Example: 17

client_id   integer  optional  

The id of an existing record in the clients table. Example: 17

sort_order   integer   

Must be at least 0. Example: 45

is_required   boolean  optional  

Example: false

is_active   boolean  optional  

Example: false

GET api/section-rules/{sectionRule_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/section-rules/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/section-rules/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/section-rules/{sectionRule_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

sectionRule_id   integer   

The ID of the sectionRule. Example: 17

PATCH api/section-rules/{sectionRule_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/section-rules/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"assessment_section_id\": 17,
    \"state\": \"mq\",
    \"case_type_id\": 17,
    \"client_id\": 17,
    \"sort_order\": 45,
    \"is_required\": true,
    \"is_active\": true
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/section-rules/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "assessment_section_id": 17,
    "state": "mq",
    "case_type_id": 17,
    "client_id": 17,
    "sort_order": 45,
    "is_required": true,
    "is_active": true
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/section-rules/{sectionRule_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

sectionRule_id   integer   

The ID of the sectionRule. Example: 17

Body Parameters

assessment_section_id   integer   

The id of an existing record in the assessment_sections table. Example: 17

state   string  optional  

Must be 2 characters. Example: mq

case_type_id   integer  optional  

The id of an existing record in the case_types table. Example: 17

client_id   integer  optional  

The id of an existing record in the clients table. Example: 17

sort_order   integer   

Must be at least 0. Example: 45

is_required   boolean  optional  

Example: true

is_active   boolean  optional  

Example: true

DELETE api/section-rules/{sectionRule_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/section-rules/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/section-rules/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/section-rules/{sectionRule_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

sectionRule_id   integer   

The ID of the sectionRule. Example: 17

Display a listing of the resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tag-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tag-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/tag-categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Store a newly created resource in storage.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tag-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"category_name\": \"vmqeopfuudtdsufvyvddq\",
    \"category_tag_type\": \"amniihfqcoynlazghdtqt\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tag-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "category_name": "vmqeopfuudtdsufvyvddq",
    "category_tag_type": "amniihfqcoynlazghdtqt"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/tag-categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

category_name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

category_tag_type   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tag-categories/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tag-categories/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/tag-categories/{tagCategory}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

tagCategory   string   

Example: consequatur

Update the specified resource in storage.

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tag-categories/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"category_name\": \"vmqeopfuudtdsufvyvddq\",
    \"category_tag_type\": \"amniihfqcoynlazghdtqt\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tag-categories/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "category_name": "vmqeopfuudtdsufvyvddq",
    "category_tag_type": "amniihfqcoynlazghdtqt"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/tag-categories/{tagCategory}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

tagCategory   string   

Example: consequatur

Body Parameters

category_name   string  optional  

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

category_tag_type   string  optional  

Must not be greater than 255 characters. Example: amniihfqcoynlazghdtqt

Remove the specified resource from storage.

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tag-categories/consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/tag-categories/consequatur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/tag-categories/{tagCategory}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

tagCategory   string   

Example: consequatur

GET api/saved-filters

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/saved-filters" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/saved-filters"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/saved-filters

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/saved-filters

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/saved-filters" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"context\": \"users\",
    \"filter_data\": []
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/saved-filters"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "context": "users",
    "filter_data": []
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/saved-filters

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

context   string   

Example: users

Must be one of:
  • cases
  • users
  • members
  • clients
  • expenses
  • alert_templates
filter_data   object   

GET api/saved-filters/{savedFilter_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/saved-filters/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/saved-filters/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/saved-filters/{savedFilter_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

savedFilter_id   integer   

The ID of the savedFilter. Example: 1

PATCH api/saved-filters/{savedFilter_id}

requires authentication

Example request:
curl --request PATCH \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/saved-filters/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"filter_data\": []
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/saved-filters/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "vmqeopfuudtdsufvyvddq",
    "filter_data": []
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

PATCH api/saved-filters/{savedFilter_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

savedFilter_id   integer   

The ID of the savedFilter. Example: 1

Body Parameters

name   string   

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

filter_data   object   

DELETE api/saved-filters/{savedFilter_id}

requires authentication

Example request:
curl --request DELETE \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/saved-filters/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/saved-filters/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request   

DELETE api/saved-filters/{savedFilter_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

savedFilter_id   integer   

The ID of the savedFilter. Example: 1

GET api/filter-fields

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/filter-fields" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"context\": \"cases\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/filter-fields"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "context": "cases"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/filter-fields

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

context   string   

Example: cases

Must be one of:
  • cases
  • users
  • members
  • clients
  • expenses
  • alert_templates

GET api/filter-fields/{filterField_id}

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/filter-fields/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/filter-fields/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/filter-fields/{filterField_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

filterField_id   integer   

The ID of the filterField. Example: 1

POST api/clinicians/{clinician_id}/trainings/required

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinicians/1/trainings/required" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"role_id\": 17,
    \"trainings\": [
        {
            \"training_id\": 17,
            \"due_date\": \"2026-05-14T17:42:32\"
        }
    ]
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/clinicians/1/trainings/required"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_id": 17,
    "trainings": [
        {
            "training_id": 17,
            "due_date": "2026-05-14T17:42:32"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST api/clinicians/{clinician_id}/trainings/required

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinician_id   integer   

The ID of the clinician. Example: 1

Body Parameters

role_id   integer   

The id of an existing record in the roles table. Example: 17

trainings   object[]   

Must have at least 1 items.
training_id   integer   

The id of an existing record in the trainings table. Example: 17

due_date   string  optional  

Must be a valid date. Example: 2026-05-14T17:42:32

Display a listing of active training material categories.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/training-material-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/training-material-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/training-material-categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Display a listing of training tag types with optional search.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/training-tag-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/training-tag-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/training-tag-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/trainings/catalog

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/trainings/catalog" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"role_id\": 17,
    \"clinician_id\": 17
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/trainings/catalog"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_id": 17,
    "clinician_id": 17
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/trainings/catalog

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

role_id   integer   

Example: 17

clinician_id   integer   

The id of an existing record in the users table. Example: 17

Display a paginated listing of bills for the authenticated user.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/bills" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"year\": 21,
    \"search\": \"mqeopfuudtdsufvyvddqa\",
    \"sort_by\": \"created_at\",
    \"sort_order\": \"asc\",
    \"per_page\": 13,
    \"page\": 46
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/bills"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "year": 21,
    "search": "mqeopfuudtdsufvyvddqa",
    "sort_by": "created_at",
    "sort_order": "asc",
    "per_page": 13,
    "page": 46
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/bills

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

year   integer  optional  

Must be at least 2000. Must not be greater than 2100. Example: 21

search   string  optional  

Must not be greater than 50 characters. Example: mqeopfuudtdsufvyvddqa

sort_by   string  optional  

Example: created_at

Must be one of:
  • pay_period
  • created_at
  • total_amount
  • bill_number
sort_order   string  optional  

Example: asc

Must be one of:
  • asc
  • desc
per_page   integer  optional  

Must be at least 1. Must not be greater than 100. Example: 13

page   integer  optional  

Must be at least 1. Example: 46

Display the specified bill with full breakdown details.

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/bills/17" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/bills/17"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/bills/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the bill. Example: 17

GET api/v1

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/v1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/v1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/v1

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/v1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/v1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/v1

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/v1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/v1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/v1

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/v1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/api/v1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-gryphon-app-version: unknown
access-control-allow-origin: *
 

{
    "message": "Unauthenticated.",
    "app_version": "unknown"
}

Request   

GET api/v1

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET auth/status

requires authentication

Example request:
curl --request GET \
    --get "http://gryphon-central-stage.gryphon-tenant-api.test:3002/auth/status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/auth/status"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
x-gryphon-app-version: unknown
 

{
    "auth_service": "sanctum",
    "app_version": "unknown"
}

Request   

GET auth/status

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Attempt to authenticate a new session.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/auth/login" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/auth/login"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "qkunze@example.com",
    "password": "O[2UZ5ij-e\/dl4m{o,"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST auth/login

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Example: qkunze@example.com

password   string   

Example: O[2UZ5ij-e/dl4m{o,

Send a reset link to the given user.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/auth/forgot-password" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/auth/forgot-password"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request   

POST auth/forgot-password

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Reset the user's password.

requires authentication

Example request:
curl --request POST \
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/auth/reset-password" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"consequatur\",
    \"password\": \"consequatur\"
}"

const url = new URL(
    "http://gryphon-central-stage.gryphon-tenant-api.test:3002/auth/reset-password"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "consequatur",
    "password": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request   

POST auth/reset-password

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Example: consequatur

password   string   

Example: consequatur