MoxiWorks Platform

https://moxiworks-platform.github.io
Admin
MoxiWorks Platform provides an open suite of APIs, OAuth authentication, and real-time streaming...
Tokens:23,833
Snippets:319
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Realtime Stream Update Payload Metadata Example

Source: https://moxiworks-platform.github.io/realtime_stream.html

Example structure of a JSON payload received from the Realtime Stream, containing both metadata and the entity data object.

```json
{
    "type":"/[agent|contact|listing|office|etc...]/",
    "action":"/[create|update|upsert|delete]/",
    "data":{
        ...
    },
  "last_updated": 1650050768,
  "modification_timestamp":"2022-04-15T19:26:08.000+00:00",
  "company_uuid": 1234567,
  "agent_uuid": "140a7944-bf51-4380-b61d-7ddd51b645f5",
  "primary_id": "bfa7d824-f1da-475c-aeac-14270f471d45"
}
```

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

### GetRequestAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_context_client.html

Performs an asynchronous GET request to the specified URL.

```APIDOC
## Task<string> GetRequestAsync(string url)

### Description
Performs an asynchronous GET request to the specified URL.

### Parameters
- **url** (string) - Required - The URL to send the GET request to.

### Returns
- **Task<string>** - A task representing the asynchronous operation, containing the response string.
```

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

### GetRequestAsync<T>

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_moxi_works_client.html

Performs an asynchronous GET request to the specified URL.

```APIDOC
## async Task<Response<T>> GetRequestAsync<T>(string url)

### Description
Executes an asynchronous GET request and returns a response of type T.
```

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

### MoxiWorksClient Constructor

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_moxi_works_client.html

Initializes a new instance of the MoxiWorksClient class.

```APIDOC
## MoxiWorksClient(IContextClient context = null)

### Description
Initializes a new instance of the MoxiWorksClient class with an optional context client.
```

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

### CreateActionLogAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_action_log_service.html

Creates a new action log entry.

```APIDOC
## CreateActionLogAsync

### Description
Creates a new action log entry in the MoxiWorks platform.

### Signature
Task< Response< ActionLog > > CreateActionLogAsync(ActionLog actionLog)

### Parameters
- **actionLog** (ActionLog) - The action log object to be created.
```

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

### GetCompanyOfficesAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_office_service.html

Retrieves a paginated list of offices associated with a specific brokerage company.

```APIDOC
## GetCompanyOfficesAsync(string moxiWorksCompanyId, int pageNumber)

### Description
Get a list of offices for a brokerage.

### Parameters
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.
- **pageNumber** (int) - Optional (Default: 1) - For queries with multi-page responses, use the page_number parameter to return data for specific pages.

### Returns
- **Response<OfficeResults>** - A list of offices for a brokerage.
```

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

### GetCompanyOfficesAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_office_service.html

Retrieves a paginated list of offices associated with a specific MoxiWorks company ID.

```APIDOC
## GetCompanyOfficesAsync

### Description
Retrieves a paginated list of offices for a given company.

### Method
Task<Response<OfficeResults>> GetCompanyOfficesAsync(string moxiWorksCompanyId, int pageNumber=1)

### Parameters
- **moxiWorksCompanyId** (string) - Required - The unique identifier for the company.
- **pageNumber** (int) - Optional - The page number of the results to retrieve (defaults to 1).
```

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

### Client Initiation

Source: https://moxiworks-platform.github.io/authentication.html

The authorization code grant begins by redirecting the end user to the MoxiWorks authentication system.

```APIDOC
## GET /authorize

### Description
Initiates the OAuth 2 authorization flow by redirecting the user to the MoxiWorks authentication page.

### Query Parameters
- **client_id** (String) - Required - The client_id assigned to this client
- **redirect_uri** (String) - Required - The location to redirect the end user’s user agent to after authenticating
- **response_type** (String) - Required - Must be set to 'code'
- **state** (String) - Optional - Value to be returned in the redirect for per-request data
- **company_uuid** (String) - Optional - Hint for the authorization system regarding the brokerage
- **moxi_works_company_id** (String) - Optional - Alternative method to specify agent sign-in experience
```

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

### CreateTaskAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_task_service-members.html

Creates a new task in the MoxiWorks platform.

```APIDOC
## CreateTaskAsync

### Description
Creates a new task for an agent or contact.

### Method
TaskService.CreateTaskAsync(Task task)
```

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

### CreateActionLogAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_action_log_service.html

Creates a new action log entry for a contact.

```APIDOC
## CreateActionLogAsync

### Description
Creates a new ActionLog entry to record interactions that contacts take.

### Signature
`async Task<Response<ActionLog>> CreateActionLogAsync(ActionLog actionLog)`

### Parameters
- **actionLog** (ActionLog) - The ActionLog object to be created.

### Returns
- **Response<ActionLog>** - The ActionLog object that was created.
```

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

