ECMS V1 API

https://www.eimmigration.com/swagger/
Admin
ECMS V1 API is a comprehensive REST API for managing immigration case management, including cases,...
Tokens:53,430
Snippets:134
Trust Score:8.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### GET /api/v1/Cases

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Retrieves a paginated list of all immigration cases, with options for filtering and sorting.

```APIDOC
## GET /api/v1/Cases

### Description
Returns a paginated list of cases with filtering, sorting, and comprehensive case metadata.

### Method
GET

### Endpoint
`https://api.example.com/{tenant}/api/v1/Cases`

### Parameters
#### Query Parameters
- **skip** (integer) - Optional - The number of records to skip for pagination.
- **take** (integer) - Optional - The maximum number of records to return.
- **orderBy** (string) - Optional - The field and direction to sort the results (e.g., 'CaseID DESC').

### Response
#### Success Response (200 OK)
- **totalCount** (integer) - The total number of cases matching the query.
- **data** (array) - An array of case objects.
  - **caseID** (integer) - The unique identifier for the case.
  - **caseNumber** (string) - The case number.
  - **caseStatusID** (integer) - The ID of the case status.
  - **caseStatus** (string) - The description of the case status.
  - **caseCategoryID** (integer) - The ID of the case category.
  - **caseCategory** (string) - The description of the case category.
  - **caseFilingTypeID** (integer) - The ID of the case filing type.
  - **caseFilingType** (string) - The description of the case filing type.
  - **dateOpened** (string) - The date the case was opened (YYYY-MM-DDTHH:mm:ssZ).
  - **primaryClientID** (integer) - The ID of the primary client.
  - **primaryClientName** (string) - The name of the primary client.
  - **lawFirmLocationID** (integer) - The ID of the law firm location.

#### Response Example
```json
{
  "totalCount": 2847,
  "data": [
    {
      "caseID": 1523,
      "caseNumber": "2024-EB2-001523",
      "caseStatusID": 3,
      "caseStatus": "Active - Pending",
      "caseCategoryID": 2,
      "caseCategory": "Employment-Based",
      "caseFilingTypeID": 5,
      "caseFilingType": "EB-2 NIW",
      "dateOpened": "2024-08-12T00:00:00Z",
      "primaryClientID": 8765,
      "primaryClientName": "Garcia, Maria",
      "lawFirmLocationID": 1
    }
  ]
}
```
```

--------------------------------

### GET /api/v1/Cases/{caseID}/ProcessSteps

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Returns all process steps for a case to track workflow progression.

```APIDOC
## GET /api/v1/Cases/{caseID}/ProcessSteps

### Description
Returns all process steps for a case to track workflow progression.

### Method
GET

### Endpoint
`/api/v1/Cases/{caseID}/ProcessSteps`

### Parameters
#### Path Parameters
- **caseID** (integer) - Required - The ID of the case for which to retrieve process steps.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET "https://api.example.com/{tenant}/api/v1/Cases/1523/ProcessSteps" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

### Response
#### Success Response (200)
- This endpoint is expected to return an array of process step objects. The exact structure of these objects is not detailed in the provided text but would typically include step name, status, dates, assigned user, etc. 

#### Response Example
(Example structure based on typical process step data - actual response may vary)
```json
[
  {
    "processStepID": 1001,
    "caseID": 1523,
    "stepName": "Initial Filing",
    "status": "Completed",
    "completionDate": "2024-08-15T09:00:00Z"
  },
  {
    "processStepID": 1002,
    "caseID": 1523,
    "stepName": "RFE Response",
    "status": "In Progress",
    "dueDate": "2025-10-20T17:00:00Z"
  }
]
```
```

--------------------------------

### List Cases using cURL

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Returns a paginated list of cases with filtering and sorting capabilities. This GET request allows specifying skip, take, and orderBy parameters for customized results.

```bash
curl -X GET "https://api.example.com/{tenant}/api/v1/Cases?skip=0&take=10&orderBy=CaseID%20DESC" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### Client Alerts API

Source: https://www.eimmigration.com/swagger/index

Manage client alerts, including retrieving lists, creating new alerts, getting specific alerts by ID, updating existing ones, and deleting alerts.

