{
"openapi": "3.0.0",
"info": {
"title": "Glide API",
"description": "The Glide API enables you to connect to a Glide system programatically, or via third-party tools that encapsulate the Glide API into other tools, for example Zapier.\n\n## Authentication\n\nTo use the Glide API you need to generate an API key in the Glide application, then pass that key in the username field of a HTTP Basic Access Auth header, leave the password field empty. \n\n## Rate Limiting\n\nIn order to provide a fair distribution of available resources, all API calls are subject to rate limits.\n\nThe default rate limit is 60 calls per minute. We reserve the right to adjust the rate limit in the future. Please build applications that respond to the rate limit appropriately.\n\nIf you exceed the number of API calls per minute granted to your credential, a `429 Too Many Requests` error response will be returned.\n \nIn that case, a `Retry-After` header may be included in the response, describing the number of seconds after which a request can be retried.\n \nIf you run into a high number of 429 errors, you should slow down the rate at which you are attempting to access the API.\n \n**Example**\n \nIn the following example the request can be retried after waiting for 21 seconds:\n \nHTTP/1.1 429 Too Many Requests\nContent-Type: text/html \nRetry-After: 21\n\n## XML vs JSON\n\nv1 of the Glide API is designed to return XML. Most calls can also return JSON. To request JSON be returned from a particular end-point you need to send an additional query parameter.\n\n**Add 'returnFormat=1' to your requests to get JSON returned**\n\n## Further Developments\n\nWe are actively developing enhancements to this API, if you have suggestions for useful functionality please contact us via our website at https://www.glideworkflow.com\n\n## Issues\n\nShould you encounter any problems when using the Glide API please contact us right away, we will be happy to help.\n\n ",
"termsOfService": "https://glideworkflow.com/terms-of-service/",
"contact": {
"name": "Glide API support",
"url": "https://glide.helpscoutdocs.com/"
},
"version": "1.0"
},
"servers": [
{
"url": "https://gapi.glideworkpm.com/v1"
}
],
"paths": {
"/links/jobs/list": {
"get": {
"tags": [
"Job Links"
],
"summary": "Get list of all job links",
"description": "Returns a list of all job links)",
"operationId": "78093b9abd254165d6a52186862eecec",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"linkID": {
"description": "Unique ID of the link",
"type": "integer"
},
"parentSubJobID": {
"description": "ID of the parent sub-job. Note: This is a sub-job, not a job.",
"type": "integer"
},
"childJobID": {
"description": "ID of the child job",
"type": "integer"
},
"childJobSystemID": {
"description": "ID of the workflow system for the child job",
"type": "integer"
},
"childJobSystemName": {
"description": "Name of the workflow system for the child job",
"type": "string"
},
"childJobClientID": {
"description": "ID of the client",
"type": "integer"
}
},
"type": "object"
}
}
}
}
}
}
}
},
"/links/jobs/{subJobID}/children/list": {
"get": {
"tags": [
"Job Links"
],
"summary": "Get list of child jobs linked to a parent sub-job",
"description": "Returns a list of all jobs that are linked as children to the specified parent sub-job ID",
"operationId": "6ea108b7be46d82f44f24eb9d0afcf27",
"parameters": [
{
"name": "subJobID",
"in": "path",
"description": "ID of the parent sub-job to get children for",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"description": "Number of child job links found",
"type": "integer"
},
"links": {
"type": "array",
"items": {
"properties": {
"linkID": {
"type": "integer"
},
"childJobID": {
"type": "integer"
},
"childJobSystemID": {
"type": "integer"
},
"childJobSystemName": {
"type": "string"
},
"childJobClientID": {
"type": "integer"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Parent sub-job not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"/links/jobs/{subJobID}/children/job/create": {
"post": {
"tags": [
"Job Links"
],
"summary": "Create a parent-child link between a sub-job and a job",
"description": "Creates a link between a parent sub-job and a child job",
"operationId": "a4a52698c088e397193215b6df007596",
"parameters": [
{
"name": "subJobID",
"in": "path",
"description": "ID of the parent sub-job, must already exist",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"newChildJobID"
],
"properties": {
"newChildJobID": {
"description": "ID of the child job to link, must already exist",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Link created successfully or already exists",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"message": {
"type": "string",
"example": "Job link created successfully"
}
},
"type": "object"
},
{
"properties": {
"message": {
"type": "string",
"example": "Job link already exists"
}
},
"type": "object"
}
]
}
}
}
},
"400": {
"description": "Invalid sub-job ID provided",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "One or both jobs not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"/links/jobs/{subJobID}/children/sub-job/create": {
"post": {
"tags": [
"Job Links"
],
"summary": "Create a parent-child link between a sub-job and a sub-job",
"description": "Creates a link between a parent sub-job and a child sub-job",
"operationId": "9d1d08cb27cf689fef4b8482003bdf18",
"parameters": [
{
"name": "subJobID",
"in": "path",
"description": "ID of the parent sub-job, must already exist",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"newChildSubJobID"
],
"properties": {
"newChildSubJobID": {
"description": "ID of the child sub-job to link, must already exist",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Link created successfully or already exists",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"properties": {
"message": {
"type": "string",
"example": "Job link created successfully"
}
},
"type": "object"
},
{
"properties": {
"message": {
"type": "string",
"example": "Job link already exists"
}
},
"type": "object"
}
]
}
}
}
},
"400": {
"description": "Invalid sub-job ID provided",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "One or both sub-jobs not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"/links/{linkID}/delete": {
"delete": {
"tags": [
"Job Links"
],
"summary": "Delete a link",
"description": "Deletes a link by its unique ID. This can be any type of link.",
"operationId": "76077cecca04bc8db4ecdbeb68cef876",
"parameters": [
{
"name": "linkID",
"in": "path",
"description": "ID of the link to delete",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Link deleted successfully"
},
"404": {
"description": "Link not found"
}
}
}
},
"/editor/systems/{universeID}/elements/list": {
"get": {
"tags": [
"Editor Systems"
],
"summary": "Get list of workflow elements",
"description": "Retrieves list of workflow elements (stages, fields, deadlines) for a system",
"operationId": "82077744e4e3ece1e8487bb21d624475",
"parameters": [
{
"name": "universeID",
"in": "path",
"description": "ID of the system to get elements for",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "subSystemID",
"in": "query",
"description": "Optional sub-system ID filter",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "elementType",
"in": "query",
"description": "Optional element type filter",
"required": false,
"schema": {
"type": "string",
"enum": [
"STAGE",
"FIELD",
"DEADLINE"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"404": {
"description": "Universe or sub-system not found"
},
"400": {
"description": "Invalid element type"
}
}
}
},
"/editor/routes/{routeID}/stages/list": {
"get": {
"tags": [
"Editor Systems"
],
"summary": "Get list of stages for a specific route",
"description": "Retrieves ordered list of stages and their associated stage groups for the specified route ID",
"operationId": "d5458fb7458bfd803dd650106f9ae318",
"parameters": [
{
"name": "routeID",
"in": "path",
"description": "ID of the route to get stages for",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"ID": {
"description": "Unique identifier for the stage",
"type": "integer"
},
"Order": {
"description": "Sort order of the stage",
"type": "integer"
},
"Milestone": {
"description": "Name of the milestone",
"type": "string"
},
"Description": {
"description": "Description of the stage",
"type": "string"
},
"GroupID": {
"description": "ID of the stage group",
"type": "integer"
},
"StageGroupName": {
"description": "Name of the stage group",
"type": "string"
},
"StageGroupOrder": {
"description": "Sort order of the stage group",
"type": "integer"
},
"StageGroupCompletion": {
"description": "Completion status of the stage group",
"type": "integer"
}
},
"type": "object"
}
}
}
}
},
"404": {
"description": "Route not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Route not found"
},
"message": {
"type": "string",
"example": "The specified route ID does not exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/editor/routes/{routeID}/steps/list": {
"get": {
"tags": [
"Editor Systems"
],
"summary": "Get list of steps for a specific route",
"description": "Retrieves ordered list of steps and their associated stages for the specified route ID",
"operationId": "a1131269f2cb21c897d596d2b5975de4",
"parameters": [
{
"name": "routeID",
"in": "path",
"description": "ID of the route to get steps for",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"ID": {
"description": "Unique identifier for the step",
"type": "integer"
},
"Name": {
"description": "Name of the step",
"type": "string"
},
"Description": {
"description": "Description of the step",
"type": "string"
},
"FromStageID": {
"description": "ID of the source stage",
"type": "integer"
},
"FromStageOrder": {
"description": "Order of the source stage",
"type": "integer"
},
"FromStageDescription": {
"description": "Description of the source stage",
"type": "string"
},
"ToStageID": {
"description": "ID of the destination stage",
"type": "integer"
},
"ToStageOrder": {
"description": "Order of the destination stage",
"type": "integer"
},
"ToStageDescription": {
"description": "Description of the destination stage",
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"404": {
"description": "Route not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Route not found"
},
"message": {
"type": "string",
"example": "The specified route ID does not exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/editor/routes/{routeID}/fields/list": {
"get": {
"tags": [
"Editor Systems"
],
"summary": "Get list of fields for a specific route",
"description": "Retrieves ordered list of fields and their types associated with the specified route ID",
"operationId": "39bb07952bc17c9fa851cbc1a60f5d9d",
"parameters": [
{
"name": "routeID",
"in": "path",
"description": "ID of the route to get fields for",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"ID": {
"description": "Unique identifier for the field",
"type": "integer"
},
"Order": {
"description": "Sort order of the field",
"type": "integer"
},
"Name": {
"description": "Name of the field",
"type": "string"
},
"FieldType": {
"description": "Type of the field",
"type": "string",
"enum": [
"Date",
"Text (20 character max)",
"Number",
"Boolean",
"Job position",
"Staff",
"Text (unlimited)",
"Currency",
"Multiple choice"
]
}
},
"type": "object"
}
}
}
}
},
"404": {
"description": "Route not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Route not found"
},
"message": {
"type": "string",
"example": "The specified route ID does not exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/editor/routes/{routeID}/deadlines/list": {
"get": {
"tags": [
"Editor Systems"
],
"summary": "Get list of deadlines for a specific route",
"description": "Retrieves ordered list of deadlines associated with the specified route ID",
"operationId": "9efc0dcf76b76f571a52915382fc65ce",
"parameters": [
{
"name": "routeID",
"in": "path",
"description": "ID of the route to get deadlines for",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"ID": {
"description": "Unique identifier for the deadline",
"type": "integer"
},
"Order": {
"description": "Sort order of the deadline",
"type": "integer"
},
"Name": {
"description": "Name of the deadline",
"type": "string"
},
"Description": {
"description": "Description of the deadline",
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"404": {
"description": "Route not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "Route not found"
},
"message": {
"type": "string",
"example": "The specified route ID does not exist"
}
},
"type": "object"
}
}
}
}
}
}
},
"/editor/systems/{systemID}/regions/list": {
"get": {
"tags": [
"Editor Systems"
],
"summary": "Get list of regions for a specific system",
"description": "Retrieves ordered list of regions associated with the specified system ID",
"operationId": "c185c9cc1f4806a75769040952b38643",
"parameters": [
{
"name": "systemID",
"in": "path",
"description": "ID of the system to get regions for",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"ID": {
"description": "Unique identifier for the region",
"type": "integer"
},
"Order": {
"description": "Sort order of the region",
"type": "integer"
},
"Name": {
"description": "Name of the region",
"type": "string"
},
"CompletionRegion": {
"description": "Completion status of the region",
"type": "integer"
}
},
"type": "object"
}
}
}
}
}
}
}
},
"/editor/systems/clientfields/list": {
"get": {
"tags": [
"Editor Systems"
],
"summary": "Get list of custom fields shown on the client card",
"description": "Returns a list of custom client card fields, optionally filtered by workflow system ID",
"operationId": "7ccdba8ac8d2d2063aad2c31b581fbb4",
"parameters": [
{
"name": "systemID",
"in": "query",
"description": "Optional workflow system ID to filter by. Shows overall/main tab fields if not specified.",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"FieldID": {
"description": "Unique ID of the client field",
"type": "integer"
},
"FieldType": {
"description": "Type of field (TRIGGER_DATE, DATE, NUMBER, BOOLEAN, STAFF, TEXT, TEXT_UNLIMITED, EMAIL, WEBSITE, CURRENCY, MULTIPLE_CHOICE, TEXT_FORMATTED)",
"type": "string",
"example": "TEXT"
},
"FieldName": {
"description": "Name of the field",
"type": "string"
},
"FieldOrder": {
"description": "Display order of the field",
"type": "integer"
},
"WorkflowSystemID": {
"description": "ID of the workflow system (only returned when systemID is specified)",
"type": "integer",
"nullable": true
},
"WorkflowSystemName": {
"description": "Name of the workflow system (only returned when systemID is specified)",
"type": "string",
"nullable": true
}
},
"type": "object"
}
}
}
}
},
"404": {
"description": "System not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "System not found"
},
"message": {
"type": "string",
"example": "The specified system ID does not exist or is deleted"
}
},
"type": "object"
}
}
}
}
}
}
},
"/snapshot/clients": {
"get": {
"tags": [
"Snapshots [Enable snapshots in config first]"
],
"summary": "Retrieve snapshot data for clients",
"description": "Fetches a bulk snapshot of client data.",
"operationId": "cdf605cf02c425b60155bb16b96714b8",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "Snapshot data",
"type": "object"
},
{
"properties": {
"status": {
"type": "string",
"example": "Error"
},
"description": {
"type": "string",
"example": "Data not available"
}
},
"type": "object"
}
]
}
}
}
}
}
}
},
"/snapshot/jobs": {
"get": {
"tags": [
"Snapshots [Enable snapshots in config first]"
],
"summary": "Retrieve snapshot data for jobs",
"description": "Fetches a bulk snapshot of job data.",
"operationId": "d8db4f9a4301d382a0e2caeaad443934",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "JSON data",
"type": "object"
},
{
"properties": {
"status": {
"type": "string",
"example": "Error"
},
"description": {
"type": "string",
"example": "Data not available"
}
},
"type": "object"
}
]
}
}
}
}
}
}
},
"/snapshot/dailyJobEvents": {
"get": {
"tags": [
"Snapshots [Enable snapshots in config first]"
],
"summary": "Retrieve snapshot data for job changes",
"description": "Fetches a bulk snapshot of job change data.",
"operationId": "74c44bdb85b2483a25d350c339af0d8b",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "Snapshot data",
"type": "object"
},
{
"properties": {
"status": {
"type": "string",
"example": "Error"
},
"description": {
"type": "string",
"example": "Data not available"
}
},
"type": "object"
}
]
}
}
}
}
}
}
},
"/snapshot/jobChanges": {
"get": {
"tags": [
"Snapshots [Enable snapshots in config first]"
],
"summary": "Retrieve snapshot data for job changes",
"description": "Fetches a bulk snapshot of job change data.",
"operationId": "f1a0a4ca38d92b90ec3d3b2d47aca9a6",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "Snapshot data",
"type": "object"
},
{
"properties": {
"status": {
"type": "string",
"example": "Error"
},
"description": {
"type": "string",
"example": "Data not available"
}
},
"type": "object"
}
]
}
}
}
}
}
}
},
"/snapshot/dailyJobEvents/{date}": {
"get": {
"tags": [
"Snapshots [Enable snapshots in config first]"
],
"summary": "Retrieve snapshot data for daily job events by date",
"description": "Fetches a snapshot of daily job events for a specific date.",
"operationId": "992f8a85b256fc1ead4d6e9a889aeeba",
"parameters": [
{
"name": "date",
"in": "path",
"description": "The date in YYYYMMDD format",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "Snapshot data",
"type": "object"
},
{
"properties": {
"status": {
"type": "string",
"example": "Error"
},
"description": {
"type": "string",
"example": "Data not available for the specified date."
}
},
"type": "object"
}
]
}
}
}
}
}
}
},
"/me": {
"get": {
"tags": [
"Other"
],
"summary": "Get information about the system you have accessed.",
"description": "Returns basic information about the Glide system associated with the API key used for authentication.",
"operationId": "0cf7d3a4c280d5fc07d1fc160dd72c84",
"parameters": [
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"Info": {
"properties": {
"SystemName": {
"description": "The company/system name configured in Glide",
"type": "string",
"example": "ABC Accountants Ltd"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/routeCodes.json": {
"get": {
"tags": [
"Workflow Systems"
],
"summary": "Get a list of routes on active Glide systems. [JSON]",
"operationId": "740480d4de03690216ac4e9e2e2aba7d",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
}
},
"/system/accesslog": {
"get": {
"tags": [
"Administration"
],
"summary": "Get a list of login attempts this month",
"description": "Returns a list of all login attempts for the current month, including successful and failed attempts.",
"operationId": "879a7fffd8fd0daabbd30ef717cf196c",
"parameters": [
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Count": {
"description": "Total number of login attempts this month",
"type": "integer",
"example": 42
},
"AccessAttempts": {
"properties": {
"Log": {
"type": "array",
"items": {
"properties": {
"Email": {
"description": "Email address used for login attempt",
"type": "string",
"example": "user@example.com"
},
"UID": {
"description": "User ID (if login was successful)",
"type": "integer",
"example": 123
},
"IPA": {
"description": "IP address of the login attempt",
"type": "string",
"example": "192.168.1.1"
},
"DT": {
"description": "Date and time of the attempt",
"type": "string",
"format": "date-time",
"example": "2024-01-15 09:30:00"
},
"State": {
"description": "Result of login attempt",
"type": "string",
"enum": [
"OK",
"E_IP",
"E_PW",
"LOCKED"
],
"example": "OK"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/list": {
"get": {
"tags": [
"Clients"
],
"summary": "Get a list of all the clients on the Glide system",
"description": "This endpoint is deprecated. Use /clients/all instead.",
"operationId": "2df0533291b89c93d6980ca344fc52c3",
"parameters": [
{
"name": "fType",
"in": "query",
"description": "Glide client type - 1 = Limited company
- 2 = PLC
- 3 = Sole Trader
- 4 = Partnership
- 5 = LLP
- 6 = Charity
- 7 = Charity company
- 8 = Pension Scheme
- 9 = School
- 10 = Trust
- 11 = Club
- 50 = Individual
",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "fStatus",
"in": "query",
"description": "Glide client status - -2 = Include deleted clients
- 1 = Deleted
- 2 = Prospect
- 3 = Lost
",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Request executed successfully",
"content": {
"application/xml": {
"schema": {
"properties": {
"Response": {
"properties": {
"Status": {
"type": "string"
},
"StatusReport": {
"type": "string"
},
"Count": {
"type": "integer"
},
"Clients": {
"properties": {
"Client": {
"properties": {
"GID": {
"type": "integer"
},
"UID": {
"type": "string"
},
"Name": {
"type": "string"
},
"Title": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"SecondName": {
"type": "string"
},
"Type": {
"type": "string"
},
"State": {
"type": "string"
},
"Office": {
"type": "integer"
},
"ManagerResponsible": {
"properties": {
"Code": {
"type": "integer"
},
"Name": {
"type": "string"
}
},
"type": "object"
},
"PartnerResponsible": {
"properties": {
"Code": {
"type": "integer"
},
"Name": {
"type": "string"
}
},
"type": "object"
},
"CHRegNumber": {
"type": "string"
},
"IncorpDate": {
"type": "string",
"format": "date"
},
"Email": {
"type": "string",
"format": "email"
},
"Contacts": {
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
},
"deprecated": true
}
},
"/clients/all": {
"get": {
"tags": [
"Clients"
],
"summary": "Get a paginated list of all the clients on the Glide system",
"operationId": "9a7200c9d94c553795c1187c35d4e001",
"parameters": [
{
"name": "offset",
"in": "query",
"description": "Number of records to skip (default: 0)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of records to return (default: 10, max: 100)",
"required": false,
"schema": {
"type": "integer",
"default": 10,
"maximum": 100,
"minimum": 1
}
},
{
"name": "fType",
"in": "query",
"description": "Glide client type - 1 = Limited company
- 2 = PLC
- 3 = Sole Trader
- 4 = Partnership
- 5 = LLP
- 6 = Charity
- 7 = Charity company
- 8 = Pension Scheme
- 9 = School
- 10 = Trust
- 11 = Club
- 50 = Individual
",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "fStatus",
"in": "query",
"description": "Glide client status - -2 = Include deleted clients
- 1 = Deleted
- 2 = Prospect
- 3 = Lost
",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Request executed successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Response": {
"properties": {
"Status": {
"description": "Status of the request (OK or ERROR)",
"type": "string",
"example": "OK"
},
"StatusReport": {
"description": "Human readable status message",
"type": "string",
"example": "Request completed successfully"
},
"Count": {
"description": "Number of clients returned in this response",
"type": "integer",
"example": 10
},
"TotalCount": {
"description": "Total number of clients matching the filter criteria",
"type": "integer",
"example": 157
},
"Clients": {
"properties": {
"Client": {
"type": "array",
"items": {
"properties": {
"GID": {
"type": "integer",
"example": 12345
},
"UID": {
"type": "string",
"example": "ABC123"
},
"Name": {
"type": "string",
"example": "ACME Corporation Ltd"
},
"Type": {
"type": "string",
"example": "Limited Company"
},
"State": {
"type": "string",
"example": "Active"
},
"Office": {
"type": "integer",
"example": 1
},
"ManagerResponsible": {
"properties": {
"Code": {
"type": "integer",
"example": 45
},
"Name": {
"type": "string",
"example": "John Smith"
}
},
"type": "object"
},
"PartnerResponsible": {
"properties": {
"Code": {
"type": "integer",
"example": 12
},
"Name": {
"type": "string",
"example": "Jane Doe"
}
},
"type": "object"
},
"CHRegNumber": {
"type": "string",
"example": "12345678"
},
"IncorpDate": {
"type": "string",
"format": "date",
"example": "2020-01-01"
},
"Email": {
"type": "string",
"format": "email",
"example": "contact@acme.com"
},
"Contacts": {
"type": "array",
"items": {
"properties": {
"Name": {
"type": "string",
"example": "John Contact"
},
"Email": {
"type": "string",
"format": "email",
"example": "john@acme.com"
},
"Phone": {
"type": "string",
"example": "+44 1234 567890"
}
},
"type": "object"
}
},
"AlternateID": {
"description": "Alternate/integration ID, as used by the CCH->Glide connector",
"type": "string"
},
"NextYearEnd": {
"description": "Next Year End",
"type": "string",
"format": "date"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid parameters provided",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Invalid parameters provided"
}
},
"type": "object"
}
}
}
}
}
}
},
"/contacts/all": {
"get": {
"tags": [
"Contacts"
],
"summary": "Get a paginated list of all the contacts on the Glide system",
"operationId": "9e524f449db03281248e49d6264dd865",
"parameters": [
{
"name": "offset",
"in": "query",
"description": "Number of records to skip (default: 0)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of records to return (default: 10, max: 100)",
"required": false,
"schema": {
"type": "integer",
"default": 10,
"maximum": 100,
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Request executed successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Response": {
"properties": {
"Status": {
"description": "Status of the request (OK or ERROR)",
"type": "string",
"example": "OK"
},
"StatusReport": {
"description": "Human readable status message",
"type": "string",
"example": "Request completed successfully"
},
"Count": {
"description": "Number of contacts returned in this response",
"type": "integer",
"example": 10
},
"TotalCount": {
"description": "Total number of contacts matching the filter criteria",
"type": "integer",
"example": 157
},
"Contacts": {
"properties": {
"Contact": {
"type": "array",
"items": {
"properties": {
"GID": {
"type": "integer",
"example": 12345
},
"UID": {
"type": "string",
"example": "ABC123"
},
"Name": {
"type": "string",
"example": "John Smith"
},
"Email": {
"type": "string",
"format": "email",
"example": "john@example.com"
},
"Title": {
"type": "string",
"example": "Mr"
},
"FirstName": {
"type": "string",
"example": "John"
},
"SecondName": {
"type": "string",
"example": "Smith"
},
"Type": {
"type": "string",
"example": "CON"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/info/{id}": {
"get": {
"tags": [
"Clients"
],
"summary": "Get information about a client",
"operationId": "596febc996667e0034be75c9302cd169",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Client Glide ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Request executed successfully",
"content": {
"application/xml": {
"schema": {
"properties": {
"Response": {
"properties": {
"Status": {
"type": "string"
},
"StatusReport": {
"type": "string"
},
"Count": {
"type": "integer"
},
"Clients": {
"properties": {
"Client": {
"properties": {
"GID": {
"type": "integer"
},
"UID": {
"type": "string"
},
"Name": {
"type": "string"
},
"Title": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"SecondName": {
"type": "string"
},
"Type": {
"type": "string"
},
"State": {
"type": "string"
},
"Office": {
"type": "integer"
},
"ManagerResponsible": {
"properties": {
"Code": {
"type": "integer"
},
"Name": {
"type": "string"
}
},
"type": "object"
},
"PartnerResponsible": {
"properties": {
"Code": {
"type": "integer"
},
"Name": {
"type": "string"
}
},
"type": "object"
},
"CHRegNumber": {
"type": "string"
},
"IncorpDate": {
"type": "string",
"format": "date"
},
"Email": {
"type": "string",
"format": "email"
},
"Contacts": {
"type": "object"
},
"AlternateID": {
"description": "Alternate/integration ID, as used by the CCH->Glide connector",
"type": "string"
},
"NextYearEnd": {
"description": "Next Year End",
"type": "string",
"format": "date"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/addresses/{id}": {
"get": {
"tags": [
"Clients"
],
"summary": "Get addresses connected to a client",
"operationId": "dc70e77dd5d80821bccfb0118e0fb41e",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Client ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Request executed successfully",
"content": {
"application/xml": {
"schema": {
"properties": {
"Response": {
"properties": {
"Status": {
"type": "string"
},
"StatusReport": {
"type": "string"
},
"Count": {
"type": "integer"
},
"Client": {
"properties": {
"GID": {
"type": "integer"
},
"UID": {
"type": "string"
},
"Name": {
"type": "string"
},
"Title": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"SecondName": {
"type": "string"
},
"Addresses": {
"properties": {
"Address": {
"type": "array",
"items": {
"properties": {
"GID": {
"type": "integer"
},
"Line1": {
"type": "string"
},
"Line2": {
"type": "string"
},
"Line3": {
"type": "string"
},
"City": {
"type": "string"
},
"Region": {
"type": "string"
},
"PostCode": {
"type": "string"
},
"Country": {
"type": "string"
},
"Salutation": {
"type": "string"
},
"Initials": {
"type": "string"
},
"MailingName": {
"type": "string"
},
"TradingName": {
"type": "string"
},
"AltEmail": {
"type": "string",
"format": "email"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients_by_id2/update": {
"post": {
"tags": [
"Clients"
],
"summary": "Update client information",
"description": "Updates an existing client's information using their integration ID or client code as identifier.",
"operationId": "fda44a0b0ec424887e29905b39c845ad",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"ucode": {
"description": "Glide client code",
"type": "string"
},
"code": {
"description": "Integration ID (alternative identifier)",
"type": "string"
},
"glideClientCode": {
"description": "Glide client code (alternative to ucode)",
"type": "string"
},
"integID": {
"description": "Integration ID (alternative to code)",
"type": "string"
},
"name": {
"description": "Client name",
"type": "string"
},
"firstn": {
"description": "First name / trading name",
"type": "string"
},
"title": {
"description": "Client title",
"type": "string"
},
"par": {
"description": "Partner responsible (user ID or initials)",
"type": "string"
},
"pari": {
"description": "Partner responsible (integration ID)",
"type": "string"
},
"man": {
"description": "Manager responsible (user ID or initials)",
"type": "string"
},
"mani": {
"description": "Manager responsible (integration ID)",
"type": "string"
},
"office": {
"description": "Office ID",
"type": "integer"
},
"opt_incorpdate": {
"description": "Incorporation date (YYYY-MM-DD)",
"type": "string",
"format": "date"
},
"opt_nextyearend": {
"description": "Next year end date (YYYY-MM-DD)",
"type": "string",
"format": "date"
},
"opt_corptax": {
"description": "Corporation tax required (1=Yes, 0=No)",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Client updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
},
"GlideID": {
"type": "integer",
"example": 12345
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found or validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/detaileddata": {
"get": {
"tags": [
"Clients"
],
"summary": "Get a bulk list of client data",
"operationId": "e184b80c807f2be524b535a4953ce6e4",
"parameters": [
{
"name": "fType",
"in": "query",
"description": "Filter by type of client",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Incorporation Date"
}
}
}
},
"/clients/{id}/clientCode": {
"put": {
"tags": [
"Clients"
],
"summary": "Update a client code",
"operationId": "793570df2c8355bdb7a3e3f4b9c8bdb2",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Client UID (e.g. 33)",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"newCode": {
"type": "string",
"example": "XYZ"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/create": {
"post": {
"tags": [
"Clients"
],
"summary": "Create a new client record",
"description": "Creates a new client in the system with the provided details. Returns the new client's Glide ID if successful.",
"operationId": "b74de8a6185cf026964bfb5ea1b30f36",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"ucode",
"type",
"name"
],
"properties": {
"ucode": {
"description": "Unique client code (for example AAA123)",
"type": "string"
},
"type": {
"description": "Client type code (1=LTD, 2=PLC, 3=SLT, 4=PAR, 5=LLP, 6=CHA, 7=CCO, 8=PSC, 9=SCH, 10=TRU, 11=CLU, 50=IND)",
"type": "integer"
},
"name": {
"description": "Client name (surname if individual, organisation name if organisation)",
"type": "string"
},
"firstn": {
"description": "First name/forename (used for individual clients only)",
"type": "string"
},
"title": {
"description": "Title (Mr/Mrs/etc) - used for individual clients only",
"type": "string"
},
"code": {
"description": "Alternative ID code - typically from integrated system e.g. CCH",
"type": "string"
},
"par": {
"description": "Partner responsible (specified by Glide ID or initials)",
"type": "string"
},
"pari": {
"description": "Partner responsible (specified by alternate ID)",
"type": "string"
},
"man": {
"description": "Manager responsible (specified by Glide ID or initials)",
"type": "string"
},
"mani": {
"description": "Manager responsible (specified by alternate ID)",
"type": "string"
},
"opt_incorpdate": {
"description": "Incorporation date (YYYY-MM-DD) - if company",
"type": "string",
"format": "date"
},
"opt_nextyearend": {
"description": "Next year end date (YYYY-MM-DD) - if company",
"type": "string",
"format": "date"
},
"opt_corptax": {
"description": "Corporation tax required flag (0=No, 1=Yes) - if company",
"type": "integer"
},
"opt_chnum": {
"description": "UK Companies House registration number - if relevant",
"type": "string"
},
"office": {
"description": "Office code (Glide office ID)",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Client creation response",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"description": "Overall status of the request",
"type": "string",
"enum": [
"OK",
"ERROR"
]
},
"StatusReport": {
"description": "Detailed status message",
"type": "string"
},
"Count": {
"description": "Number of clients created (1 or 0)",
"type": "integer"
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"description": "Creation success flag",
"type": "string",
"enum": [
"0",
"1"
]
},
"GlideID": {
"description": "New client's internal Glide ID",
"type": "string"
},
"Name": {
"description": "Client name as stored in system",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid input - required fields missing"
}
}
}
},
"/clients_by_id2/{id}/set/{irc}/{value}": {
"get": {
"tags": [
"Clients"
],
"summary": "**Set** client field (using Client Code)",
"operationId": "1d139b3c215ce439aeb04993e2a93542",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Glide Client Code (e.g. ABC123)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "irc",
"in": "path",
"description": "Additional field code (See: DB codes page inside Glide)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "New value for the field - format depends on the field type",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Field updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/{id}/get/{irc}": {
"get": {
"tags": [
"Clients"
],
"summary": "Retrieve client field data (using Glide Client ID)",
"operationId": "71f7700a179ca1934a993bb25e376c04",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Glide Client ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "Additional field code (See: Config->Database Codes Summary)",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Client field data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string"
},
"StatusReport": {
"type": "string"
},
"Data": {
"type": "string"
},
"Count": {
"type": "integer"
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"404": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string"
},
"StatusReport": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/{id}/systems/{sy}/route/{di}/{value}": {
"get": {
"tags": [
"Clients"
],
"summary": "Set the route for a client in a sub-system (by Glide ID)",
"operationId": "96278813a6889dc27bd76e0df7ddf48f",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Glide ID code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "sy",
"in": "path",
"description": "Workflow System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "di",
"in": "path",
"description": "Sub-System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "Route code",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Route updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "System default route status updated successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client was not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients_by_ccode/{id}/systems/{sy}/route/{di}/{value}": {
"get": {
"tags": [
"Clients"
],
"summary": "Set the route for a client in a sub-system (by Client Code)",
"operationId": "3231fcdb2924bba1997b96faa3fceb5d",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Client Code",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sy",
"in": "path",
"description": "Workflow System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "di",
"in": "path",
"description": "Sub-System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "Route code",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Route updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "System default route status updated successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client was not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients_by_id3/{id}/systems/{sy}/route/{di}/{value}": {
"get": {
"tags": [
"Clients"
],
"summary": "Set the route for a client in a sub-system (by Integration ID)",
"operationId": "300253f19e5abe7dbdad4043f7ba9b0b",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Integration ID code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "sy",
"in": "path",
"description": "Workflow System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "di",
"in": "path",
"description": "Sub-System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "Route code",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Route updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "System default route status updated successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client was not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/{id}/systems/{sy}/active/{di}/{value}": {
"get": {
"tags": [
"Clients"
],
"summary": "**Set** client active status for sub-system",
"operationId": "2d780098e565184d0821b7fca97792c9",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Glide Client ID (e.g. 20)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "sy",
"in": "path",
"description": "Workflow System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "di",
"in": "path",
"description": "Sub-System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "1 = Set active 0 = Set inactive",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Active status updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Sub-System active status updated successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client was not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients_by_ccode/{id}/systems/{sy}/active/{di}/{value}": {
"get": {
"tags": [
"Clients"
],
"summary": "**Set** client active status for sub-system (by Client Code)",
"operationId": "15ca0b9df57cbed4af13757809d0d82d",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Glide Client Code (e.g. ABC123)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sy",
"in": "path",
"description": "Workflow System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "di",
"in": "path",
"description": "Sub-System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "1 = Set active 0 = Set inactive",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Active status updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Sub-System active status updated successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client was not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients_by_id3/{id}/systems/{sy}/active/{di}/{value}": {
"get": {
"tags": [
"Clients"
],
"summary": "**Set** client active status for sub-system (by Integration ID)",
"operationId": "54bf7d9643c5a7c3a46dc0849e0fdff0",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Glide Integration ID code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "sy",
"in": "path",
"description": "Workflow System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "di",
"in": "path",
"description": "Sub-System code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "1 = Set active 0 = Set inactive",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Active status updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Sub-System active status updated successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client was not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients_by_id3/{id}/set/{irc}/{value}": {
"get": {
"tags": [
"Clients"
],
"summary": "**Set** client field (Glide Integration Code) value",
"operationId": "f95e2e24bcdc53c8dcb32cf36f8ceb2c",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Glide Integration Code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "Additional field code",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "Value to set for the field",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Field updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Client updated successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/{id}/set/{irc}/{value}": {
"get": {
"tags": [
"Clients"
],
"summary": "**Set** client field (Glide ID) value",
"description": "Sets a client field value using GET method. The value must be rawurlencode()'d in the URL path.\n *\n * **Value formats by field type:**\n *\n * | Field Type | Value Format |\n * |---|---|\n * | Date | YYYY-MM-DD or YYYY-MM-DD HH:MM:SS |\n * | Number | Integer e.g. 42 |\n * | Boolean | 0 (No), 1 (Yes), or -1 (Unset) |\n * | Staff/User | User ID (integer) or user initials (string e.g. JD) |\n * | String | Text string (max 20 characters) |\n * | Big String | Text string (unlimited length) |\n * | Email Address | Email address string |\n * | Website URL | URL string |\n * | Currency | Numeric string e.g. 1234.56 |\n * | Multiple Choice | Option ID (integer) |\n * | HTML | HTML content string |\n *\n * **Notes:**\n * - To clear a field, pass `-1` as the value (or `-500` for Staff/User fields).\n * - The `{value}` must be rawurlencode()'d since it is part of the URL path.",
"operationId": "b3bced1d22863da602d04f1b803001d9",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Glide Client ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "Additional field code (See: Config->Database Codes Summary)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "Value to set for the field. Must be rawurlencode()'d.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "updateJobs",
"in": "query",
"description": "When set to 1 on a Staff/User field, this will update linked job positions on active jobs to reflect the staff change",
"required": false,
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Field updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Client updated successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/{id}/set/{irc}": {
"post": {
"tags": [
"Clients"
],
"summary": "**Set** client field (Glide ID) value in POST",
"description": "Sets a client field value using POST method. The value is sent in the request body. Manual URL encoding is not needed for the POST variant.\n *\n * **Value formats by field type:**\n *\n * | Field Type | Value Format |\n * |---|---|\n * | Date | YYYY-MM-DD or YYYY-MM-DD HH:MM:SS |\n * | Number | Integer e.g. 42 |\n * | Boolean | 0 (No), 1 (Yes), or -1 (Unset) |\n * | Staff/User | User ID (integer) or user initials (string e.g. JD) |\n * | String | Text string (max 20 characters) |\n * | Big String | Text string (unlimited length) |\n * | Email Address | Email address string |\n * | Website URL | URL string |\n * | Currency | Numeric string e.g. 1234.56 |\n * | Multiple Choice | Option ID (integer) |\n * | HTML | HTML content string |\n *\n * **Notes:**\n * - To clear a field, pass `-1` as the value (or `-500` for Staff/User fields).",
"operationId": "0aacdfae7424ae23995fe5fbfb07af9e",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Glide Client ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "Additional field code (See: Config->Database Codes Summary)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "updateJobs",
"in": "query",
"description": "When set to 1 on a Staff/User field, this will update linked job positions on active jobs to reflect the staff change",
"required": false,
"schema": {
"type": "integer",
"enum": [
0,
1
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"value": {
"description": "Value to set for the field",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Field updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Client updated successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Client not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Client not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/clients/zapier_trigger_list/{opt}": {
"get": {
"tags": [
"Clients"
],
"summary": "[JSON only] Get a list of clients in order of creation, most recent first",
"operationId": "e5c7d9e2cd361b61787785ed7f773ef2",
"parameters": [
{
"name": "opt",
"in": "path",
"description": "Unknown - set as 0",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"created": {
"type": "string",
"format": "date-time"
},
"type": {
"type": "integer"
},
"status": {
"type": "integer"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
}
},
"/tools/lookupClient": {
"post": {
"tags": [
"Clients"
],
"summary": "[JSON response only] Lookup a client via the client code or email address",
"operationId": "a865fde6326e1876d1f83aef8fc6a4e1",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"search"
],
"properties": {
"search": {
"description": "Search string either client code or email address of the client",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"Success": {
"type": "integer"
},
"DisType": {
"type": "integer"
},
"ClientType": {
"type": "integer"
},
"GID": {
"type": "integer"
},
"Code": {
"type": "string"
},
"Name": {
"type": "string"
},
"Email": {
"type": "string",
"format": "email"
}
},
"type": "object"
}
}
}
}
},
"deprecated": true
}
},
"/time/categories": {
"get": {
"tags": [
"Time & Fees"
],
"summary": "Retrieve a list of time categories",
"description": "This endpoint returns a list of time categories available in the system. The response can be in XML or JSON format based on the 'returnFormat' query parameter.",
"operationId": "84034f88897b49ded411ff5f1579033b",
"parameters": [
{
"name": "returnFormat",
"in": "query",
"description": "Specify the format of the response: 0 for XML, 1 for JSON",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"properties": {
"Categories": {
"type": "array",
"items": {
"properties": {
"GID": {
"type": "integer",
"example": 2001
},
"Chargeable": {
"type": "integer",
"example": 1
},
"Name": {
"type": "string",
"example": "Time Category 1"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"application/xml": {
"schema": {
"properties": {
"Response": {
"properties": {
"Categories": {
"properties": {
"Category": {
"properties": {
"GID": {
"type": "integer",
"example": 2001
},
"Chargeable": {
"type": "integer",
"example": 1
},
"Name": {
"type": "string",
"example": "Time Category 1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/bills/settag/{id}": {
"get": {
"tags": [
"Time & Fees"
],
"summary": "Get/Set a tag for a particular bill/invoice. Displayed in Glide but not used internally by Glide.",
"operationId": "6784eac9af598fdb51a16eb07d0a1362",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Bill/Invoice Glide ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "tag",
"in": "query",
"description": "Tag",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"properties": {
"Bills": {
"properties": {
"Bill": {
"properties": {
"GID": {
"type": "string",
"example": "12"
},
"Tag": {
"type": "string",
"example": "403AA"
}
},
"type": "object"
}
},
"type": "object"
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/bills/settagandinv/{id}": {
"get": {
"tags": [
"Time & Fees"
],
"summary": "Get/Set a tag and invoice code for a particular bill/invoice. Tag is displayed in Glide but not used internally by Glide.",
"operationId": "a673d7f2b708674019b8fca2f0fc0306",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Bill/Invoice Glide ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "tag",
"in": "query",
"description": "Tag",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "inv",
"in": "query",
"description": "Invoice code",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"properties": {
"Bills": {
"properties": {
"Bill": {
"properties": {
"GID": {
"type": "string",
"example": "12"
},
"Tag": {
"type": "string",
"example": "403AA"
},
"Inv": {
"type": "string",
"example": "ABC1"
}
},
"type": "object"
}
},
"type": "object"
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/invoices/create": {
"post": {
"tags": [
"Time & Fees"
],
"summary": "Create a new invoice",
"operationId": "16c948c56fa3240eeb8e5acdc65397fd",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"invoice_code": {
"description": "The invoice code",
"type": "string"
},
"client_id": {
"description": "The client ID",
"type": "integer"
},
"title": {
"description": "The title of the invoice",
"type": "string"
},
"invoice_date": {
"description": "The invoice date",
"type": "string",
"format": "date"
},
"tax_rate": {
"description": "The tax rate for the invoice",
"type": "number",
"format": "float"
},
"line_items": {
"type": "array",
"items": {
"properties": {
"value": {
"description": "The value of the line item",
"type": "number",
"format": "float"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"invoice_id": {
"type": "integer"
},
"line_id": {
"type": "integer"
}
},
"type": "object"
}
}
}
}
}
}
},
"/invoices/wip/create": {
"post": {
"tags": [
"Time & Fees"
],
"summary": "Create a new WIP record",
"operationId": "9885d88ca55375162be943db9b243723",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"wip_type": {
"type": "string",
"enum": [
"STAFF_CATEGORY_LINKED",
"CLIENT_JOB_LINKED",
"CLIENT_CATEGORY_LINKED"
]
},
"user_id": {
"type": "integer"
},
"client_id": {
"type": "integer"
},
"job_id": {
"type": "integer"
},
"charge_rate_id": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"job_stage_id": {
"type": "integer",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"minutes": {
"type": "integer"
},
"date": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean"
},
"wip_id": {
"type": "integer"
}
},
"type": "object"
}
}
}
}
}
}
},
"/timesheets/wip": {
"get": {
"tags": [
"Time & Fees"
],
"summary": "Get current WIP time recorded",
"operationId": "33e156ac0762e3130ccad3c05ba45f39",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"GID": {
"type": "integer"
},
"WIP_Type": {
"type": "integer"
},
"WIP_User": {
"type": "integer"
},
"WIP_ClientID": {
"type": "integer"
},
"WIP_ClientCode": {
"type": "string"
},
"WIP_Comment": {
"type": "string"
},
"WIP_JobID": {
"type": "integer"
},
"WIP_JobStageID": {
"type": "integer"
},
"WIP_TaskID": {
"type": "integer"
},
"WIP_Category": {
"type": "string"
},
"WIP_OriginalMinutes": {
"type": "integer"
},
"WIP_MinutesRemaining": {
"type": "integer"
},
"WIP_BillsUsingMinutes": {
"type": "integer"
},
"WIP_DateStart": {
"type": "string",
"format": "date"
},
"WIP_DateEnd": {
"type": "string",
"format": "date"
},
"WIP_RateUsed": {
"type": "number",
"format": "float"
},
"WIP_Value": {
"type": "number",
"format": "float"
},
"WIP_TimesheetID": {
"type": "integer"
}
},
"type": "object"
}
}
}
}
}
}
}
},
"/inputs/detailed": {
"get": {
"tags": [
"Time & Fees"
],
"summary": "Get detailed time and expense inputs (paginated)",
"description": "Returns individual timesheet entries without aggregation. Combines data from WIP and Billed timesheet tables.",
"operationId": "0be549d36be81c9f4e9e033f41573c88",
"parameters": [
{
"name": "from",
"in": "query",
"description": "Start date for the report (YYYY-MM-DD)",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "End date for the report (YYYY-MM-DD)",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "office",
"in": "query",
"description": "Office ID to filter by. -10 = all offices, -1 = no office assigned",
"required": false,
"schema": {
"type": "integer",
"default": -10
}
},
{
"name": "offset",
"in": "query",
"description": "Number of records to skip (for pagination)",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of records to return (max 100)",
"required": false,
"schema": {
"type": "integer",
"default": 100,
"maximum": 100
}
},
{
"name": "entryType",
"in": "query",
"description": "Filter by entry type. -1 = all, 0 = Time only, 5 = Expense only",
"required": false,
"schema": {
"type": "integer",
"default": -1,
"enum": [
-1,
0,
5
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request completed successfully"
},
"TotalCount": {
"type": "integer",
"example": 1523
},
"Count": {
"type": "integer",
"example": 100
},
"Offset": {
"type": "integer",
"example": 0
},
"Limit": {
"type": "integer",
"example": 100
},
"Data": {
"type": "array",
"items": {
"properties": {
"RecordID": {
"type": "string",
"example": "WIP-12345"
},
"Date": {
"type": "string",
"format": "date",
"example": "2024-01-15"
},
"ClientCode": {
"type": "string",
"example": "ABC001"
},
"ClientName": {
"type": "string",
"example": "Acme Ltd"
},
"UserInitials": {
"type": "string",
"example": "JD"
},
"Office": {
"type": "string",
"example": "London"
},
"EntryType": {
"type": "string",
"example": "Time"
},
"Minutes": {
"type": "integer",
"example": 60
},
"Rate": {
"type": "number",
"format": "float",
"example": 150
},
"Value": {
"type": "number",
"format": "float",
"example": 150
},
"Source": {
"type": "string",
"example": "WIP"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request - missing required parameters"
}
}
}
},
"/jobs/list": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get list of jobs",
"description": "Use /jobs/all instead",
"operationId": "66cc9b65713087199bceb2882cbb4b6d",
"parameters": [
{
"name": "fSystem",
"in": "query",
"description": "Filter by system (Glide ID)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "fClient",
"in": "query",
"description": "Filter by client (Glide ID)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "fState",
"in": "query",
"description": "Filter by state (0 = Not started, 1 = In progress, 2 = Completed, 3 = Not completed)",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Status"
}
},
"deprecated": true
}
},
"/jobs/all": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get all jobs (paginated)",
"description": "Returns a paginated list of jobs with their positions. Each job includes a Positions element containing Slot1-Slot16 fields representing staff assignments. Slot1 = Partner, Slot2 = Manager. Each slot contains the user ID (or -1 if unassigned). Only active positions for each system are included.",
"operationId": "1cf1db7d1df4aaee8f93b0c96014f4e9",
"parameters": [
{
"name": "fSystem",
"in": "query",
"description": "Filter by system (Glide ID)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "fClient",
"in": "query",
"description": "Filter by client (Glide ID)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "fState",
"in": "query",
"description": "Filter by state (0 = Not started, 1 = In progress, 2 = Completed, 3 = Not completed)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"description": "Number of records to skip",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of records to return",
"required": false,
"schema": {
"type": "integer",
"default": 10,
"maximum": 100
}
}
],
"responses": {
"200": {
"description": "List of jobs with positions. Positions use Slot1-Slot16 naming: Slot1=Partner, Slot2=Manager, Slot3=Manager2, Slot4=Preparer, Slot5=Preparer2, Slot6=Preparer3, Slot7=Reviewer1, Slot8=Reviewer2, Slot9=Reviewer3, Slot10-16=Custom slots"
}
}
}
},
"/jobs/list/{sys}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get list of jobs for a particular system",
"operationId": "46e003ec555d4e48af6de2b75a9192c0",
"parameters": [
{
"name": "sys",
"in": "path",
"description": "Glide system (Glide ID)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "fClient",
"in": "query",
"description": "Filter by client (Glide ID)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "fState",
"in": "query",
"description": "Filter by state (0 = Not started, 1 = In progress, 2 = Completed, 3 = Not completed)",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Status"
}
}
}
},
"/jobs/list/{sys}/{client}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get list of jobs for a particular system/client combination",
"operationId": "3040630be55072e3f4914dd696b2308f",
"parameters": [
{
"name": "sys",
"in": "path",
"description": "System (Glide ID)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "client",
"in": "path",
"description": "Client (Glide ID)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "fState",
"in": "query",
"description": "Filter by state (0 = Not started, 1 = In progress, 2 = Completed, 3 = Not completed)",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Status"
}
}
}
},
"/jobs/summary/{id}/verbose": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get job info (extra detail)",
"operationId": "c51b3d6fb82d73dcd2cbc5d9eeaeb67e",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job ID (Glide Unqiue ID)",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "-"
}
}
}
},
"/jobs/summary/{id}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get job info",
"operationId": "f8b79db9fd5af5c4bde658b2c03c8412",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job ID (Glide ID)",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "-"
}
}
}
},
"/jobs/{id}/available_paths": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get a list of paths/steps that are available to a particular job",
"description": "Returns all available workflow paths that can be taken for the specified job based on its current state.",
"operationId": "5052c07f272042905efe360f1f94815f",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the job",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "List of available paths",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Paths": {
"type": "array",
"items": {
"properties": {
"PathID": {
"type": "integer",
"example": 100
},
"PathName": {
"type": "string",
"example": "Complete Review"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/take_path/{city}": {
"post": {
"tags": [
"Jobs"
],
"summary": "Take step - advance a job along a workflow step",
"description": "Advances a job by taking a specified workflow step.",
"operationId": "b03ef85ee458001a9a781ec7ef23789a",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "city",
"in": "path",
"description": "Step ID to take. Use GET /jobs/{id}/available_paths to discover valid IDs.",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Step taken successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found or step not available",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/take_path/{city}/{date}": {
"post": {
"tags": [
"Jobs"
],
"summary": "Take a step with a specific date",
"description": "Advances a job by taking a specified workflow step, setting a specific date.",
"operationId": "0f03740d30b78588ddea85611081f66d",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "city",
"in": "path",
"description": "Step ID to take. Use GET /jobs/{id}/available_paths to discover valid IDs.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "date",
"in": "path",
"description": "Date to set (YYYY-MM-DD format)",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Step taken successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found or step not available",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/subjobs/{dis}/take_path/{city}": {
"post": {
"tags": [
"Jobs"
],
"summary": "Take step for a sub-job",
"description": "Advances a specific sub-job by taking a specified workflow step. The sub-system identifies which sub-job to move.",
"operationId": "9d5dbed7d3d237cc239f4cfaca1463f5",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "dis",
"in": "path",
"description": "Sub-system ID associated with the sub-job you are progressing. Use GET /subsystem/list to discover valid IDs.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "city",
"in": "path",
"description": "Step ID to take. Use GET /jobs/{id}/available_paths to discover valid IDs.",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Step taken successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job or sub-job not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/subjobs/{dis}/take_path/{city}/{date}": {
"post": {
"tags": [
"Jobs"
],
"summary": "Take a step for a sub-job with a specific date",
"description": "Advances a specific sub-job by taking a specified workflow step, setting a specific date. The sub-system identifies which sub-job to move.",
"operationId": "05cc364f9855ab89d873d8675be13f65",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "dis",
"in": "path",
"description": "Sub-system ID associated with the sub-job you are progressing. Use GET /subsystem/list to discover valid IDs.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "city",
"in": "path",
"description": "Step ID to take. Use GET /jobs/{id}/available_paths to discover valid IDs.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "date",
"in": "path",
"description": "Date to record (format YYYY-MM-DD)",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Step taken successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job, sub-job or step not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "That step is not available to take"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/subjobs/{dis}/set_holder": {
"post": {
"tags": [
"Jobs"
],
"summary": "Set the holder of a sub-job/lander",
"operationId": "19b2eb968d3bc707a64e6314b1a25594",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job UID (mothership ID)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "dis",
"in": "path",
"description": "Sub-system ID associated with the sub-job. Use GET /subsystem/list to discover valid IDs.",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"user_id": {
"description": "The user ID to set as the holder",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success or error response"
}
}
}
},
"/jobs/{id}/set/{irc}": {
"put": {
"tags": [
"Jobs"
],
"summary": "Set job field value via PUT",
"description": "Sets a value in a job's information repository field.",
"operationId": "64c7dea67a5dd279d04525ccb6e84b2c",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the job",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "The field/information repository ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "query",
"description": "Value to set",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Field updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Job updated successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
},
"post": {
"tags": [
"Jobs"
],
"summary": "Set job field value via POST body",
"description": "Sets a value in a job's information repository field using POST body.",
"operationId": "be6b3b3e62a89f138c42ea3f31b6d700",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the job",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "The field/information repository ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"value": {
"description": "Value to set",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Field updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Job updated successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/set/{irc}/{value}": {
"post": {
"tags": [
"Jobs"
],
"summary": "Set job field value with value in URL",
"description": "Sets a value in a job's information repository field with the value specified in the URL path.",
"operationId": "cfb102837bc7361be8cc328381945ba7",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the job",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "The field/information repository ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "The value to set",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Field updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Job updated successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/get/{irc}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get data from a job field",
"description": "Retrieves the value stored in a specific job field.",
"operationId": "cd82acc9094c42366bf2a80422286661",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "Job Field UID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Field value retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Data": {
"description": "The value stored in the field",
"type": "string",
"example": "some value"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/date/{irc}": {
"put": {
"tags": [
"Jobs"
],
"summary": "Place data into a job field",
"operationId": "7b77d12b365b2a055a9a4972b3621d7a",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "Job Field UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "query",
"description": "Date value to set (YYYY-MM-DD)",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Date field updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Job updated successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/date/{irc}/{value}": {
"put": {
"tags": [
"Jobs"
],
"summary": "Place data into an information repository",
"operationId": "bf8b9eea206ecb5ca4f762020d873ab9",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "Job Field UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "Date to set (YYYY-MM-DD format)",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Date field updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Job updated successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/target/{irc}": {
"put": {
"tags": [
"Jobs"
],
"summary": "Clear a target date",
"description": "Clears/resets a target date for a job workflow stage.",
"operationId": "6b6be510ec258d4e6335d8cc4ccace8c",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "Target/stage ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Target cleared successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Target updated successfully"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/{id}/target/{irc}/{value}": {
"put": {
"tags": [
"Jobs"
],
"summary": "Set a target date for a job workflow stage",
"description": "Sets a target date for a specific stage/step in the job workflow. Target dates help track expected completion times for workflow stages.",
"operationId": "bbd2efd46aac0f65a1b1d5e8a09e64d3",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job UID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "irc",
"in": "path",
"description": "Target/stage ID identifying which workflow stage to set the target for",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "value",
"in": "path",
"description": "Target date value in YYYY-MM-DD format",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Target date set successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Target set successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Job not found or invalid parameters",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Job not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/getjoblistdata/system/{sys}/filter/{fil}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get job list data by system and filter",
"description": "Retrieves a list of jobs for a specific system with optional client filtering. Returns job details including state, dates, and client information.",
"operationId": "c53f1a6223f3cec7fc4d303a799f0e26",
"parameters": [
{
"name": "sys",
"in": "path",
"description": "System/universe ID to filter jobs by (-1 for all systems)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "fil",
"in": "path",
"description": "Client filter: client ID to filter by, -1 for active clients only, -2 for all clients",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Job list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": ""
},
"Count": {
"description": "Total number of jobs matching the filter",
"type": "integer",
"example": 25
},
"Jobs": {
"properties": {
"Job": {
"type": "array",
"items": {
"properties": {
"JobGlideID": {
"description": "Unique job identifier",
"type": "integer",
"example": 12345
},
"JobType": {
"description": "Universe/system name",
"type": "string",
"example": "Accounts"
},
"JobDate": {
"description": "Job due date",
"type": "string",
"format": "date",
"example": "2024-03-31"
},
"JobCompletedDateField": {
"description": "Date job was completed (or placeholder for incomplete)",
"type": "string",
"format": "date-time",
"example": "2024-02-15 00:00:00"
},
"JobState": {
"type": "string",
"enum": [
"Not Started",
"In Progress",
"Completed"
],
"example": "In Progress"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/getjoblistdata_deadline/system/{sys}/city/{city}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get job list data with deadline information",
"description": "Retrieves a list of jobs for a specific system including deadline dates for a specified workflow stage (city). Returns job details with deadline information for the specified stage.",
"operationId": "159d00ef13ef464a03b4f6fc86d5ed6e",
"parameters": [
{
"name": "sys",
"in": "path",
"description": "System/universe ID to filter jobs by (-1 for all systems)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "city",
"in": "path",
"description": "Workflow stage (city) ID to retrieve deadline information for",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Job list with deadlines retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": ""
},
"Count": {
"description": "Total number of jobs matching the filter",
"type": "integer",
"example": 25
},
"Jobs": {
"properties": {
"Job": {
"type": "array",
"items": {
"properties": {
"JobGlideID": {
"description": "Unique job identifier",
"type": "integer",
"example": 12345
},
"JobType": {
"description": "Universe/system name",
"type": "string",
"example": "Accounts"
},
"JobDate": {
"description": "Job due date",
"type": "string",
"format": "date",
"example": "2024-03-31"
},
"JobCompletedDateField": {
"description": "Date job was completed (or placeholder for incomplete)",
"type": "string",
"format": "date-time",
"example": "2024-02-15 00:00:00"
},
"JobState": {
"type": "string",
"enum": [
"Not Started",
"In Progress",
"Completed"
],
"example": "In Progress"
},
"Deadline": {
"description": "Deadline date for the specified workflow stage, or EMPTY if not set",
"type": "string",
"example": "2024-04-15"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/getfixedyearjob/{system}/{template}/{year}/{client}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get job info for fixed year systems",
"description": "Retrieves the job ID for a specific client, year, and template combination in systems that use fixed year periods (e.g., tax years). Useful for finding the job associated with a specific tax year for a client.",
"operationId": "8d1293a3032885c23540a7f0cb2be264",
"parameters": [
{
"name": "system",
"in": "path",
"description": "The system/universe ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "template",
"in": "path",
"description": "The template ID that defines the fixed year configuration",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "year",
"in": "path",
"description": "The calendar year to search for (e.g., 2024)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "client",
"in": "path",
"description": "The client ID (Glide internal ID)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Job lookup completed",
"content": {
"application/json": {
"schema": {
"properties": {
"JobCode": {
"description": "The job ID if found, or -1 if no matching job exists",
"type": "integer",
"example": 12345
},
"Status": {
"description": "OK on success, ERROR on failure",
"type": "string",
"example": "OK"
},
"StatusReport": {
"description": "Descriptive status message. Error messages include: Fixed year not found, Job not found, Client not found",
"type": "string",
"example": "Request executed successfully"
}
},
"type": "object"
}
}
}
}
}
}
},
"/getfixedyearjob_integcc/{system}/{template}/{year}/{client}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get job info for fixed year systems using Integration Client Code",
"description": "Retrieves the job ID for a specific client (identified by integration code), year, and template combination in systems that use fixed year periods. Similar to getfixedyearjob but uses the external integration client code instead of the internal Glide ID.",
"operationId": "21671c754531314f5b8ac9e01595b60b",
"parameters": [
{
"name": "system",
"in": "path",
"description": "The system/universe ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "template",
"in": "path",
"description": "The template ID that defines the fixed year configuration",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "year",
"in": "path",
"description": "The calendar year to search for (e.g., 2024)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "client",
"in": "path",
"description": "The client's integration code (external system identifier)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Job lookup completed",
"content": {
"application/json": {
"schema": {
"properties": {
"JobCode": {
"description": "The job ID if found, or -1 if no matching job exists",
"type": "integer",
"example": 12345
},
"Status": {
"description": "OK on success, ERROR on failure",
"type": "string",
"example": "OK"
},
"StatusReport": {
"description": "Descriptive status message. Error messages include: Fixed year not found, Job not found, Client not found",
"type": "string",
"example": "Request executed successfully"
}
},
"type": "object"
}
}
}
}
}
}
},
"/jobs/calendar": {
"get": {
"tags": [
"Jobs"
],
"summary": "[JSON] Get upcoming 12 months worth of jobs.",
"operationId": "c38378b9557369683c7be18717ec908e",
"parameters": [
{
"name": "filterClient",
"in": "query",
"description": "Filter by client (Glide UID)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filterFrom",
"in": "query",
"description": "Filter by job date - from (Date e.g. 2025-02-05)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "filterTo",
"in": "query",
"description": "Filter by job date - to (Date e.g. 2025-07-12)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/jobs/calendar/{sys}": {
"get": {
"tags": [
"Jobs"
],
"summary": "[JSON] Get upcoming 12 months worth of jobs for a particular workflow system.",
"operationId": "f9e01ad1d68d39a6ba5cc2b0d92ac7b6",
"parameters": [
{
"name": "sys",
"in": "path",
"description": "Filter by workflow system (Glide UID)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "filterClient",
"in": "query",
"description": "Filter by client (Glide UID)",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "filterFrom",
"in": "query",
"description": "Filter by job date - from (Date e.g. 2025-02-05)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "filterTo",
"in": "query",
"description": "Filter by job date - to (Date e.g. 2025-07-12)",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
},
"/jobs/out_deadlines_bulk": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get outstanding deadline information.",
"operationId": "659df1864ce5dd5cf4c532cc49d3366f",
"responses": {
"200": {
"description": "Returns deadline information"
}
}
}
},
"/jobs/zapier_trigger_list/{opt}": {
"get": {
"tags": [
"Jobs"
],
"summary": "[JSON only] Get a list of jobs in order of creation, most recent first",
"operationId": "daa63926516de4f73757cf6fce26523a",
"parameters": [
{
"name": "opt",
"in": "path",
"description": "Unknown - set as 0",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"created": {
"description": "Job creation date/time",
"type": "string",
"format": "date-time"
},
"systemID": {
"description": "Glide ID of the workflow system",
"type": "integer"
},
"clientID": {
"description": "Glide ID of the client",
"type": "integer"
},
"officeID": {
"description": "Glide ID of the office",
"type": "integer"
}
},
"type": "object"
}
}
}
}
}
}
}
},
"/jobs/create/{sysid}/client/{clientid}/route/{rt}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Create a job",
"operationId": "312feec887eed1d4404af0fe5539c4a3",
"responses": {
"200": {
"description": "Status report"
}
},
"deprecated": true
}
},
"/jobs/{id}/set_job_position/{position}": {
"post": {
"tags": [
"Jobs"
],
"summary": "Set a staff member or staff group to a job position",
"description": "Sets a staff member, staff group, or clears a job position field (Partner, Manager, Preparer, etc.)",
"operationId": "2fa958f366714db033a1b529ef292771",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Job ID (mothership mi_iD)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "position",
"in": "path",
"description": "Position number (1=Partner, 2=Manager, 3=Manager2, 4=Preparer, 5=PreparerAss, 6=PreparerAss2, 7=1stReviewer, 8=2ndReviewer, 9=3rdReviewer, 10-16=Custom slots)",
"required": true,
"schema": {
"type": "integer",
"maximum": 16,
"minimum": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"value"
],
"properties": {
"value": {
"description": "User ID (positive), -1 to clear, or staff group ID (negative <= -1000)",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Position updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Job position updated successfully"
},
"JobID": {
"type": "integer"
},
"Position": {
"type": "integer"
},
"FieldName": {
"type": "string"
},
"NewValue": {
"type": "integer"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Invalid position. Must be between 1 and 16."
}
},
"type": "object"
}
}
}
}
}
}
},
"/offices/list": {
"get": {
"tags": [
"Offices"
],
"summary": "Get list of offices",
"description": "Return list of offices including counts of connected clients & users.",
"operationId": "7ff3eb86ff5f9cf1a1f3cfa002bd8b5e",
"parameters": [
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON (default), 0 for XML",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Count": {
"type": "integer",
"example": 5
},
"Offices": {
"properties": {
"Office": {
"type": "array",
"items": {
"properties": {
"ID": {
"type": "integer",
"example": 1
},
"Name": {
"type": "string",
"example": "Main Office"
},
"Abbreviation": {
"type": "string",
"example": "MAIN"
},
"ClientCount": {
"type": "integer",
"example": 25
},
"UserCount": {
"type": "integer",
"example": 10
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/offices/create": {
"post": {
"tags": [
"Offices"
],
"summary": "Create a new office",
"description": "Create a new office with the specified name and abbreviation.",
"operationId": "d752f35df2097c04c1e19b2897c3f4f8",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"name",
"abb"
],
"properties": {
"name": {
"description": "Office name",
"type": "string",
"example": "New Branch Office"
},
"abb": {
"description": "Office abbreviation",
"type": "string",
"example": "NBC"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Office created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Office created"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid parameters",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Invalid parameters"
}
},
"type": "object"
}
}
}
}
}
}
},
"/offices/update": {
"post": {
"tags": [
"Offices"
],
"summary": "Update an existing office",
"description": "Update an office's name and abbreviation by ID.",
"operationId": "3ea3f6b84328131ae653c5bb09517b21",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"id",
"name",
"abb"
],
"properties": {
"id": {
"description": "Office ID",
"type": "integer",
"example": 1
},
"name": {
"description": "Office name",
"type": "string",
"example": "Updated Office Name"
},
"abb": {
"description": "Office abbreviation",
"type": "string",
"example": "UON"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Office updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Office updated"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid parameters",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Invalid parameters"
}
},
"type": "object"
}
}
}
}
}
}
},
"/offices/delete": {
"post": {
"tags": [
"Offices"
],
"summary": "Delete an office",
"description": "Delete an office by ID. Will refuse deletion if clients or users are connected to the office.",
"operationId": "eba18981b234f356d26a81526cdaeb18",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"id"
],
"properties": {
"id": {
"description": "Office ID to delete",
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Office deleted successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Office deleted"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid ID or office cannot be deleted",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"oneOf": [
{
"type": "string",
"example": "Invalid ID"
},
{
"type": "string",
"example": "Office cannot be deleted (clients/users linked)"
}
]
}
},
"type": "object"
}
}
}
}
}
}
},
"/scheduler/add": {
"post": {
"tags": [
"Scheduler"
],
"summary": "Add a new scheduler item",
"description": "Creates a new scheduler event with specified start/end times and optional connections to clients/jobs",
"operationId": "ef320d6882a404b219474657614d96ce",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"user_id"
],
"properties": {
"user_id": {
"description": "ID of the user the scheduler item is linked to (required)",
"type": "integer"
},
"start": {
"description": "Start date/time (e.g., '2024-03-15 09:00:00' or '2024-03-15' for all-day)",
"type": "string",
"format": "date-time"
},
"end": {
"description": "End date/time (e.g., '2024-03-15 17:00:00' or '2024-03-16' for all-day)",
"type": "string",
"format": "date-time"
},
"length": {
"description": "Duration in hours (or days if all_day is true). Alternative to providing end time",
"type": "number"
},
"all_day": {
"description": "Whether this is an all-day event",
"type": "boolean"
},
"client_id": {
"description": "Optional client ID to link the event to",
"type": "integer"
},
"job_id": {
"description": "Optional job ID to link the event to",
"type": "integer"
},
"task_id": {
"description": "Optional task ID to link the event to",
"type": "integer"
},
"type": {
"description": "Special event type (cannot be used with client/job connections)",
"type": "string",
"enum": [
"Holiday",
"Sickness",
"Training"
]
},
"description": {
"description": "Event description (max 128 characters)",
"type": "string",
"maxLength": 128
},
"color": {
"description": "Fixed color ID for the event (1-16)",
"type": "integer"
},
"status": {
"description": "Event status (default: unlocked)",
"type": "string",
"enum": [
"unlocked",
"locked",
"pinned"
]
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Scheduler item created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": true
},
"message": {
"type": "string",
"example": "Scheduler item created successfully"
},
"data": {
"properties": {
"id": {
"type": "integer",
"example": 12345
},
"user_id": {
"type": "integer"
},
"start": {
"type": "string",
"format": "date-time"
},
"end": {
"type": "string",
"format": "date-time"
},
"all_day": {
"type": "boolean"
},
"client_id": {
"type": "integer"
},
"job_id": {
"type": "integer"
},
"description": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Bad request - Invalid input data",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Validation failed"
},
"errors": {
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/systems/list": {
"get": {
"tags": [
"Workflow Systems"
],
"summary": "Get a list of workflow systems",
"operationId": "6dd8c5a0ac73d7e05a73137c177db7be",
"parameters": [
{
"name": "returnFormat",
"in": "query",
"description": "Return JSON instead of XML",
"required": false,
"schema": {
"type": "integer",
"default": 1
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Count": {
"type": "string",
"example": "14"
},
"Systems": {}
},
"type": "object"
}
}
}
}
}
}
},
"/systems/{id}": {
"get": {
"tags": [
"Workflow Systems"
],
"summary": "Get information about a system",
"operationId": "df88114307d23a31f77d0fa3fa1fd407",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the system",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Count": {
"type": "string",
"example": "14"
},
"Systems": {}
},
"type": "object"
}
}
}
}
}
}
},
"/system/{id}/triggers": {
"get": {
"tags": [
"Workflow Systems"
],
"summary": "Get a list of job creation triggers for a system",
"description": "Retrieves all job creation triggers configured for a specific workflow system. Triggers define automated job creation rules based on date patterns.",
"operationId": "018e7057628f4a06328696ed61250d4e",
"parameters": [
{
"name": "id",
"in": "path",
"description": "System/universe ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Triggers retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Count": {
"description": "Number of triggers found",
"type": "integer",
"example": 3
},
"Triggers": {
"properties": {
"Trigger": {
"type": "array",
"items": {
"properties": {
"ID": {
"description": "Trigger ID",
"type": "integer",
"example": 15
},
"Name": {
"description": "Trigger name",
"type": "string",
"example": "Annual Accounts"
},
"FreqCode": {
"description": "Frequency code",
"type": "integer",
"example": 2
},
"FreqDesc": {
"description": "Frequency description (Calendar days, Monthly variants, Years, Working days)",
"type": "string",
"example": "Years"
},
"FreqAmount": {
"description": "Frequency amount",
"type": "integer",
"example": 1
},
"CreationOffset": {
"description": "Job creation offset in days",
"type": "integer",
"example": 30
},
"DisplayOrder": {
"description": "Display order",
"type": "integer",
"example": 1
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/subsystem/{id}/routes": {
"get": {
"tags": [
"Workflow Systems"
],
"summary": "Get a list of routes for a sub-system",
"description": "Retrieves all workflow routes configured for a specific sub-system (discipline). Routes define different workflow paths that jobs can take.",
"operationId": "1744c035ac88b48b5c6c0c9b9d390c6d",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Sub-system (discipline) ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Routes retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Count": {
"description": "Number of routes found",
"type": "integer",
"example": 3
},
"Routes": {
"properties": {
"Route": {
"type": "array",
"items": {
"properties": {
"ID": {
"description": "Route ID",
"type": "integer",
"example": 25
},
"Name": {
"description": "Route name",
"type": "string",
"example": "Standard Route"
},
"Default": {
"description": "Whether this is the default route",
"type": "string",
"enum": [
"Yes",
"No"
],
"example": "Yes"
},
"Status": {
"description": "Route status",
"type": "string",
"enum": [
"Active",
"Archived"
],
"example": "Active"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid sub-system ID",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Invalid Sub-system ID. It must be a non-negative integer."
}
},
"type": "object"
}
}
}
}
}
}
},
"/systemCodes.json": {
"get": {
"tags": [
"Workflow Systems"
],
"summary": "Get a list of active systems. [JSON]",
"operationId": "7e5ceb68c94125d0160af1628ae0b0c3",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
}
},
"/subsystem/list": {
"get": {
"tags": [
"Workflow Systems"
],
"summary": "Get a list of subsystems (disciplines)",
"description": "Retrieves all sub-systems (disciplines) across all workflow systems. Sub-systems represent different job types within a system (e.g., Audit, Accounts within an Accounts system).",
"operationId": "34831b3c38575a92af6bb22add7a0b77",
"parameters": [
{
"name": "routes",
"in": "query",
"description": "Include routes for each subsystem: 1 to include, 0 to exclude (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "Sub-systems retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Count": {
"description": "Number of sub-systems found",
"type": "integer",
"example": 12
},
"SubSystems": {
"properties": {
"SubSystem": {
"type": "array",
"items": {
"properties": {
"ID": {
"description": "Sub-system ID",
"type": "integer",
"example": 5
},
"Name": {
"description": "Sub-system name",
"type": "string",
"example": "Audit"
},
"SystemID": {
"description": "Parent system ID",
"type": "integer",
"example": 2
},
"SystemName": {
"description": "Parent system name",
"type": "string",
"example": "Accounts & CT"
},
"Status": {
"type": "string",
"enum": [
"Active",
"Archived"
],
"example": "Active"
},
"DefaultRouteID": {
"description": "Default route ID",
"type": "integer",
"example": 15
},
"DefaultRoute": {
"description": "Default route name",
"type": "string",
"example": "Standard Route"
},
"Routes": {
"description": "Included only when routes=1 parameter is set",
"properties": {
"Route": {
"type": "array",
"items": {
"properties": {
"ID": {
"type": "integer",
"example": 15
},
"Name": {
"type": "string",
"example": "Standard Route"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/tasks/list": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get a list of tasks",
"operationId": "b93aa11c60d0d557d1aebde22a59b217",
"responses": {
"200": {
"description": "Request executed successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string"
},
"StatusReport": {
"type": "string"
},
"Count": {
"type": "integer"
},
"Tasks": {
"properties": {
"Task": {
"type": "array",
"items": {
"properties": {
"ID": {
"type": "integer"
},
"ClientID": {
"type": "integer"
},
"DateCreated": {
"type": "string",
"format": "date"
},
"CreatedBy": {
"type": "integer"
},
"Status": {
"type": "integer"
},
"Description": {
"type": "string"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/tasks/info/{id}": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get information about a particular task",
"operationId": "ded8ee7315f98cb2fa1fb5e1f1aac16f",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Task ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Request executed successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string"
},
"StatusReport": {
"type": "string"
},
"Tasks": {
"properties": {
"Task": {
"properties": {
"ID": {
"type": "integer"
},
"ClientID": {
"type": "integer"
},
"DateCreated": {
"type": "string",
"format": "date"
},
"CreatedBy": {
"type": "integer"
},
"Status": {
"type": "integer"
},
"Description": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/tasks/create": {
"post": {
"tags": [
"Tasks"
],
"summary": "Create a new task",
"operationId": "d3b16809ef9bf8a60dc94a4cb9f8c91d",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"assignee",
"description",
"assigner",
"deadline"
],
"properties": {
"clientId": {
"description": "Client ID",
"type": "integer"
},
"clientCode": {
"description": "Client code",
"type": "string"
},
"jobId": {
"description": "Job ID",
"type": "integer"
},
"deadline": {
"description": "Task deadline",
"type": "string",
"format": "date"
},
"assigner": {
"description": "User ID, initials or email of task assigner",
"type": "string"
},
"assignee": {
"description": "User ID, initials or email of task assignee",
"type": "string"
},
"description": {
"description": "Task description",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Task created successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string"
},
"StatusReport": {
"type": "string"
},
"Task": {
"properties": {
"ID": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string"
},
"StatusReport": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"/users/list": {
"get": {
"tags": [
"Users"
],
"summary": "Get a list of all users",
"description": "Retrieves a list of all users in the system with their profile information including role, clearance level, and status.",
"operationId": "0d082def96cec314d44d306533a4f392",
"parameters": [
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "User list retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Count": {
"description": "Total number of users",
"type": "integer",
"example": 25
},
"Users": {
"properties": {
"User": {
"type": "array",
"items": {
"properties": {
"ID": {
"description": "User's Glide ID",
"type": "integer",
"example": 100
},
"Name": {
"description": "First name",
"type": "string",
"example": "Jack"
},
"Surname": {
"description": "Surname",
"type": "string",
"example": "Norton"
},
"Initials": {
"description": "User initials",
"type": "string",
"example": "JN"
},
"Role": {
"description": "User role name",
"type": "string",
"example": "Manager (Audit)"
},
"RoleID": {
"description": "Role ID",
"type": "integer",
"example": 5
},
"ClearanceLevel": {
"description": "Clearance level name",
"type": "string",
"example": "Super User"
},
"ClearanceLevelID": {
"description": "Clearance level ID",
"type": "integer",
"example": 11
},
"AlternateID": {
"description": "Integration/alternate ID",
"type": "integer",
"example": 0
},
"Email": {
"description": "Email address",
"type": "string",
"example": "accounts@company.com"
},
"Status": {
"type": "string",
"enum": [
"Active",
"On Leave",
"Departed"
],
"example": "Active"
},
"Deleted": {
"type": "string",
"enum": [
"Active",
"Deleted"
],
"example": "Active"
}
},
"type": "object"
}
}
},
"type": "object"
}
},
"type": "object"
}
}
}
}
}
}
},
"/users/info/{id}": {
"get": {
"tags": [
"Users"
],
"summary": "Get data for one user by Glide UID",
"description": "Retrieves detailed information for a specific user identified by their Glide user ID.",
"operationId": "3fdc9e9d3dfa57d0b92b1ce183ae5551",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Glide user ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "User data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Users": {
"properties": {
"User": {
"properties": {
"ID": {
"description": "User's Glide ID",
"type": "integer",
"example": 100
},
"Name": {
"description": "First name",
"type": "string",
"example": "Jack"
},
"Surname": {
"description": "Surname",
"type": "string",
"example": "Norton"
},
"Initials": {
"description": "User initials",
"type": "string",
"example": "JN"
},
"Role": {
"description": "User role name",
"type": "string",
"example": "Manager (Audit)"
},
"RoleID": {
"description": "Role ID",
"type": "integer",
"example": 5
},
"ClearanceLevel": {
"description": "Clearance level name",
"type": "string",
"example": "Super User"
},
"ClearanceLevelID": {
"description": "Clearance level ID",
"type": "integer",
"example": 11
},
"AlternateID": {
"description": "Integration/alternate ID",
"type": "integer",
"example": 0
},
"Email": {
"description": "Email address",
"type": "string",
"example": "accounts@company.com"
},
"Status": {
"type": "string",
"enum": [
"Active",
"On Leave",
"Departed"
],
"example": "Active"
},
"Deleted": {
"type": "string",
"enum": [
"Active",
"Deleted"
],
"example": "Active"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid user ID or user not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "User not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/users/infoalt/{id}": {
"get": {
"tags": [
"Users"
],
"summary": "Get data for one user by Integration ID",
"description": "Retrieves detailed information for a specific user identified by their integration/alternate ID (used by connector add-ons to other software).",
"operationId": "e79c8789c38aa09d5100c2877f9c3875",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Integration/alternate ID",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "User data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Users": {
"properties": {
"User": {
"properties": {
"ID": {
"description": "User's Glide ID",
"type": "integer",
"example": 100
},
"Name": {
"description": "First name",
"type": "string",
"example": "Steve"
},
"Surname": {
"description": "Surname",
"type": "string",
"example": "Lynn"
},
"Initials": {
"description": "User initials",
"type": "string",
"example": "SL"
},
"Role": {
"description": "User role name",
"type": "string",
"example": "Manager (Audit)"
},
"RoleID": {
"description": "Role ID",
"type": "integer",
"example": 5
},
"ClearanceLevel": {
"description": "Clearance level name",
"type": "string",
"example": "Super User"
},
"ClearanceLevelID": {
"description": "Clearance level ID",
"type": "integer",
"example": 11
},
"AlternateID": {
"description": "Integration/alternate ID",
"type": "integer",
"example": 0
},
"Email": {
"description": "Email address",
"type": "string",
"example": "accounts@company.com"
},
"Status": {
"type": "string",
"enum": [
"Active",
"On Leave",
"Departed"
],
"example": "Active"
},
"Deleted": {
"type": "string",
"enum": [
"Active",
"Deleted"
],
"example": "Active"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid integration ID or user not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "User not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/users/infoini/{id}": {
"get": {
"tags": [
"Users"
],
"summary": "Get data for one user by initials",
"description": "Retrieves detailed information for a specific user identified by their initials (e.g., JN for Jack Norton).",
"operationId": "751b78135ea9ee26eb6fe3991b25d96d",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User initials (1-8 characters)",
"required": true,
"schema": {
"type": "string",
"maxLength": 8
}
},
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"responses": {
"200": {
"description": "User data retrieved successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "Request executed successfully"
},
"Users": {
"properties": {
"User": {
"properties": {
"ID": {
"description": "User's Glide ID",
"type": "integer",
"example": 100
},
"Name": {
"description": "First name",
"type": "string",
"example": "Andy"
},
"Surname": {
"description": "Surname",
"type": "string",
"example": "Parker"
},
"Initials": {
"description": "User initials",
"type": "string",
"example": "AP"
},
"Role": {
"description": "User role name",
"type": "string",
"example": "Manager (Audit)"
},
"RoleID": {
"description": "Role ID",
"type": "integer",
"example": 5
},
"ClearanceLevel": {
"description": "Clearance level name",
"type": "string",
"example": "Super User"
},
"ClearanceLevelID": {
"description": "Clearance level ID",
"type": "integer",
"example": 11
},
"AlternateID": {
"description": "Integration/alternate ID",
"type": "integer",
"example": 0
},
"Email": {
"description": "Email address",
"type": "string",
"example": "accounts@company.com"
},
"Status": {
"type": "string",
"enum": [
"Active",
"On Leave",
"Departed"
],
"example": "Active"
},
"Deleted": {
"type": "string",
"enum": [
"Active",
"Deleted"
],
"example": "Active"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Invalid initials format or user not found",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "User not found"
}
},
"type": "object"
}
}
}
}
}
}
},
"/users/create": {
"post": {
"tags": [
"Users"
],
"summary": "Create a new Glide user",
"operationId": "f2218402047057f4ad5c3276be63ec58",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"firstname",
"surname",
"ini",
"email"
],
"properties": {
"firstname": {
"description": "First name (e.g. John)",
"type": "string"
},
"surname": {
"description": "Surname (e.g. Smith)",
"type": "string"
},
"ini": {
"description": "Initials (e.g. JS)",
"type": "string"
},
"email": {
"description": "Email address (e.g. john.smith@company.com - the user will log in with this email address)",
"type": "string"
},
"status": {
"description": "Status (1 - Active [Default], 3 - Departed)",
"type": "integer",
"deprecated": true
},
"altid": {
"description": "Integration ID (used by our connector add-ons to other software)",
"type": "integer"
},
"role": {
"description": "Role setting (default: 4)",
"type": "integer",
"deprecated": true
},
"clearance": {
"description": "Clearance level setting: - 1 = Basic
- 2 = Support
- 3 = Staff
- 4 = Staff (Audit)
- 5 = Staff (both) [Default]
- 6 = Staff Pro
- 7 = Manager (Tax)
- 8 = Manager (Audit)
- 9 = Manager (Both)
- 10 = Partner
- 11 = Super User
",
"type": "integer",
"deprecated": true
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"properties": {
"Count": {
"type": "integer"
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string"
},
"GlideID": {
"type": "integer"
},
"Name": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Status": {
"type": "string"
},
"StatusReport": {
"type": "string"
}
},
"type": "object"
}
}
}
}
}
}
},
"/users/getbyemail": {
"post": {
"tags": [
"Users"
],
"summary": "Get user by email address",
"operationId": "3255819e60c836ad30dfa35d4e9ff56d",
"parameters": [
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"email"
],
"properties": {
"email": {
"description": "Email address",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "User lookup completed",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "User found"
},
"UserID": {
"description": "Glide user ID if found",
"type": "integer",
"example": 123
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Email address required or invalid",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "Email address required"
}
},
"type": "object"
}
}
}
}
}
}
},
"/users/update": {
"post": {
"tags": [
"Users"
],
"summary": "Update the Integration ID for a user",
"description": "Updates a user's integration/alternate ID. This ID is used by connector add-ons to link Glide users with external software systems.",
"operationId": "8bd1d79e56dffa865dbf8cf8aef2d460",
"parameters": [
{
"name": "returnFormat",
"in": "query",
"description": "Response format: 1 for JSON, 0 for XML (default)",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"enum": [
0,
1
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"id",
"altid"
],
"properties": {
"id": {
"description": "Glide user ID to update",
"type": "integer"
},
"altid": {
"description": "Integration/alternate ID (used by connector add-ons to other software)",
"type": "integer"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "User updated successfully",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "OK"
},
"StatusReport": {
"type": "string",
"example": "User updated successfully"
},
"Count": {
"type": "integer",
"example": 1
},
"Infos": {
"properties": {
"Info": {
"properties": {
"Success": {
"type": "string",
"example": "1"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"400": {
"description": "Error updating user",
"content": {
"application/json": {
"schema": {
"properties": {
"Status": {
"type": "string",
"example": "ERROR"
},
"StatusReport": {
"type": "string",
"example": "User does not exist"
}
},
"type": "object"
}
}
}
}
}
}
}
},
"components": {
"responses": {
"404": {
"description": "System not found",
"content": {
"application/json": {
"schema": {
"properties": {
"error": {
"type": "string",
"example": "System not found"
},
"message": {
"type": "string",
"example": "The specified system ID does not exist"
}
},
"type": "object"
}
}
}
}
},
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic",
"description": "Enter your API key in the username field, leave the password blank"
}
}
},
"tags": [
{
"name": "Clients",
"description": "End-points to create and manipulate clients in a Glide system"
},
{
"name": "Jobs",
"description": "End-points to manipulate jobs in a Glide system"
},
{
"name": "Users",
"description": "End-points to create and manipulate users in a Glide system"
},
{
"name": "Workflow Systems",
"description": "End-points to manipulate Workflow Systems in a Glide system"
},
{
"name": "Tasks",
"description": "End-points to manipulate tasks in a Glide system"
},
{
"name": "Time & Fees",
"description": "End-points to manipulate Glide related items in a Glide system"
},
{
"name": "Other",
"description": "Various additional end-points"
}
],
"security": [
{
"basicAuth": []
}
]
}