Skip to main content
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
platform_accounts
List platform accounts
curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_accounts \
  --header 'Authorization: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "platform_account_id": "<string>",
    "name": "<string>",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "platform_integration_id": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organization_id
string<uuid>
required

A UUID string identifying the organization.

​
workspace_id
string<uuid>
required

A UUID string identifying the workspace.

Query Parameters

​
platform
string

Optional platform filter. If not provided, returns all accounts in the workspace.

Response

A list of platform accounts in the workspace, optionally filtered by platform.

​
id
string<uuid>
required
read-only
​
platform_account_id
string
required

External platform account ID

Maximum string length: 255
​
name
string
required
Maximum string length: 255
​
platform
enum<string>
required
  • google_ads - google ads
  • tiktok - tiktok
Available options:
google_ads,
tiktok
​
workspace_id
string<uuid>
required
read-only
​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
platform_integration_id
string
required
read-only
​
status
enum<string>
  • active - active
  • expired - expired
  • disabled - disabled
Available options:
active,
expired,
disabled