### CreateBuyerTransactionAsync()

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/functions_c.html

Creates a new buyer transaction using the BuyerTransactionService.

```APIDOC
## CreateBuyerTransactionAsync()

### Description
Creates a new buyer transaction via the MoxiWorks.Platform.BuyerTransactionService.

### Method
Async Method

### Class
MoxiWorks.Platform.BuyerTransactionService
```

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

### CreateTaskAsync()

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/functions_c.html

Creates a new task using the TaskService.

```APIDOC
## CreateTaskAsync()

### Description
Creates a new task via the MoxiWorks.Platform.TaskService.

### Method
Async Method

### Class
MoxiWorks.Platform.TaskService
```

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

### CreateBuyerTransactionAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_buyer_transaction_service.html

Creates a new buyer transaction in the Moxi Works platform.

```APIDOC
## CreateBuyerTransactionAsync

### Description
Creates a new BuyerTransaction entity.

### Signature
`async Task<Response<BuyerTransaction>> CreateBuyerTransactionAsync(BuyerTransaction buyerTransaction)`

### Parameters
- **buyerTransaction** (BuyerTransaction) - Required - The BuyerTransaction object to be created.
```

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

### GetAgentsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_agent_service.html

Searches for multiple agents based on company, office, and pagination criteria.

```APIDOC
## GetAgentsAsync(string moxiWorksCompanyId, string moxiWorksOfficeId, DateTime? updatedSince, int? pageNumber)

### Description
Searches for Agent entities within the Moxi Works platform, allowing for filtering by company, office, and update timestamp.

### Parameters
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.
- **moxiWorksOfficeId** (string) - Optional - A valid Moxi Works Office ID.
- **updatedSince** (DateTime?) - Optional - Filter agents updated since this date.
- **pageNumber** (int?) - Optional - The page number for paginated results (default is 1).
```

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

### GetAgentWithGoalsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_agent_service.html

Retrieves an agent's details and optionally includes their GCI goals.

```APIDOC
## GetAgentWithGoalsAsync(string agentId, string moxiWorksCompanyId, bool includeGciGoals)

### Description
Retrieves an Agent object and optionally includes the agent's GCI goals in the response.

### Parameters
- **agentId** (string) - Required - The Moxi Works Platform ID of the agent.
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.
- **includeGciGoals** (bool) - Required - Flag to determine if GCI goals should be included in the response.
```

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

### CreateSellerTransactionAsync()

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/functions_c.html

Creates a new seller transaction using the SellerTransactionService.

```APIDOC
## CreateSellerTransactionAsync()

### Description
Creates a new seller transaction via the MoxiWorks.Platform.SellerTransactionService.

### Method
Async Method

### Class
MoxiWorks.Platform.SellerTransactionService
```

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

### ToBase64()

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_credentials.html

Generates a base64 encoded string based on the configured Identifier and Secret.

```APIDOC
## string ToBase64()

### Description
Generates a base64 encoded string based on the identity and secret configured in the application settings.

### Returns
- **string** - The base64 encoded representation of the credentials.
```

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

### CreateContactAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_contact_service.html

Creates a new contact record in the MoxiWorks platform.

```APIDOC
## CreateContactAsync

### Description
Creates and returns a new Contact.

### Signature
`Task<Response<Contact>> CreateContactAsync(Contact contact)`
```

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

### CreateEventAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_event_service.html

Creates a new event on the Moxi Works Platform.

```APIDOC
## CreateEventAsync(Event cmaEvent)

### Description
Creates a new event for an agent.

### Parameters
- **cmaEvent** (Event) - Required - The Event object to be created.

### Returns
- **Response<Event>** - The created event object.
```

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

### GetSoldListingAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_sold_listing_service-members.html

Retrieves a specific sold listing by its MoxiWorks listing ID and company ID.

```APIDOC
## GetSoldListingAsync

### Description
Retrieves a single sold listing record from the MoxiWorks platform using the provided listing and company identifiers.

### Signature
`Task<SoldListing> GetSoldListingAsync(string moxiWorksListngId, string moxiWorksCompanyId)`
```

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

### GetAgentWithGoalsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_agent_service.html

Retrieves a specific agent's details, with an option to include GCI goals.

```APIDOC
## GetAgentWithGoalsAsync

### Description
Finds a specific agent using the Moxi Works platform API and optionally includes the agent's GCI goals and commissions data.

### Parameters
- **agentId** (string) - Required - The AgentUuid or MoxiWorksAgentId of the agent.
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.
- **includeGciGoals** (bool) - Required - Whether to include agent’s GCI goals and commissions data in the response.

### Returns
- **Response<Agent>** - The Agent object if it exists, or an empty Agent object.
```

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

### GetCompanyAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_company_service.html

Retrieves a specific company by its Moxi Works Company ID.

```APIDOC
## GetCompanyAsync

### Description
Finding a Company using the Moxi Works platform.

### Method
Async Task

### Parameters
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.

### Returns
- **Response<Company>** - A company or an empty Company object.
```

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

### GetOfficeAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_office_service.html

Retrieves the details of a specific brokerage office using the office ID and company ID.

```APIDOC
## GetOfficeAsync(string moxiWorksOfficeId, string moxiWorksCompanyId)

### Description
Gets a specific brokerage office's details.

### Parameters
- **moxiWorksOfficeId** (string) - Required - A valid Moxi Works Office ID.
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.

### Returns
- **Response<Office>** - The Office response object or an empty office if nothing is found.
```

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

### GetPresentationLogsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_presentation_log_service.html

Retrieves a list of presentation logs for a specific company, optionally filtered by creation or update dates.

```APIDOC
## GetPresentationLogsAsync

### Description
Retrieves presentation logs for a given MoxiWorks company ID. Supports filtering by creation or update date ranges and pagination.

### Method
Async Task<Response<PresentationLogResults>>

### Parameters
- **moxiWorksCompanyId** (string) - Required - The unique identifier for the company.
- **createdAfter** (DateTime?) - Optional - Filter logs created after this date.
- **createdBefore** (DateTime?) - Optional - Filter logs created before this date.
- **updatedAfter** (DateTime?) - Optional - Filter logs updated after this date.
- **updatedBefore** (DateTime?) - Optional - Filter logs updated before this date.
- **page_number** (int) - Optional - The page number to retrieve (default is 1).
```

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

### GetListingAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_listing_service.html

Retrieves a single listing from the Moxi Works Platform using the listing ID and company ID.

```APIDOC
## GetListingAsync

### Description
Retrieves a single listing based on the provided Moxi Works Listing ID and Company ID.

### Method
SDK Method: GetListingAsync(string moxiWorksListingId, string moxiWorksCompanyId)

### Parameters
- **moxiWorksListingId** (string) - Required - The Moxi Works Platform ID of the listing.
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.

### Returns
- **Response<Listing>** - A response object containing the requested Listing or an empty listing.
```

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

### CreateSellerTransactionAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_seller_transaction_service.html

Creates a new seller transaction in the Moxi Works platform.

```APIDOC
## CreateSellerTransactionAsync

### Description
Creates a new SellerTransaction entity.

### Signature
`async Task<Response<SellerTransaction>> CreateSellerTransactionAsync(SellerTransaction sellerTransaction)`

### Parameters
- **sellerTransaction** (SellerTransaction) - Required - The SellerTransaction object to be created.

### Returns
- **Response<SellerTransaction>** - The created SellerTransaction.
```

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

### CreateContactAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_contact_service.html

Creates and returns a new Contact entity.

```APIDOC
## CreateContactAsync

### Description
Creates and returns a new Contact.

### Method
Task<Response<Contact>> CreateContactAsync(Contact contact)

### Parameters
- **contact** (Contact) - Required - The Contact object to create.
```

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

### GetOfficeAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_office_service.html

Retrieves the details of a specific office by its MoxiWorks office ID and company ID.

```APIDOC
## GetOfficeAsync

### Description
Retrieves the details of a specific office using the provided MoxiWorks office ID and company ID.

### Method
Task<Response<Office>> GetOfficeAsync(string moxiWorksOfficeId, string moxiWorksCompanyId)

### Parameters
- **moxiWorksOfficeId** (string) - Required - The unique identifier for the office.
- **moxiWorksCompanyId** (string) - Required - The unique identifier for the company.
```

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

### GetAgentsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_agent_service.html

Retrieves a list of agents based on company, office, and update criteria.

```APIDOC
## GetAgentsAsync

### Description
Retrieves a list of Agent entities from the Moxi Works platform based on the provided company and office IDs. Supports filtering by update timestamp and pagination.

### Parameters
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.
- **moxiWorksOfficeId** (string) - Optional - A valid Moxi Works Office ID.
- **updatedSince** (DateTime?) - Optional - Returns agents updated after this Unix timestamp.
- **pageNumber** (int?) - Optional - Page number for multi-page responses (default: 1).

### Returns
- **Response<AgentResults>** - A result containing a list of agents meeting the criteria.
```

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

### GetActionLogsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_action_log_service.html

Retrieves a list of action logs based on agent and contact identifiers.

