Beta

List all copilots

GET

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.copilots.list()

Play

1 {
2   "data": [
3     {
4       "copilot_config": {},
5       "last_updated_at": "2024-01-15T09:30:00Z",
6       "created_at": "2024-01-15T09:30:00Z",
7       "created_by": {
8         "type": "user",
9         "details": {
10           "user_id": "user_id",
11           "org_id": "org_id",
12           "scout_organization_id": "scout_organization_id",
13           "email": {
14             "key": "value"
15           }
16         }
17       },
18       "last_updated_by": {
19         "type": "user",
20         "details": {
21           "user_id": "user_id",
22           "org_id": "org_id",
23           "scout_organization_id": "scout_organization_id",
24           "email": {
25             "key": "value"
26           }
27         }
28       },
29       "revision_id": "revision_id",
30       "copilot_id": "copilot_id",
31       "is_draft": true
32     }
33   ],
34   "has_more": true,
35   "next_cursor": "2024-01-15T09:30:00Z"
36 }

List all copilots in the organization

Query parameters

sortstringOptional

Field to sort by

directionstringOptional

Sort in ascending or descending order

start_atstringOptional

created_at to start at

limitintegerOptional

Limit of records to return

querystringOptional

Search query

Response

Successful Response

datalist of objects

has_moreboolean

next_cursordatetimeOptional

List all copilots

Headers

Query parameters

Response

Errors