Skip to main content

Notifications

Copilot Studio - General
Unanswered

Copilot studio api to list copilots and get their configuration

Posted on by 2

Hello,

I've created several copilots in our environment and we would like to obtain a list of them, along with the configuration of each, via an API. Is that supported? If so, I would prefer to perform these API HTTP requests using a servicePrincipal identity rather than a user identity.

 

For example: GET https://<some-microsoft-api-url>/listCopilots

I would greatly appreciate your help, whether it's possible or currently not.

Thank you.

  • yaiaim Profile Picture
    yaiaim 2 on at
    Re: Copilot studio api to list copilots and get their configuration

    Thank you @MattJimison .

    My Web API Endpoint is: https://***.crm4.dynamics.com/api/data/v9.2

    When I try this (even with v9.1), I receive a 401 Unauthorized HTTP status. I assume there is some authentication process required on behalf of the servicePrincipal. Could you help with that, please?

    Are there any CURL examples for both authentication and querying those custom copilots?

    Thanks in advance.

  • MattJimison Profile Picture
    MattJimison 577 on at
    Re: Copilot studio api to list copilots and get their configuration

    Hi, @yaiaim .

     

    Yes! You can use the Dataverse web api to get this information from the 'Bots' table.

     

    Here is an example 'get' query where you'd simply need to fill in your Environment Url:
    https://[enter-your-org].crm.dynamics.com/api/data/v9.1/bots?$select=name,authenticationmode

     

    Here's more information on using the API:

    https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/query-data-web-api#select-columns

     

    Here's a sample of what the results look like on the above query (remove the ?$select=name,authenticationmode and you'll be able to see all of the properties that are available)

    MattJimison_0-1712988904309.png

     

    Cheers,
    Matt

     


    Find this post helpful? Please mark it as the solution and/or provide kudos so that it will help others in the future.

    Cheers,
    Matt

Helpful resources

Quick Links

Welcome to the Power Platform…

We are thrilled to unveil the newly-launched Power Platform Communities!…

Getting Started…

Welcome to the Power Platform Community! We appreciate your visit…

Welcome to the new Power Platform Community!…

We are excited to announce our new Copilot Cookbook Gallery in the Community…

Leaderboard

#1
WarrenBelz Profile Picture

WarrenBelz 138,287

#2
RandyHayes Profile Picture

RandyHayes 76,308

#3
Pstork1 Profile Picture

Pstork1 63,172

Leaderboard