> For the complete documentation index, see [llms.txt](https://atlas.anywhere.now/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://atlas.anywhere.now/developer-docs/get-agents-parameters.md). # Core REST API agent query parameters Reference for Core REST API Get All Agents query parameters. Authentication requires the approved service contract. {% hint style="warning" %} This reference describes Core REST API Get All Agents query parameters, not the Generic Dialogue Provider API. Authentication must already be configured for the target Core service. Cloud bearer authentication is supported from DC2024.01f. Confirm the token endpoint and authentication flow with the service owner before sending credentials. Do not send user credentials with grant\_type=client\_credentials. {% endhint %} ## Introduction The AnywhereNow Core has a Representational State Transfer (REST) Application Programming Interface (API), which can be used to GET realtime data accessible through the Dashboard (SignalR) Service. For example you can use this information to connect with a Microsoft Power BI, Power Automate flow or any other application which can integrate with a REST API. ## Legend A legend of variables used in the provided examples | Item | Description | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \ |


The public fqdn by which your UCC's webservices are accessible. Format is https\://\-<0x>.\.anywhere365.cloud/
example: .
Core REST API Agent Query Parameters Callout 1 Core REST API Agent Query Parameters Callout 2

| | \ |

The technical ucc name (i.e. not the displayname).

TIP: in SharePoint you can find the technical name by looking at the "name" part of the MainEndpoint Sip Address (i.e. between the: "sip:" and the "@" sign)
Release note illustration

| | \ |

Name of the Skill as entered in the SharePoint skills list.
Core REST API Agent Query Parameters Callout 3

| #### Core REST API Agent Query Parameters Callout 1 Source row: **\**. {% hint style="success" %} **Tip:**\ \ This fqdn would be similar to, for example, part of your WebWallboard URL or what you use to configure UCC Host in Snapper.\ [![Release note illustration](https://3348074750-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWvqGIKNqeAfbXp0iinO7%2Fuploads%2Fgit-blob-0cf40a529333097ae540b488beb5f9ad8b136c4d%2F845c3e05bf197004.png?alt=media)](https://github.com/AnywhereNow/atlas-docs/tree/main/developer-docs/.gitbook/assets/845c3e05bf197004.png) or [![Release note illustration](https://3348074750-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWvqGIKNqeAfbXp0iinO7%2Fuploads%2Fgit-blob-725fcd5eefdf18390263c976b938880d220ef7a6%2Fa4f50ac797083855.png?alt=media)](https://github.com/AnywhereNow/atlas-docs/tree/main/developer-docs/.gitbook/assets/a4f50ac797083855.png) {% endhint %} #### Core REST API Agent Query Parameters Callout 2 Source row: **\**. {% hint style="info" %} Note Only from within **Dialogue Studio** (which is a local service "inside" Dialogue Cloud) a local fqdn over http may be configured. Format is like http\://\-<0x>.\.dialoguecloud.local/\ *example: .* {% endhint %} #### Core REST API Agent Query Parameters Callout 3 Source row: **\**. {% hint style="success" %} TIP:\ If your skillname contains spaces replace these with "%20" code\ Example: Skillname in SharePoint is "**technical support**", replace in API with "**technical%20support**" {% endhint %} ## Available REST API's ### Get All Agents * No Authentication * With AnywhereNow Authentication **No Authentication** HTTP Request ``` GET http(s):///dashboardservice/api//agent ``` **With AnywhereNow Authentication** HTTP Request ``` GET http(s):///dashboardservice/api/v2//agent ``` This shows information about all signed-in agents only (formal signed-in or informal) #### Parameters If you also want to see the formal signed-out agents, you can add a parameter: * No Authentication * With AnywhereNow Authentication **No Authentication** HTTP Request ``` GET http(s):///dashboardservice/api//agent?includeFormalStopped=true ``` **With AnywhereNow Authentication** HTTP Request ``` GET http(s):///dashboardservice/api/v2//agent?includeFormalStopped=true ``` #### Fields | Item | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ActivityToken | The current activity of the agent. Empty of no activity. | | AverageHandlingTime | The average handling time of the agent | | CsPresenceState | Name of the presence of the agent. | | DeviceType | The last active device of the agent. | | LastPresenceChange | The date/time of the last presence change of the agent | | LastReasonCodeChange | The date/time of the last reason code change the agent has done | | MaxChats | When the agent can't receive anymore chats than he currently is handling, the value would be true. | | PresenceState | The current presence state of the agent. | | ReasonCode | The current reason code the agent is in | | RemainingWrapUpTime | The reaming wrap up time (DischargeDuration) the agent has. | | SipAddress | The SIP address of the agent. | | Skills |

The skills the agent owns.
- Name: The name of the skill that the agent has. - Value: The score the agent has for this skill.

| | TotalCallsToday | The amount of calls the agent has accepted today. | For the service-enablement prerequisites, administrator permissions, Tenant ID, and DC2024.01f authentication migration, see [Configure Authentication](https://atlas.anywhere.now/platform-administration/provisioning/provisioning/configurations/configure-authentication). Confirm the Core API token-request details separately with the service owner. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://atlas.anywhere.now/developer-docs/get-agents-parameters.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.