Skip to main content
GET
/
account
/
sdks
/
{sdkId}
Retrieve an SDK
curl --request GET \
  --url https://app.asksquid.ai/api/v1/account/sdks/{sdkId} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "64fa2b9f1c2a3e4b5d6f7890",
  "name": "<string>",
  "enabled": true,
  "admins": [
    "jsmith@example.com"
  ],
  "viewers": [
    "jsmith@example.com"
  ],
  "urls": [
    "<string>"
  ],
  "state": {
    "deployed": false,
    "connected": false
  },
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required

Bearer token, format: Bearer <token>.

Path Parameters

​
sdkId
string
required

SDK ID MongoDB ObjectId as 24 hex characters.

Pattern: ^[a-fA-F0-9]{24}$
Example:

"64fa2b9f1c2a3e4b5d6f7890"

Response

SDK

​
_id
string
required
read-only

MongoDB ObjectId as 24 hex characters.

Pattern: ^[a-fA-F0-9]{24}$
Example:

"64fa2b9f1c2a3e4b5d6f7890"

​
name
string
required
Minimum string length: 1
​
enabled
boolean
default:true
​
admins
string<email>[]

SDK admin email

​
viewers
string<email>[]

SDK viewer email

​
urls
string<uri>[]

SDK url list

​
state
object
​
created_at
string<date-time>
read-only