```APIDOC
## GetActionLogsAsync

### Description
Retrieves action logs associated with a specific agent and contact.

### Signature
Task< Response< ActionLogResults > > GetActionLogsAsync(string agentId, AgentIdType agentIdType, string moxiWorksContactId, string partnerContactId)

### Parameters
- **agentId** (string) - The identifier for the agent.
- **agentIdType** (AgentIdType) - The type of the agent identifier.
- **moxiWorksContactId** (string) - The MoxiWorks contact identifier.
- **partnerContactId** (string) - The partner contact identifier.
```

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

### GetPresentationLogsCreatedAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_presentation_log_service.html

Retrieves presentation logs created within a specific date range.

```APIDOC
## GetPresentationLogsCreatedAsync

### Description
Retrieves presentation logs that were created between the specified start and end dates.

### Method
Task<Response<PresentationLogResults>>

### Parameters
- **moxiWorksCompanyId** (string) - Required - The unique identifier for the company.
- **createdAfter** (DateTime) - Required - The start of the creation date range.
- **createdBefore** (DateTime) - Required - The end of the creation date range.
- **page_number** (int) - Required - The page number to retrieve.
```

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

### PostRequestAsync<T>

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_moxi_works_client.html

Performs an asynchronous POST request to the specified URL.

```APIDOC
## async Task<Response<T>> PostRequestAsync<T>(string url, T obj)

### Description
Executes an asynchronous POST request with the provided object and returns a response of type T.
```

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

### GetBuyerTransactionsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_buyer_transaction_service.html

Retrieves a list of buyer transactions.

```APIDOC
## GetBuyerTransactionsAsync

### Description
Retrieves a paginated list of buyer transactions for a specific agent, optionally filtered by contact IDs.

### Signature
Task<Response<BuyerTransactionResults>> GetBuyerTransactionsAsync(string agentId, AgentIdType agentIdType, string moxiworksContactId=null, string partnerContactId=null, int pageNumber=1)
```

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

### GetAgentsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_agent_service.html

Retrieves a list of agents based on company or office criteria.

```APIDOC
## GetAgentsAsync

### Description
Retrieves a paginated list of agents associated with a specific company, optionally filtered by office and update timestamp.

### Method
GET

### Parameters
- **moxiWorksCompanyId** (string) - Required - The unique identifier for the MoxiWorks company.
- **moxiWorksOfficeId** (string) - Optional - The unique identifier for the office.
- **updatedSince** (DateTime?) - Optional - Filter agents updated since this date.
- **pageNumber** (int?) - Optional - The page number for pagination (default is 1).

### Response
- **Response<AgentResults>** - Returns a collection of agents wrapped in a response container.
```

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

### GetCompaniesAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_company_service.html

Retrieves a list of companies associated with the request query.

```APIDOC
## GetCompaniesAsync

### Description
Returns CompanyResults that contains associated Companies for the request query.

### Method
Async Task

### Returns
- **Response<CompanyResults>** - List of Companies and associated company ids.
```

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

### PostRequestAsync<T>

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_context_client.html

Performs an asynchronous POST request to the specified URL with a request body.

```APIDOC
## Task<string> PostRequestAsync<T>(string url, T obj)

### Description
Performs an asynchronous POST request to the specified URL with a request body of type T.

### Parameters
- **url** (string) - Required - The URL to send the POST request to.
- **obj** (T) - Required - The object to be serialized and sent in the request body.

### Returns
- **Task<string>** - A task representing the asynchronous operation, containing the response string.
```

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

### CreateEventAsync()

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/functions_c.html

Creates a new event using the EventService.

```APIDOC
## CreateEventAsync()

### Description
Creates a new event via the MoxiWorks.Platform.EventService.

### Method
Async Method

### Class
MoxiWorks.Platform.EventService
```

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

### PostRequestAsync<T>

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_moxi_works_client.html

Performs an asynchronous POST request to the specified URL with an object payload.

```APIDOC
## PostRequestAsync<T>

### Description
Performs an asynchronous POST request to the specified URL with the provided object and returns a response of type T.

### Signature
Task<Response<T>> PostRequestAsync<T>(string url, T obj)
```

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

### PutRequestAsync<T> / PutRequestAsync<T, U>

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_moxi_works_client-members.html

Performs an asynchronous PUT request to the specified URL with a request body.

```APIDOC
## PutRequestAsync<T> / PutRequestAsync<T, U>

### Description
Performs an asynchronous PUT request to the specified URL with a request body.

### Parameters
- **url** (string) - Required - The endpoint URL to send the PUT request to.
- **obj** (T or U) - Required - The object to be sent in the request body.
```

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

### GetBrandsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_brand_service-members.html

Retrieves a list of brands associated with a specific company and optionally an agent.

