curl --request GET \
--url https://api.social-api.ai/v1/migrations/{provider} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.social-api.ai/v1/migrations/{provider}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.social-api.ai/v1/migrations/{provider}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"assessed_at": "<string>",
"assessment": {
"brands": 123,
"pages_per_brand": 123,
"profiles": [
{
"brands": 123,
"id": "<string>",
"name": "<string>",
"pages_per_brand": 123,
"servable_accounts": 123,
"splits": [
"<string>"
]
}
],
"recommended_plan": {
"brands_limit": 123,
"name": "<string>",
"pages_per_brand": 123,
"tier": "starter"
},
"servable_accounts": 123,
"stays_with_provider": [
{
"count": 123,
"platform": "<string>",
"reason": "<string>"
}
]
},
"assessment_error": "<string>",
"authorisation": {
"text": "<string>",
"version": "<string>"
},
"authorisation_version": "<string>",
"authorised_at": "<string>",
"base_url": "https://z.social-api.ai/api",
"created_at": "<string>",
"cut_over": 123,
"forwarded_calls": 123,
"key_hint": "<string>",
"started": true
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}Get a migration
Returns your migration from a provider: the authorisation text to accept before starting, and once started, your accounts, the Brands and plan they need, and progress. If the provider cannot be read, the response is still 200 with assessment null and assessment_error set. The assessment can be up to 5 minutes old unless refresh is true. Dashboard sessions only; API keys get 403.
curl --request GET \
--url https://api.social-api.ai/v1/migrations/{provider} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.social-api.ai/v1/migrations/{provider}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.social-api.ai/v1/migrations/{provider}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"assessed_at": "<string>",
"assessment": {
"brands": 123,
"pages_per_brand": 123,
"profiles": [
{
"brands": 123,
"id": "<string>",
"name": "<string>",
"pages_per_brand": 123,
"servable_accounts": 123,
"splits": [
"<string>"
]
}
],
"recommended_plan": {
"brands_limit": 123,
"name": "<string>",
"pages_per_brand": 123,
"tier": "starter"
},
"servable_accounts": 123,
"stays_with_provider": [
{
"count": 123,
"platform": "<string>",
"reason": "<string>"
}
]
},
"assessment_error": "<string>",
"authorisation": {
"text": "<string>",
"version": "<string>"
},
"authorisation_version": "<string>",
"authorised_at": "<string>",
"base_url": "https://z.social-api.ai/api",
"created_at": "<string>",
"cut_over": 123,
"forwarded_calls": 123,
"key_hint": "<string>",
"started": true
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}Authorizations
Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...
Path Parameters
Provider identifier
Query Parameters
true to read your accounts now
Response
OK
When the accounts were last read, RFC 3339. Null until the first read succeeds.
Your accounts and how they map to SocialAPI. Null until started, or when your provider could not be read.
Show child attributes
Show child attributes
Why assessment is null on a started migration: migration.key_invalid, migration.key_restricted or migration.source_unavailable.
Text to accept before starting, and its version.
Show child attributes
Show child attributes
Version of the authorisation text accepted. Null until started.
When the authorisation was accepted, RFC 3339. Null until started.
Base URL to set in your existing client. Null until started.
"https://z.social-api.ai/api"
When the migration started, RFC 3339. Null until started.
Accounts already reconnected to SocialAPI.
Requests sent through the base URL since the migration started.
Start and end of the key in use. Null until started.
True once a migration has started.