List all copilots

1 curl https://api-prod.scoutos.com/v2/copilots \ 2 -H "Authorization: Bearer <apiKey>"

1 { 2 "data": [ 3 { 4 "copilot_config": { 5 "workflow_id": "workflow_id", 6 "img_url": "img_url", 7 "display_name": "display_name", 8 "mode": "light", 9 "code_theme": "dark", 10 "colors": {}, 11 "fab": {}, 12 "loading_text": "loading_text", 13 "message_placeholder": "message_placeholder", 14 "initial_activity": [ 15 null 16 ], 17 "allowed_origins": "allowed_origins" 18 }, 19 "last_updated_at": "last_updated_at", 20 "created_at": "created_at", 21 "created_by": { 22 "type": "user", 23 "details": { 24 "user_id": "user_id", 25 "org_id": "org_id", 26 "scout_organization_id": "scout_organization_id", 27 "email": {} 28 } 29 }, 30 "last_updated_by": { 31 "type": "user", 32 "details": { 33 "user_id": "user_id", 34 "org_id": "org_id", 35 "scout_organization_id": "scout_organization_id", 36 "email": {} 37 } 38 }, 39 "revision_id": "revision_id", 40 "copilot_id": "copilot_id", 41 "is_draft": false 42 } 43 ], 44 "next_cursor": "next_cursor", 45 "has_more": false 46 }

List all copilots in the organization

Query parameters

sortstring or nullOptional

Field to sort by

directionstring or nullOptional

Sort in ascending or descending order

start_atstring or nullOptional

created_at to start at

limitinteger or nullOptional

Limit of records to return

querystring or nullOptional

Search query

Response

Successful Response

datalist of objects

has_moreboolean

next_cursordatetime or nullOptional

Headers

Query parameters

Response

Errors