```APIDOC
## GetBrandsAsync

### Description
Retrieves brand information for a given company ID and optional agent ID.

### Signature
Task<BrandResults> GetBrandsAsync(string moxiWorksCompanyId, string moxiWorksAgentId = null)
```

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

### GetEmailCampaignsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_email_campaign_service.html

Retrieves a list of email campaigns associated with a specific agent.

```APIDOC
## GetEmailCampaignsAsync

### Description
Retrieves email campaigns for a given agent using their ID and type, optionally filtered by a partner contact ID.

### Signature
Task<Response<EmailCampaignResults>> GetEmailCampaignsAsync(string agentId, AgentIdType agentIdType, string partnerContactId)

### Parameters
- **agentId** (string) - The unique identifier for the agent.
- **agentIdType** (AgentIdType) - The type of the agent identifier.
- **partnerContactId** (string) - The unique identifier for the partner contact.

### Returns
- **Task<Response<EmailCampaignResults>>** - A task representing the asynchronous operation, containing the email campaign results.
```

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

### GetCompanyTeamsAync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_team_service.html

Retrieves a list of teams associated with a specific MoxiWorks company ID.

```APIDOC
## GetCompanyTeamsAync

### Description
Retrieves a list of teams associated with a specific MoxiWorks company ID.

### Method
Task< Response< List< Team > > > GetCompanyTeamsAync(string moxiWorksCompanyId)

### Parameters
- **moxiWorksCompanyId** (string) - Required - The unique identifier for the MoxiWorks company.
```

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

### GetCompanyTeamsAync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_team_service-members.html

Retrieves a list of teams associated with a specific MoxiWorks company ID.

```APIDOC
## GetCompanyTeamsAync

### Description
Retrieves all teams associated with the provided MoxiWorks company ID.

### Method
GET

### Parameters
- **moxiWorksCompanyId** (string) - Required - The unique identifier for the company.
```

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

### GetBrandsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_brand_service.html

Retrieves a list of brands associated with a specific company or agent.

```APIDOC
## GetBrandsAsync

### Description
Returns BrandResults that contains associated Brands for the request query.

### Method
SDK Method: GetBrandsAsync(string moxiWorksCompanyId, string agentId = null)

### Parameters
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.
- **agentId** (string) - Optional - The Moxi Works Platform ID of the Agent (email address or unique identification string).

### Returns
- **Response<BrandResults>** - A list of brands associated with the requested Agent or Company.
```

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

### GetEmailCampaignsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_email_campiagn_service.html

Retrieves a list of email campaigns associated with a specific agent and contact.

```APIDOC
## GetEmailCampaignsAsync

### Description
Searches the Moxi Works platform API for EmailCampaign entities associated with a specific agent and partner contact ID.

### Method
Task<Response<EmailCampaignResults>> GetEmailCampaignsAsync(string agentId, AgentIdType agentIdType, string partnerContactId)

### Parameters
- **agentId** (string) - Required - The Moxi Works Platform ID of the agent (AgentUuid or MoxiWorksAgentId).
- **agentIdType** (AgentIdType) - Required - The type of agent ID being provided.
- **partnerContactId** (string) - Required - The unique identifier used in your system associated with the contact.
```

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

### GetActionLogsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_action_log_service.html

Retrieves a list of action logs for a specific contact associated with an agent.

```APIDOC
## GetActionLogsAsync

### Description
Returns an ActionLogResult containing the action logs for a specific contact.

### Signature
`async Task<Response<ActionLogResults>> GetActionLogsAsync(string agentId, AgentIdType agentIdType, string moxiWorksContactId, string partnerContactId)`

### Parameters
- **agentId** (string) - The Moxi Works Platform ID of the agent (AgentUuid or MoxiWorksAgentId).
- **agentIdType** (AgentIdType) - The type of agent ID being used.
- **moxiWorksContactId** (string) - The Moxi Works Platform ID of the contact.
- **partnerContactId** (string) - The unique identifier used in the partner's system for the contact.

### Returns
- **Response<ActionLogResults>** - A list of the contact's logged actions.
```

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

### GetTeamAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_team_service.html

Retrieves the details of a specific team within a company.

```APIDOC
## GetTeamAsync

### Description
Retrieves the details of a specific team using the team ID and company ID.

### Parameters
- **moxiWorksTeamId** (string) - Required - A valid Moxi Works Team ID.
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.

### Returns
- **Response<Team>** - A response object containing the requested Team details.
```

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

### GetAgentGalleries

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_gallery_service.html

Retrieves a list of galleries associated with a specific agent.

