Retrieving ACS System Details

Learn how to list and get information about your ACS systems.

You can list details for all the ACSs in your workspace or get these details for a specific ACS. Note that Seam represents the ACS as an acs_system resource. When you want to create ACS users for your ACS, you must first obtain the ID of the acs_system for which you want to create these users.

---

List ACS Systems

You can list all acs_system resources in your workspace. Note the acs_system_id in the response.

JavaScript

Request:

await seam.acs.systems.list()

Response:

[
  {
    acs_system_id: '11111111-1111-1111-1111-111111111111',
    name: 'Visionline System',
    ...
  },
  ...
]

cURL

Request:

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/systems/list' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{}'

Response:

{
  "acs_systems": [
    {
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "name": "Visionline System",
      ...
    },
    ...
  ],
  "ok": true
}

Python

Request:

seam.acs.systems.list()

Response:

[
  AcsSystem(
    acs_system_id='11111111-1111-1111-1111-111111111111',
    name='Visionline System',
    ...
  ),
  ...
]

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->systems->list();

Response:

[
  {
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "name": "Visionline System",
    ...
  },
  ...
]

C#

Request:

seam.SystemsAcs.List();

Response:

{
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "name": "Visionline System",
  ...
}
...

---

Get an ACS System

You can get the details of a specific acs_system in your workspace. These details include the acs_system_id, date and time at which the acs_system was created in Seam, the name and type of the acs_system, and so on.

JavaScript

Request:

await seam.acs.systems.get({
  acs_system_id: '11111111-1111-1111-1111-111111111111',
})

Response:

{
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "name": "Example Inc",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2023-11-30T06:27:14.961Z",
  "external_type": "pti_site",
  "external_type_display_name": "PTI site",
  "connected_account_ids": ["11111111-1111-1111-1111-222222222222"],
  "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png",
  "image_alt_text": "PTI site Logo"
}

cURL

Request:

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/systems/get' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_system_id": "11111111-1111-1111-1111-111111111111"
}'

Response:

{
  "acs_system": {
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "name": "Example Inc",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2023-11-30T06:27:14.961Z",
    "external_type": "pti_site",
    "external_type_display_name": "PTI site",
    "connected_account_ids": ["11111111-1111-1111-1111-222222222222"],
    "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png",
    "image_alt_text": "PTI site Logo"
  },
  "ok": true
}

Python

Request:

seam.acs.systems.get(
 acs_system_id="11111111-1111-1111-1111-111111111111"
)

Response:

AcsSystem(
  acs_system_id='11111111-1111-1111-1111-111111111111',
  name='Example Inc',
  workspace_id='00000000-0000-0000-0000-000000000000',
  created_at='2023-11-30T06:27:14.961Z',
  external_type='pti_site',
  external_type_display_name='PTI site",
  connected_account_ids=[
    '11111111-1111-1111-1111-222222222222'
  ],
  image_url='https://connect.getseam.com/assets/images/acs_systems/pti_site.png',
  image_alt_text='PTI site Logo'
)

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->systems->get(
  acs_system_id: "11111111-1111-1111-1111-111111111111"
);

Response:

{
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "name": "Example Inc",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2023-11-30T06:27:14.961Z",
  "external_type": "pti_site",
  "external_type_display_name": "PTI site",
  "connected_account_ids": ["11111111-1111-1111-1111-222222222222"],
  "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png",
  "image_alt_text": "PTI site Logo"
}

C#

Request:

seam.SystemsAcs.Get(
  acsSystemId: "11111111-1111-1111-1111-111111111111"
);

Response:

{
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "name": "Example Inc",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2023-11-30T06:27:14.961Z",
  "external_type": "pti_site",
  "external_type_display_name": "PTI site",
  "connected_account_ids": ["11111111-1111-1111-1111-222222222222"],
  "image_url": "https://connect.getseam.com/assets/images/acs_systems/pti_site.png",
  "image_alt_text": "PTI site Logo"
}