```APIDOC
## GET /{tenant}/api/v1/Clients/{clientID}/Alerts

### Description
Returns a list of alerts for a specific client.

### Method
GET

### Endpoint
`/{tenant}/api/v1/Clients/{clientID}/Alerts`

### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **clientID** (string) - Required - The ID of the client.

### Response
#### Success Response (200)
- **alerts** (array) - A list of alert objects.

### Response Example
```json
{
  "alerts": [
    {
      "alertID": "string",
      "message": "string",
      "timestamp": "string"
    }
  ]
}
```

## POST /{tenant}/api/v1/Clients/{clientID}/Alerts

### Description
Creates an alert for an existing client.

### Method
POST

### Endpoint
`/{tenant}/api/v1/Clients/{clientID}/Alerts`

### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **clientID** (string) - Required - The ID of the client.

#### Request Body
- **alert** (object) - Required - The alert details.
  - **message** (string) - Required - The content of the alert.

### Request Example
```json
{
  "alert": {
    "message": "Client requires follow-up."
  }
}
```

### Response
#### Success Response (201)
- **alertID** (string) - The ID of the newly created alert.

### Response Example
```json
{
  "alertID": "new-alert-id"
}
```

## GET /{tenant}/api/v1/Clients/{clientID}/Alerts/{clientAlertID}

### Description
Returns a specific client alert by ID.

### Method
GET

### Endpoint
`/{tenant}/api/v1/Clients/{clientID}/Alerts/{clientAlertID}`

### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **clientID** (string) - Required - The ID of the client.
- **clientAlertID** (string) - Required - The ID of the client alert.

### Response
#### Success Response (200)
- **alert** (object) - The alert details.
  - **alertID** (string) - The ID of the alert.
  - **message** (string) - The content of the alert.
  - **timestamp** (string) - The timestamp when the alert was created.

### Response Example
```json
{
  "alert": {
    "alertID": "existing-alert-id",
    "message": "Client requires follow-up.",
    "timestamp": "2023-10-27T10:00:00Z"
  }
}
```

## PUT /{tenant}/api/v1/Clients/{clientID}/Alerts/{clientAlertID}

### Description
Updates an existing alert for a specific client.

### Method
PUT

### Endpoint
`/{tenant}/api/v1/Clients/{clientID}/Alerts/{clientAlertID}`

### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **clientID** (string) - Required - The ID of the client.
- **clientAlertID** (string) - Required - The ID of the client alert to update.

#### Request Body
- **alert** (object) - Required - The updated alert details.
  - **message** (string) - Optional - The updated content of the alert.

### Request Example
```json
{
  "alert": {
    "message": "Urgent: Client follow-up needed."
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation of successful update.

### Response Example
```json
{
  "message": "Client alert updated successfully."
}
```

## DELETE /{tenant}/api/v1/Clients/{clientID}/Alerts/{clientAlertID}

### Description
Deletes an existing alert for a specific client.

### Method
DELETE

### Endpoint
`/{tenant}/api/v1/Clients/{clientID}/Alerts/{clientAlertID}`

### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **clientID** (string) - Required - The ID of the client.
- **clientAlertID** (string) - Required - The ID of the client alert to delete.

### Response
#### Success Response (200)
- **message** (string) - Confirmation of successful deletion.

### Response Example
```json
{
  "message": "Client alert deleted successfully."
}
```
```

--------------------------------

### Get Specific Client API

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Retrieves detailed information for a single client using their unique ID. Requires a valid API token. Returns a 200 OK status with the client's data.

```bash
curl -X GET "https://api.example.com/{tenant}/api/v1/Clients/8765" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

# Response 200 OK
{
  "clientID": 8765,
  "firstName": "Maria",
  "middleName": "Elena",
  "lastName": "Garcia",
  "dateOfBirth": "1985-07-15T00:00:00Z",
  "email": "maria.garcia@email.com",
  "phone": "555-0124",
  "clientTypeID": 1,
  "clientType": "Individual",
  "clientStatusID": 2,
  "clientStatus": "Active",
  "countryOfBirthID": 142,
  "countryOfBirth": "Mexico",
  "countryOfCitizenshipID": 142,
  "countryOfCitizenship": "Mexico",
  "sexID": 2,
  "sex": "Female",
  "maritalStatusID": 1,
  "maritalStatus": "Single",
  "createdDate": "2024-07-10T00:00:00Z",
  "lastModified": "2025-09-22T11:15:00Z"
}
```

--------------------------------

### Get Specific Case using cURL

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Retrieves detailed information about a single case by its ID. This GET request requires the case ID as a path parameter.

```bash
curl -X GET "https://api.example.com/{tenant}/api/v1/Cases/1523" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### POST /api/v1/Cases

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Creates a new immigration case with initial client and category information.

```APIDOC
## POST /api/v1/Cases

### Description
Creates a new immigration case with initial client and category information.

### Method
POST

### Endpoint
`https://api.example.com/{tenant}/api/v1/Cases`

### Parameters
#### Request Body
- **caseNumber** (string) - Required - The unique case number.
- **caseStatusID** (integer) - Required - The ID for the case status.
- **caseCategoryID** (integer) - Required - The ID for the case category.
- **caseFilingTypeID** (integer) - Required - The ID for the case filing type.
- **dateOpened** (string) - Required - The date the case was opened (YYYY-MM-DDTHH:mm:ssZ).
- **primaryClientID** (integer) - Required - The ID of the primary client.
- **lawFirmLocationID** (integer) - Required - The ID of the law firm location.
- **notes** (string) - Optional - Additional notes about the case.

### Request Example
```json
{
  "caseNumber": "2025-FAM-002156",
  "caseStatusID": 1,
  "caseCategoryID": 4,
  "caseFilingTypeID": 15,
  "dateOpened": "2025-10-07T00:00:00Z",
  "primaryClientID": 9912,
  "lawFirmLocationID": 1,
  "notes": "Initial consultation completed, gathering family documentation"
}
```

### Response
#### Success Response (201 Created)
- **caseID** (integer) - The unique identifier for the newly created case.
- **caseNumber** (string) - The case number.
- **caseStatusID** (integer) - The ID of the case status.
- **caseStatus** (string) - The description of the case status.
- **caseCategoryID** (integer) - The ID of the case category.
- **caseCategory** (string) - The description of the case category.
- **caseFilingTypeID** (integer) - The ID of the case filing type.
- **caseFilingType** (string) - The description of the case filing type.
- **dateOpened** (string) - The date the case was opened (YYYY-MM-DDTHH:mm:ssZ).
- **primaryClientID** (integer) - The ID of the primary client.
- **primaryClientName** (string) - The name of the primary client.
- **lawFirmLocationID** (integer) - The ID of the law firm location.
- **createdDate** (string) - The date and time the case was created.

#### Response Example
```json
{
  "caseID": 2156,
  "caseNumber": "2025-FAM-002156",
  "caseStatusID": 1,
  "caseStatus": "New - Intake",
  "caseCategoryID": 4,
  "caseCategory": "Family-Based",
  "caseFilingTypeID": 15,
  "caseFilingType": "I-130 Immediate Relative",
  "dateOpened": "2025-10-07T00:00:00Z",
  "primaryClientID": 9912,
  "primaryClientName": "Garcia, Carlos",
  "lawFirmLocationID": 1,
  "createdDate": "2025-10-07T15:00:00Z"
}
```
```

--------------------------------

### Get Specific Invoice

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Retrieves detailed information about a single invoice using its ID.

```APIDOC
## GET /api/v1/Invoices/{invoiceId}

### Description
Retrieves detailed information about a single invoice.

### Method
GET

### Endpoint
`/api/v1/Invoices/{invoiceId}`

### Parameters
#### Path Parameters
- **invoiceId** (integer) - Required - The unique identifier for the invoice.

### Request Example
```bash
curl -X GET "https://api.example.com/{tenant}/api/v1/Invoices/8842" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

### Response
#### Success Response (200)
- **invoiceID** (integer) - The unique identifier for the invoice.
- **invoiceNumber** (string) - The invoice number.
- **invoiceDate** (string) - The date the invoice was issued (ISO 8601 format).
- **dueDate** (string) - The due date for the invoice (ISO 8601 format).
- **clientID** (integer) - The identifier of the client associated with the invoice.
- **clientName** (string) - The name of the client.
- **caseID** (integer) - The identifier of the case associated with the invoice.
- **caseNumber** (string) - The case number.
- **totalAmount** (number) - The total amount of the invoice.
- **amountPaid** (number) - The amount paid towards the invoice.
- **balance** (number) - The remaining balance of the invoice.
- **status** (string) - The current status of the invoice.

#### Response Example
```json
{
  "invoiceID": 8842,
  "invoiceNumber": "INV-2025-001523",
  "invoiceDate": "2025-10-01T00:00:00Z",
  "dueDate": "2025-10-31T00:00:00Z",
  "clientID": 8765,
  "clientName": "Garcia, Maria",
  "caseID": 1523,
  "caseNumber": "2024-EB2-001523",
  "totalAmount": 5250.00,
  "amountPaid": 2000.00,
  "balance": 3250.00,
  "status": "Partially Paid"
}
```
```

--------------------------------

### Create Client API

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Creates a new client record with provided personal information and classification. Requires a valid API token and client details in JSON format. Returns a 201 Created status with the new client's details.

```bash
curl -X POST "https://api.example.com/{tenant}/api/v1/Clients" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Raj",
    "middleName": "Kumar",
    "lastName": "Patel",
    "dateOfBirth": "1990-11-08T00:00:00Z",
    "email": "raj.patel@email.com",
    "phone": "555-0199",
    "clientTypeID": 1,
    "clientStatusID": 1,
    "countryOfBirthID": 100,
    "countryOfCitizenshipID": 100,
    "sexID": 1
  }'

# Response 201 Created
{
  "clientID": 10245,
  "firstName": "Raj",
  "middleName": "Kumar",
  "lastName": "Patel",
  "dateOfBirth": "1990-11-08T00:00:00Z",
  "email": "raj.patel@email.com",
  "phone": "555-0199",
  "clientTypeID": 1,
  "clientType": "Individual",
  "clientStatusID": 1,
  "clientStatus": "Prospect",
  "countryOfBirthID": 100,
  "countryOfBirth": "India",
  "countryOfCitizenshipID": 100,
  "countryOfCitizenship": "India",
  "sexID": 1,
  "sex": "Male",
  "createdDate": "2025-10-07T16:00:00Z"
}
```

--------------------------------

### Create Client

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Creates a new client record with personal information and classification. Ensures all necessary fields are provided for new client creation.

```APIDOC
## POST /api/v1/Clients

### Description
Creates a new client record with personal information and classification.

### Method
POST

### Endpoint
`/api/v1/Clients`

### Parameters
#### Request Body
- **firstName** (string) - Required - The client's first name.
- **middleName** (string) - Optional - The client's middle name.
- **lastName** (string) - Required - The client's last name.
- **dateOfBirth** (string) - Required - The client's date of birth in ISO 8601 format.
- **email** (string) - Required - The client's email address.
- **phone** (string) - Required - The client's phone number.
- **clientTypeID** (integer) - Required - The ID of the client's type.
- **clientStatusID** (integer) - Required - The ID of the client's status.
- **countryOfBirthID** (integer) - Required - The ID of the country of birth.
- **countryOfCitizenshipID** (integer) - Required - The ID of the country of citizenship.
- **sexID** (integer) - Required - The ID representing the client's sex.

### Request Example
```json
{
  "firstName": "Raj",
  "middleName": "Kumar",
  "lastName": "Patel",
  "dateOfBirth": "1990-11-08T00:00:00Z",
  "email": "raj.patel@email.com",
  "phone": "555-0199",
  "clientTypeID": 1,
  "clientStatusID": 1,
  "countryOfBirthID": 100,
  "countryOfCitizenshipID": 100,
  "sexID": 1
}
```

### Response
#### Success Response (201)
- **clientID** (integer) - The unique identifier for the newly created client.
- **firstName** (string) - The client's first name.
- **middleName** (string) - The client's middle name.
- **lastName** (string) - The client's last name.
- **dateOfBirth** (string) - The client's date of birth in ISO 8601 format.
- **email** (string) - The client's email address.
- **phone** (string) - The client's phone number.
- **clientTypeID** (integer) - The ID of the client's type.
- **clientType** (string) - The client's type.
- **clientStatusID** (integer) - The ID of the client's status.
- **clientStatus** (string) - The client's status.
- **countryOfBirthID** (integer) - The ID of the country of birth.
- **countryOfBirth** (string) - The name of the country of birth.
- **countryOfCitizenshipID** (integer) - The ID of the country of citizenship.
- **countryOfCitizenship** (string) - The name of the country of citizenship.
- **sexID** (integer) - The ID representing the client's sex.
- **sex** (string) - The client's sex.
- **createdDate** (string) - The date and time the client was created in ISO 8601 format.

#### Response Example
```json
{
  "clientID": 10245,
  "firstName": "Raj",
  "middleName": "Kumar",
  "lastName": "Patel",
  "dateOfBirth": "1990-11-08T00:00:00Z",
  "email": "raj.patel@email.com",
  "phone": "555-0199",
  "clientTypeID": 1,
  "clientType": "Individual",
  "clientStatusID": 1,
  "clientStatus": "Prospect",
  "countryOfBirthID": 100,
  "countryOfBirth": "India",
  "countryOfCitizenshipID": 100,
  "countryOfCitizenship": "India",
  "sexID": 1,
  "sex": "Male",
  "createdDate": "2025-10-07T16:00:00Z"
}
```
```

--------------------------------

### GET /api/v1/Cases/{caseId}

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Retrieves detailed information for a specific immigration case by its ID.

```APIDOC
## GET /api/v1/Cases/{caseId}

### Description
Retrieves detailed information about a single case by ID.

### Method
GET

### Endpoint
`https://api.example.com/{tenant}/api/v1/Cases/{caseId}`

### Parameters
#### Path Parameters
- **caseId** (integer) - Required - The unique identifier of the case to retrieve.

### Response
#### Success Response (200 OK)
- **caseID** (integer) - The unique identifier for the case.
- **caseNumber** (string) - The case number.
- **caseStatusID** (integer) - The ID of the case status.
- **caseStatus** (string) - The description of the case status.
- **caseCategoryID** (integer) - The ID of the case category.
- **caseCategory** (string) - The description of the case category.
- **caseFilingTypeID** (integer) - The ID of the case filing type.
- **caseFilingType** (string) - The description of the case filing type.
- **dateOpened** (string) - The date the case was opened (YYYY-MM-DDTHH:mm:ssZ).
- **dateClosed** (string or null) - The date the case was closed (YYYY-MM-DDTHH:mm:ssZ) or null if not closed.
- **primaryClientID** (integer) - The ID of the primary client.
- **primaryClientName** (string) - The name of the primary client.
- **lawFirmLocationID** (integer) - The ID of the law firm location.
- **lawFirmLocation** (string) - The name of the law firm location.
- **notes** (string) - Additional notes about the case.
- **createdDate** (string) - The date and time the case was created.
- **lastModified** (string) - The date and time the case was last modified.

#### Response Example
```json
{
  "caseID": 1523,
  "caseNumber": "2024-EB2-001523",
  "caseStatusID": 3,
  "caseStatus": "Active - Pending",
  "caseCategoryID": 2,
  "caseCategory": "Employment-Based",
  "caseFilingTypeID": 5,
  "caseFilingType": "EB-2 NIW",
  "dateOpened": "2024-08-12T00:00:00Z",
  "dateClosed": null,
  "primaryClientID": 8765,
  "primaryClientName": "Garcia, Maria",
  "lawFirmLocationID": 1,
  "lawFirmLocation": "Main Office",
  "notes": "National Interest Waiver petition based on advanced degree and exceptional ability",
  "createdDate": "2024-08-12T10:30:00Z",
  "lastModified": "2025-10-05T14:30:00Z"
}
```
```

--------------------------------

### List Billing Items using curl

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Returns a list of billing items with support for pagination, ordering, and filtering by name, description, or timed status.

```bash
curl -X GET "https://api.example.com/{tenant}/api/v1/BillingItems?skip=0&take=10&orderBy=Name%20ASC&timedOnly=true" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### Case > Process Steps API

Source: https://www.eimmigration.com/swagger/index

Endpoints for managing process steps associated with a case.

```APIDOC
## GET /{tenant}/api/v1/Cases/{caseID}/ProcessSteps

### Description
Returns a list of Process Steps for a specific Case.

### Method
GET

### Endpoint
`/{tenant}/api/v1/Cases/{caseID}/ProcessSteps`

### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **caseID** (string) - Required - The ID of the case.

### Response
#### Success Response (200)
- **processSteps** (array) - A list of process steps for the case.

## POST /{tenant}/api/v1/Cases/{caseID}/ProcessSteps

### Description
Creates a Process Step for an existing Case.

### Method
POST

### Endpoint
`/{tenant}/api/v1/Cases/{caseID}/ProcessSteps`

### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **caseID** (string) - Required - The ID of the case.

### Request Body
- **stepDetails** (object) - Required - The details of the process step.

### Response
#### Success Response (200)
- **caseProcessStepID** (string) - The ID of the newly created process step.

## GET /{tenant}/api/v1/Cases/{caseID}/ProcessSteps/{caseProcessStepID}

### Description
Returns a specific Process Step by ID for a Case.

### Method
GET

### Endpoint
`/{tenant}/api/v1/Cases/{caseID}/ProcessSteps/{caseProcessStepID}`

### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **caseID** (string) - Required - The ID of the case.
- **caseProcessStepID** (string) - Required - The ID of the process step.

### Response
#### Success Response (200)
- **processStep** (object) - The specific process step details.

## PUT /{tenant}/api/v1/Cases/{caseID}/ProcessSteps/{caseProcessStepID}

### Description
Updates an existing Process Step for a Case.

### Method
PUT

### Endpoint
`/{tenant}/api/v1/Cases/{caseID}/ProcessSteps/{caseProcessStepID}`

### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **caseID** (string) - Required - The ID of the case.
- **caseProcessStepID** (string) - Required - The ID of the process step to update.

### Request Body
- **stepDetails** (object) - Required - The updated details of the process step.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

## DELETE /{tenant}/api/v1/Cases/{caseID}/ProcessSteps/{caseProcessStepID}

### Description
Deletes an existing Process Step for a Case.

### Method
DELETE

### Endpoint
`/{tenant}/api/v1/Cases/{caseID}/ProcessSteps/{caseProcessStepID}`

### Parameters
#### Path Parameters
- **tenant** (string) - Required - The tenant identifier.
- **caseID** (string) - Required - The ID of the case.
- **caseProcessStepID** (string) - Required - The ID of the process step to delete.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
```

--------------------------------

### GET /api/v1/Cases/{caseID}/Comments

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Retrieves a list of comments associated with a specific case.

```APIDOC
## GET /api/v1/Cases/{caseID}/Comments

### Description
Retrieves a list of comments associated with a specific case.

### Method
GET

### Endpoint
`/api/v1/Cases/{caseID}/Comments`

### Parameters
#### Path Parameters
- **caseID** (integer) - Required - The ID of the case for which to retrieve comments.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET "https://api.example.com/{tenant}/api/v1/Cases/1523/Comments" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

### Response
#### Success Response (200)
- **caseCommentID** (integer) - The unique identifier for the case comment.
- **caseID** (integer) - The ID of the case the comment belongs to.
- **commentText** (string) - The content of the comment.
- **commentTypeID** (integer) - The ID of the comment type.
- **commentType** (string) - The name of the comment type.
- **rankID** (integer) - The ID of the comment's rank.
- **rank** (string) - The name of the comment's rank.
- **createdBy** (string) - The name of the user who created the comment.
- **createdDate** (string) - The date and time the comment was created (ISO 8601 format).
- **isPrivate** (boolean) - Indicates if the comment is private.

#### Response Example
```json
[
  {
    "caseCommentID": 8842,
    "caseID": 1523,
    "commentText": "Client provided additional employment verification documents",
    "commentTypeID": 2,
    "commentType": "Document Receipt",
    "rankID": 1,
    "rank": "Normal",
    "createdBy": "Sarah Johnson",
    "createdDate": "2025-10-05T14:30:00Z",
    "isPrivate": false
  }
]
```
```

--------------------------------

### List Clients API

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Retrieves a paginated list of clients, supporting filtering by last name and sorting. Requires a valid API token. Returns a 200 OK status with client data.

```bash
curl -X GET "https://api.example.com/{tenant}/api/v1/Clients?skip=0&take=10&orderBy=LastName%20ASC&lastName=Garcia" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

# Response 200 OK
{
  "totalCount": 3,
  "data": [
    {
      "clientID": 9912,
      "firstName": "Carlos",
      "middleName": "Alberto",
      "lastName": "Garcia",
      "dateOfBirth": "1998-03-22T00:00:00Z",
      "email": "carlos.garcia@email.com",
      "phone": "555-0123",
      "clientTypeID": 1,
      "clientType": "Individual",
      "clientStatusID": 2,
      "clientStatus": "Active",
      "countryOfBirthID": 142,
      "countryOfBirth": "Mexico"
    },
    {
      "clientID": 8765,
      "firstName": "Maria",
      "middleName": "Elena",
      "lastName": "Garcia",
      "dateOfBirth": "1985-07-15T00:00:00Z",
      "email": "maria.garcia@email.com",
      "phone": "555-0124",
      "clientTypeID": 1,
      "clientType": "Individual",
      "clientStatusID": 2,
      "clientStatus": "Active",
      "countryOfBirthID": 142,
      "countryOfBirth": "Mexico"
    }
  ]
}
```

--------------------------------

### GET /api/v1/Cases/{caseID}/Parties

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Retrieves all parties (clients, beneficiaries, petitioners) associated with a case.

```APIDOC
## GET /api/v1/Cases/{caseID}/Parties

### Description
Retrieves all parties (clients, beneficiaries, petitioners) associated with a case.

### Method
GET

### Endpoint
`/api/v1/Cases/{caseID}/Parties`

### Parameters
#### Path Parameters
- **caseID** (integer) - Required - The ID of the case for which to retrieve parties.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET "https://api.example.com/{tenant}/api/v1/Cases/1523/Parties" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

### Response
#### Success Response (200)
- **casePartyID** (integer) - The unique identifier for the case party.
- **caseID** (integer) - The ID of the case the party is associated with.
- **clientID** (integer) - The ID of the client record.
- **roleID** (integer) - The ID of the party's role in the case.
- **roleName** (string) - The name of the party's role.
- **firstName** (string) - The first name of the party.
- **lastName** (string) - The last name of the party.
- **isPrimary** (boolean) - Indicates if this party is the primary contact.
- **dateAdded** (string) - The date the party was added to the case (ISO 8601 format).

#### Response Example
```json
[
  {
    "casePartyID": 2104,
    "caseID": 1523,
    "clientID": 8765,
    "roleID": 1,
    "roleName": "Beneficiary",
    "firstName": "Maria",
    "lastName": "Garcia",
    "isPrimary": true,
    "dateAdded": "2024-08-12T00:00:00Z"
  },
  {
    "casePartyID": 2105,
    "caseID": 1523,
    "clientID": 4521,
    "roleID": 2,
    "roleName": "Petitioner",
    "firstName": "Tech",
    "lastName": "Solutions Inc",
    "isPrimary": false,
    "dateAdded": "2024-08-12T00:00:00Z"
  }
]
```
```

--------------------------------

### Create Case using cURL

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Creates a new immigration case with initial client and category information. This POST request requires essential case details in the JSON body.

```bash
curl -X POST "https://api.example.com/{tenant}/api/v1/Cases" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "caseNumber": "2025-FAM-002156",
    "caseStatusID": 1,
    "caseCategoryID": 4,
    "caseFilingTypeID": 15,
    "dateOpened": "2025-10-07T00:00:00Z",
    "primaryClientID": 9912,
    "lawFirmLocationID": 1,
    "notes": "Initial consultation completed, gathering family documentation"
  }'
```

--------------------------------

### List Clients

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Returns a paginated list of clients with filtering and sorting capabilities. Allows for efficient retrieval of client data.

```APIDOC
## GET /api/v1/Clients

### Description
Returns a paginated list of clients with filtering and sorting capabilities.

### Method
GET

### Endpoint
`/api/v1/Clients`

### Parameters
#### Query Parameters
- **skip** (integer) - Optional - The number of records to skip.
- **take** (integer) - Optional - The number of records to return.
- **orderBy** (string) - Optional - The field and direction to sort by (e.g., 'LastName ASC').
- **lastName** (string) - Optional - Filters clients by last name.

### Response
#### Success Response (200)
- **totalCount** (integer) - The total number of clients matching the criteria.
- **data** (array) - An array of client objects.
  - **clientID** (integer) - The unique identifier for the client.
  - **firstName** (string) - The client's first name.
  - **middleName** (string) - The client's middle name.
  - **lastName** (string) - The client's last name.
  - **dateOfBirth** (string) - The client's date of birth in ISO 8601 format.
  - **email** (string) - The client's email address.
  - **phone** (string) - The client's phone number.
  - **clientTypeID** (integer) - The ID of the client's type.
  - **clientType** (string) - The client's type (e.g., 'Individual').
  - **clientStatusID** (integer) - The ID of the client's status.
  - **clientStatus** (string) - The client's status (e.g., 'Active').
  - **countryOfBirthID** (integer) - The ID of the country of birth.
  - **countryOfBirth** (string) - The name of the country of birth.

#### Response Example
```json
{
  "totalCount": 3,
  "data": [
    {
      "clientID": 9912,
      "firstName": "Carlos",
      "middleName": "Alberto",
      "lastName": "Garcia",
      "dateOfBirth": "1998-03-22T00:00:00Z",
      "email": "carlos.garcia@email.com",
      "phone": "555-0123",
      "clientTypeID": 1,
      "clientType": "Individual",
      "clientStatusID": 2,
      "clientStatus": "Active",
      "countryOfBirthID": 142,
      "countryOfBirth": "Mexico"
    }
  ]
}
```
```

--------------------------------

### GET /api/v1/Cases/{caseID}/CustomFields

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Returns all custom field definitions and their values for a specific case.

```APIDOC
## GET /api/v1/Cases/{caseID}/CustomFields

### Description
Returns all custom field definitions and their values for a specific case.

### Method
GET

### Endpoint
`/api/v1/Cases/{caseID}/CustomFields`

### Parameters
#### Path Parameters
- **caseID** (integer) - Required - The ID of the case for which to retrieve custom fields.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET "https://api.example.com/{tenant}/api/v1/Cases/1523/CustomFields" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

### Response
#### Success Response (200)
- **totalCount** (integer) - The total number of custom fields for the case.
- **data** (array) - An array of custom field objects.
  - **caseID** (integer) - The ID of the case.
  - **caseCustomFieldID** (integer) - The unique identifier for the custom field.
  - **name** (string) - The name of the custom field.
  - **description** (string) - A description of the custom field.
  - **fieldValue** (string) - The current value of the custom field.
  - **fieldTypeID** (integer) - The ID of the field type.
  - **options** (array of strings) - Possible options for the field if it's a selection type.
  - **caseCustomFieldCategoryID** (integer) - The ID of the category the custom field belongs to.
  - **caseCustomFieldCategory** (string) - The name of the category.
  - **orderNumber** (integer) - The order in which the field should be displayed.

#### Response Example
```json
{
  "totalCount": 5,
  "data": [
    {
      "caseID": 1523,
      "caseCustomFieldID": 101,
      "name": "Priority Level",
      "description": "Case processing priority",
      "fieldValue": "High",
      "fieldTypeID": 2,
      "options": ["Low", "Medium", "High", "Urgent"],
      "caseCustomFieldCategoryID": 3,
      "caseCustomFieldCategory": "Administrative",
      "orderNumber": 1
    }
  ]
}
```
```

--------------------------------

### Create Client Address (Bash)

Source: https://context7.com/context7/eimmigration_swagger/llms.txt

Adds a new address record for a client. Requires authentication and sends address details in JSON format.

```bash
curl -X POST "https://api.example.com/{tenant}/api/v1/Clients/8765/Addresses" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "addressTypeID": 2,
    "streetNumber": "5678",
    "streetName": "Market Street",
    "unitTypeID": 3,
    "unitNumber": "Suite 200",
    "city": "San Francisco",
    "stateID": 5,
    "zipCode": "94103",
    "countryID": 234,
    "fromDate": "2024-01-15T00:00:00Z",
    "isCurrent": false
  }'
```
Tokens:
Raw