```APIDOC
## GetAgentGalleries(string agentId, AgentIdType agentIdType, string moxiWorksCompanyId)

### Description
Retrieves the gallery entities associated with a specific agent. Galleries are groups of photos an agent has associated with a listing.

### Parameters
- **agentId** (string) - Required - The Moxi Works Platform ID of the agent (AgentUuid or MoxiWorksAgentId).
- **agentIdType** (AgentIdType) - Required - The type of agent ID being provided.
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.

### Returns
- **Task<Response<GalleryResults>>** - An asynchronous task returning the gallery results.
```

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

### GetCompanyBrandAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_brand_service-members.html

Retrieves brand information specifically for a given company.

```APIDOC
## GetCompanyBrandAsync

### Description
Retrieves brand information for a specific company ID.

### Signature
Task<Brand> GetCompanyBrandAsync(string moxiWorksCompanyId)
```

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

### GetBuyerTransactionsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_buyer_transaction_service.html

Retrieves a collection of buyer transactions based on agent and contact filters.

```APIDOC
## GetBuyerTransactionsAsync

### Description
Retrieves a collection of BuyerTransactions.

### Signature
`async Task<Response<BuyerTransactionResults>> GetBuyerTransactionsAsync(string agentId, AgentIdType agentIdType, string moxiworksContactId=null, string partnerContactId=null, int pageNumber=1)`
```

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

### GetCompanyTeamsAync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_team_service.html

Retrieves a list of all teams associated with a specific company.

```APIDOC
## GetCompanyTeamsAync

### Description
Retrieves a list of teams for a given company ID.

### Parameters
- **moxiWorksCompanyId** (string) - Required - The unique identifier for the company.

### Returns
- **Response<List<Team>>** - A response object containing a list of Team objects.
```

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

### PutRequestAsync<T, U>

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_moxi_works_client.html

Performs an asynchronous PUT request to the specified URL.

```APIDOC
## async Task<Response<T>> PutRequestAsync<T, U>(string url, U obj)

### Description
Executes an asynchronous PUT request with the provided object of type U and returns a response of type T.
```

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

### GetSellerTransactionsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_seller_transaction_service.html

Retrieves a list of seller transactions based on filters.

```APIDOC
## GetSellerTransactionsAsync

### Description
Requests a list of seller transactions.

### Signature
`async Task<Response<SellerTransactionResults>> GetSellerTransactionsAsync(string agentId, AgentIdType agentIdType, string moxiworksContactId=null, string partnerContactId=null, int pageNumber=1)`

### Parameters
- **agentId** (string) - Required - The ID of the agent.
- **agentIdType** (AgentIdType) - Required - The type of the agent ID.
- **moxiworksContactId** (string) - Optional - The Moxi Works contact ID.
- **partnerContactId** (string) - Optional - The partner contact ID.
- **pageNumber** (int) - Optional - The page number for pagination (default is 1).
```

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

### GetTasksAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_task_service-members.html

Retrieves a list of tasks based on filters.

```APIDOC
## GetTasksAsync

### Description
Retrieves a collection of tasks for a specific agent, optionally filtered by date range and contact ID.

### Method
TaskService.GetTasksAsync(string agentId, AgentIdType agentIdType, DateTime? startDate, DateTime? endDate, string partnerContactId, int pageNumber=1)
```

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

### PutRequestAsync<T>

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_context_client.html

Performs an asynchronous PUT request to the specified URL with a request body.

```APIDOC
## Task<string> PutRequestAsync<T>(string url, T obj)

### Description
Performs an asynchronous PUT request to the specified URL with a request body of type T.

### Parameters
- **url** (string) - Required - The URL to send the PUT request to.
- **obj** (T) - Required - The object to be serialized and sent in the request body.

### Returns
- **Task<string>** - A task representing the asynchronous operation, containing the response string.
```

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

### Obtaining End User Profiles

Source: https://moxiworks-platform.github.io/authentication.html

Retrieves information about an end user using an OAuth 2 access token provided in the Authorization header.

```APIDOC
## GET /user

### Description
Retrieves the profile information for the end user associated with the provided OAuth 2 access token.

### Method
GET

### Authentication
Requires an `Authorization` HTTP header with the value `Bearer <access_token>`.

### Response
#### Success Response (200)
- **display_name** (String) - The end user’s display name
- **username** (String) - A unique (mutable) identifier for the end user
- **user_id** (String) - A unique (immutable) identifier for the end user
- **email** (String) - Deprecated - use email_primary or email_display
- **email_primary** (String) - The end user’s primary email address
- **email_display** (String) - The end user’s display email address
- **company_name** (String) - The name of the company the end user works at
- **external_id** (String) - A unique identifier for the end user provided by the user’s company
```

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

### PutRequestAsync<T, U>

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_moxi_works_client.html

Performs an asynchronous PUT request to the specified URL with a payload of type U.

