Get Application¶

Endpoint: GET /api/applications/{id}

Description: Returns a single application by its unique identifier, including connector details and last import information.

Path Parameters¶

Parameter	Type	Required	Description
`id`	string (GUID)	Yes	The unique identifier of the application.

Response Attributes¶

Field	Type	Description
`id`	string (GUID)	Unique identifier of the application.
`kind`	string	Resource type. Always `Application`.
`name`	string	Application name.
`priority`	string	Priority rating. Values: `None`, `Low`, `Moderate`, `High`, `Critical`.
`isArchived`	boolean	Whether the application is archived.
`lastUpdated`	string (ISO 8601)	Date the application was last updated.
`connector`	object	Connector details. `null` if no connector is configured.
`connector.id`	string (GUID)	Unique identifier of the connector.
`connector.name`	string	Connector name.
`connector.vendor`	string	Connector vendor.
`connector.files`	array[object]	File definitions required by the connector. `null` if the connector does not support file-based imports.
`connector.files[].fileGroupId`	string (GUID)	Unique identifier of the file group. Used as the field name when uploading import files.
`connector.files[].name`	string	Display name of the file group.
`connector.files[].isOptional`	boolean	Whether this file is optional during import.
`connector.files[].isMultiple`	boolean	Whether multiple files can be uploaded for this file group.
`lastImport`	object	Most recent import for this application. `null` if no imports exist.
`lastImport.id`	string (GUID)	Unique identifier of the import.
`lastImport.kind`	string	Resource type. Always `Application Import`.
`lastImport.number`	integer	Sequential import number.
`lastImport.type`	string	Import type. Values: `Scheduled`, `Manual`, `API`.
`lastImport.status`	string	Import status. Values: `Pending`, `Running`, `Finished`, `Failed`, `Canceled`, `Canceling`.
`lastImport.createdBy`	string	Username that initiated the import.
`lastImport.buildStart`	string (ISO 8601)	Date and time the import started.
`lastImport.buildEnd`	string (ISO 8601)	Date and time the import completed. `null` if still running.
`lastImport.log`	string	Import build log output.
`lastImport.files`	array[object]	Files associated with this import.
`lastImport.files[].id`	string (GUID)	Unique identifier of the import file.
`lastImport.files[].fileGroupId`	string (GUID)	File group identifier from the connector definition.
`lastImport.files[].fileGroup`	string	Display name of the file group.
`lastImport.files[].name`	string	Original file name.
`lastImport.metrics`	object	Import metrics. `null` unless the import status is `Finished`.
`lastImport.metrics.users`	object	User account metrics.
`lastImport.metrics.users.total`	integer	Total user accounts after import.
`lastImport.metrics.users.new`	integer	New user accounts added.
`lastImport.metrics.users.altered`	integer	Existing user accounts modified.
`lastImport.metrics.users.removed`	integer	User accounts removed.
`lastImport.metrics.groups`	object	Group metrics.
`lastImport.metrics.groups.total`	integer	Total groups after import.
`lastImport.metrics.groups.new`	integer	New groups added.
`lastImport.metrics.groups.altered`	integer	Existing groups modified.
`lastImport.metrics.groups.removed`	integer	Groups removed.
`lastImport.metrics.permissions`	object	Permission metrics.
`lastImport.metrics.permissions.total`	integer	Total permissions after import.
`lastImport.metrics.permissions.new`	integer	New permissions added.

Sample Response¶

{
  "id": "b8c1d2e3-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
  "kind": "Application",
  "name": "Jack Henry Symitar",
  "priority": "Critical",
  "isArchived": false,
  "lastUpdated": "2025-12-01T08:45:00Z",
  "connector": {
    "id": "c3d4e5f6-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
    "name": "Jack Henry Symitar Core",
    "vendor": "Continuous",
    "files": [
      {
        "fileGroupId": "a1b2c3d4-0000-0000-0000-000000000001",
        "name": "Employee File",
        "isOptional": false,
        "isMultiple": false
      },
      {
        "fileGroupId": "a1b2c3d4-0000-0000-0000-000000000002",
        "name": "User Privileges File",
        "isOptional": false,
        "isMultiple": false
      }
    ]
  },
  "lastImport": {
    "id": "f1e2d3c4-b5a6-9788-7654-321fedcba098",
    "kind": "Application Import",
    "number": 47,
    "type": "Scheduled",
    "status": "Finished",
    "createdBy": "Permission Assist",
    "buildStart": "2025-12-01T02:00:00Z",
    "buildEnd": "2025-12-01T02:14:32Z",
    "log": "Import started.\nReading files...\nProcessing users...\nProcessing groups...\nImport completed successfully.",
    "files": [
      {
        "id": "e1d2c3b4-a5f6-7890-1234-567890abcdef",
        "fileGroupId": "a1b2c3d4-0000-0000-0000-000000000001",
        "fileGroup": "Employee File",
        "name": "employees_20251201.csv"
      },
      {
        "id": "f2e3d4c5-b6a7-8901-2345-6789abcdef01",
        "fileGroupId": "a1b2c3d4-0000-0000-0000-000000000002",
        "fileGroup": "User Privileges File",
        "name": "privileges_20251201.csv"
      }
    ],
    "metrics": {
      "users": {
        "total": 1250,
        "new": 3,
        "altered": 12,
        "removed": 1
      },
      "groups": {
        "total": 87,
        "new": 0,
        "altered": 2,
        "removed": 0
      },
      "permissions": {
        "total": 342,
        "new": 5
      }
    }
  }
}

Error Response (404)¶

{
  "error": "not_found",
  "message": "Application with id b8c1d2e3-4f5a-6b7c-8d9e-0f1a2b3c4d5e not found",
  "correlationId": "a1b2c3d4e5f6789012345678abcdef01"
}