```APIDOC
## PutRequestAsync<T, U>

### Description
Performs an asynchronous PUT request to the specified URL with an object of type U and returns a response of type T.

### Signature
Task<Response<T>> PutRequestAsync<T, U>(string url, U obj)
```

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

### Access Token Request

Source: https://moxiworks-platform.github.io/authentication.html

Exchanges an authorization code for an access token and a refresh token.

```APIDOC
## POST /token

### Description
Exchanges the authorization code obtained from the initiation step for an access token.

### Request Body
- **client_id** (String) - Required - The client_id assigned to this client
- **client_secret** (String) - Required - The client_secret assigned to this client
- **code** (String) - Required - The authorization code obtained in the previous step
- **grant_type** (String) - Required - Must be set to 'authorization_code'
- **redirect_uri** (String) - Required - Must match the redirect_uri used in the initiation request

### Response
#### Success Response (200)
- **access_token** (String) - The access token
- **token_type** (String) - The type of the access token (always 'bearer')
- **expires_in** (Number) - Validity duration in seconds
- **refresh_token** (String) - The refresh token
- **created_at** (Number) - POSIX timestamp of issuance
```

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

### UpdateBuyerTransactionAsync()

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_buyer_transaction_service.html

Updates an existing BuyerTransaction object in the MoxiWorks platform.

```APIDOC
## UpdateBuyerTransactionAsync(BuyerTransaction buyerTransaction)

### Description
Updates an existing BuyerTransaction record within the MoxiWorks platform.

### Parameters
- **buyerTransaction** (BuyerTransaction) - Required - The BuyerTransaction object containing the updated information.

### Returns
- **Task<Response<BuyerTransaction>>** - A task representing the asynchronous operation, containing the updated BuyerTransaction.
```

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

### GetGroupsAsync(string agentId, AgentIdType agentIdType, string name)

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_group_service.html

Retrieves a collection of Group objects based on the provided agent identifier and optional group name.

```APIDOC
## GetGroupsAsync

### Description
Retrieves a collection of Group objects associated with a specific agent. You must provide an agent identifier and specify the type of identifier being used.

### Method
SDK Method

### Signature
`Task<Response<ICollection<GroupItem>>> GetGroupsAsync(string agentId, AgentIdType agentIdType, string name = null)`

### Parameters
- **agentId** (string) - Required. The Moxi Works Platform ID of the agent (AgentUuid or MoxiWorksAgentId).
- **agentIdType** (AgentIdType) - Required. The type of agent identifier being used.
- **name** (string) - Optional. The name of the group to search for.

### Returns
- **Response<ICollection<GroupItem>>** - A response object containing a collection of GroupItem objects.
```

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

### GetTasksAsync(string agentId, AgentIdType agentIdType, DateTime? startDate, DateTime? endDate, string partnerContactId, int pageNumber)

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_task_service.html

Retrieves a list of tasks for a specific agent based on the provided filtering parameters.

```APIDOC
## GetTasksAsync

### Description
Returns a list of agent tasks based on multiple parameters.

### Method
SDK Method

### Signature
`Task<Response<TaskResponse>> GetTasksAsync(string agentId, AgentIdType agentIdType, DateTime? startDate, DateTime? endDate, string partnerContactId, int pageNumber = 1)`

### Parameters
- **agentId** (string) - Required - The Moxi Works Platform ID of the agent (UUID, email, or unique string).
- **agentIdType** (AgentIdType) - Required - The type of agent ID being used.
- **startDate** (DateTime?) - Optional - The start date for the search.
- **endDate** (DateTime?) - Optional - The end date for the search.
- **partnerContactId** (string) - Optional - The unique identifier used in your system associated with the contact the task regards.
- **pageNumber** (int) - Optional - The page number to view (defaults to 1).

### Returns
- **Response<TaskResponse>** - A response object containing a list of tasks.
```

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

### UpdateListingData

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_listing_service.html

Updates listing data using a ListingUpdate object.

```APIDOC
## UpdateListingData

### Description
Updates the listing data specified in the ListingUpdatableData of the provided ListingUpdate object.

### Method
SDK Method: UpdateListingData(ListingUpdate listingUpdate)

### Parameters
- **listingUpdate** (ListingUpdate) - Required - The object containing the data to update.
```

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

### GetSoldListingsUpdatedSinceAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_sold_listing_service-members.html

Retrieves a collection of sold listings that have been updated since a specified date and time.

```APIDOC
## GetSoldListingsUpdatedSinceAsync

### Description
Retrieves a list of sold listings filtered by company, agent, and an optional update timestamp to support incremental synchronization.

### Signature
`Task<SoldListingResults> GetSoldListingsUpdatedSinceAsync(string moxiWorksCompanyId, AgentIdType agentIdType, string agentId=null, DateTime? updatedSince=null, string lastMoxiWorksListingId=null)`
```

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

### GetBuyerTransactionAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_buyer_transaction_service.html

Retrieves a specific BuyerTransaction by its Moxi Works Platform ID.

```APIDOC
## GetBuyerTransactionAsync(string agentId, AgentIdType agentIdType, string moxiWorksTransactionId)

### Description
Retrieves a single BuyerTransaction object based on the provided agent identification and the transaction's unique Moxi Works Platform ID.

### Parameters
- **agentId** (string) - Required - The Moxi Works Platform ID (UUID, email, or unique string) of the agent associated with the transaction.
- **agentIdType** (AgentIdType) - Required - The type of agent identifier being used.
- **moxiWorksTransactionId** (string) - Required - The RFC 4122 compliant UUID of the BuyerTransaction.

### Returns
- **Response<BuyerTransaction>** - A response object containing the requested BuyerTransaction or an empty transaction object.
```

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

### GetSellerTransactionsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_seller_transaction_service.html

Retrieves a list of seller transactions based on the provided agent and contact identifiers.

```APIDOC
## GetSellerTransactionsAsync

### Description
Request a list of seller transactions associated with a specific agent and optional contact identifiers.

### Method
SDK Method: GetSellerTransactionsAsync

### Parameters
- **agentId** (string) - Required - The Moxi Works Platform ID of the agent (AgentUuid or MoxiWorksAgentId).
- **agentIdType** (AgentIdType) - Required - The type of agent ID being used.
- **moxiworksContactId** (string) - Optional - The Moxi Works Platform ID of the contact associated with the transaction.
- **partnerContactId** (string) - Optional - The unique identifier used in your system for the contact.
- **pageNumber** (int) - Optional - The page of records to return (default is 1).

### Returns
- **Task<Response<SellerTransactionResults>>** - A list of seller transactions.
```

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

### GetAgentAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/interface_moxi_works_1_1_platform_1_1_interfaces_1_1_i_agent_service.html

Retrieves details for a specific agent.

```APIDOC
## GetAgentAsync

### Description
Retrieves the details of a specific agent identified by their agent ID and company ID.

### Method
GET

### Parameters
- **agentId** (string) - Required - The unique identifier for the agent.
- **moxiWorksCompanyId** (string) - Required - The unique identifier for the MoxiWorks company.

### Response
- **Response<Agent>** - Returns an agent object wrapped in a response container.
```

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

### GetCompanyBrandAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_brand_service.html

Retrieves the brand information for a specific company using its Moxi Works Company ID.

```APIDOC
## GetCompanyBrandAsync(string moxiWorksCompanyId)

### Description
Finds and returns the brand associated with the provided Moxi Works Company ID.

### Method
SDK Method

### Parameters
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID. Use the Company Endpoint to determine the appropriate ID.

### Returns
- **Response<Brand>** - The Brand object if it exists, or an empty Brand object.
```

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

### GetTaskAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_task_service-members.html

Retrieves a specific task by its identifiers.

```APIDOC
## GetTaskAsync

### Description
Retrieves a single task using the agent and partner-specific identifiers.

### Method
TaskService.GetTaskAsync(string agentId, AgentIdType agentIdType, string partnerContactId, string partnerTaskId)
```

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

### GetContactsAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_contact_service.html

Retrieves a list of contacts based on agent ID and optional filters.

```APIDOC
## GetContactsAsync

### Description
Gets Contact through the specified ID type.

### Signature
`Task<Response<ContactResults>> GetContactsAsync(string agentId, AgentIdType agentIdType, string emailAddress=null, string contactName=null, string phoneNumber=null, DateTime? updatedSince=null, int pageNumber=1)`
```

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

### UpdateTaskAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_task_service-members.html

Updates an existing task.

```APIDOC
## UpdateTaskAsync

### Description
Updates the details of an existing task in the MoxiWorks platform.

### Method
TaskService.UpdateTaskAsync(Task task)
```

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

### GetAgentAsync

Source: https://moxiworks-platform.github.io/moxiworks-dotnet/class_moxi_works_1_1_platform_1_1_agent_service.html

Retrieves a specific agent by their ID and company ID.

```APIDOC
## GetAgentAsync(string agentId, string moxiWorksCompanyId)

### Description
Retrieves an Agent object from the Moxi Works platform using the agent's unique identifier and the associated company ID.

### Parameters
- **agentId** (string) - Required - The Moxi Works Platform ID (UUID or MoxiWorksAgentId) of the agent.
- **moxiWorksCompanyId** (string) - Required - A valid Moxi Works Company ID.

### Returns
- **Response<Agent>** - The Agent object if it exists, or an empty Agent object.
```
Tokens:
Raw