Retrieving Entrance Details

Learn how to get details about the entrances in your ACS, including listing the credentials that provide access to a specific entrance.

In an ACS, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the acs_entrance resources in your workspace or get these details for a specific acs_entrance. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.

List All Entrances

You can list all acs_entrance resources in your workspace. Note that entrance details include manufacturer-specific metadata that may vary by manufacturer.

Request:

seam.acs.entrances.list()

Response:

[
  AcsEntrance(
    acs_entrance_id='55555555-5555-5555-5555-555555555555',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000',
    display_name='Guest Lock 2',
    ....
  ),
  ...
]

Request:

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

Response:

{
  "acs_entrances": [
    {
      "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "display_name": "Guest Lock 2",
      ...
    },
    ...
  ],
  "ok": true
}

Request:

await seam.acs.entrances.list();

Response:

[
  {
    acs_entrance_id: '55555555-5555-5555-5555-555555555555',
    acs_system_id: '11111111-1111-1111-1111-111111111111',
    workspace_id: '00000000-0000-0000-0000-000000000000',
    display_name: 'Guest Lock 2',
    ...
  },
  ...
]

Request:

# Coming soon!

Response:

# Coming soon!

Request:

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

Response:

[
  {
    "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "display_name": "Guest Lock 2",
    ...
  },
  ...
]

Request:

seam.EntrancesAcs.List();

Response:

{
  "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "display_name": "Guest Lock 2",
  ...
}
...

Request:

// Coming soon!

Response:

// Coming soon!

Request:

acs_entrances, uErr := client.Acs.Entrances.List(
  context.Background(), &acs.EntrancesListRequest{},
)

Response:

{
  "acs_entrances": [
    {
      "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "display_name": "Guest Lock 2",
      ...
    },
    ...
  ],
  "ok": true
}

List Entrances in an ACS

To list all acs_entrances in a specific ACS, include the acs_system_id filter in the List Entrances request. Note that entrance details include manufacturer-specific metadata that may vary by manufacturer.

Request:

seam.acs.entrances.list(
  acs_system_id="11111111-1111-1111-1111-111111111111"
)

Response:

[
  AcsEntrance(
    acs_entrance_id='55555555-5555-5555-5555-555555555555',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    workspace_id='00000000-0000-0000-0000-000000000000',
    display_name='Guest Lock 2',
    ....
  ),
  ...
]

Request:

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/entrances/list' \
  -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_entrances": [
    {
      "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "display_name": "Guest Lock 2",
      ...
    },
    ...
  ],
  "ok": true
}

Request:

await seam.acs.entrances.list({
  acs_system_id: "11111111-1111-1111-1111-111111111111"
});

Response:

[
  {
    acs_entrance_id: '55555555-5555-5555-5555-555555555555',
    acs_system_id: '11111111-1111-1111-1111-111111111111',
    workspace_id: '00000000-0000-0000-0000-000000000000',
    display_name: 'Guest Lock 2',
    ...
  },
  ...
]

Request:

# Coming soon!

Response:

# Coming soon!

Request:

$seam->acs->entrances->list(
  acs_system_id: "11111111-1111-1111-1111-111111111111"
);

Response:

[
  {
    "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "display_name": "Guest Lock 2",
    ...
  },
  ...
]

Request:

seam.EntrancesAcs.List(
  acsSystemId: "11111111-1111-1111-1111-111111111111"
);

Response:

{
  "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "display_name": "Guest Lock 2",
  ...
}
...

Request:

// Coming soon!

Response:

// Coming soon!

Request:

acs_entrances, uErr := client.Acs.Entrances.List(
  context.Background(), &acs.EntrancesListRequest{
    AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"),
  },
)

Response:

{
  "acs_entrances": [
    {
      "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "display_name": "Guest Lock 2",
      ...
    },
    ...
  ],
  "ok": true
}

List Credentials Associated with an Entrance

To list the credentials that grant access to a specific entrance, use list_credentials_with_access method for the acs_entrance object and provide the acs_entrance_id.

Request:

seam.acs.entrances.list_credentials_with_access(
  acs_entrance_id="55555555-5555-5555-5555-555555555555"
)

Response:

This response contains manufacturer-specific metadata that may vary by manufacturer.

[
  AcsCredential(
    acs_credential_id='77777777-7777-7777-7777-777777777777',
    acs_user_id='33333333-3333-3333-3333-333333333333',
    acs_system_id='11111111-1111-1111-1111-111111111111',
    access_method='mobile_key',
    starts_at='2024-04-09T14:30:55.688Z',
    ends_at='2024-03-04T10:40:00.000Z',
    ...
  ),
  ...
]

Request:

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

Response:

This response contains manufacturer-specific metadata that may vary by manufacturer.

{
  "acs_credentials": [
    {
      "acs_credential_id": "77777777-7777-7777-7777-777777777777",
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "access_method": "mobile_key",
      "starts_at": "2024-04-09T14:30:55.688Z",
      "ends_at": "2024-03-04T10:40:00.000Z",
      ...
    },
    ...
  ],
  "ok": true
}

Request:

await seam.acs.entrances.list_credentials_with_access({
  acs_entrance_id: "55555555-5555-5555-5555-555555555555"
});

Response:

This response contains manufacturer-specific metadata that may vary by manufacturer.

[
  {
    acs_credential_id: '77777777-7777-7777-7777-777777777777',
    acs_user_id: '33333333-3333-3333-3333-333333333333',
    acs_system_id: '11111111-1111-1111-1111-111111111111',
    access_method: 'mobile_key',
    starts_at: '2024-04-09T14:30:55.688Z',
    ends_at: '2024-03-04T10:40:00.000Z',
    ...
  },
  ...
]

Request:

# Coming soon!

Response:

# Coming soon!

Request:

$seam->acs->entrances->list_credentials_with_access(
  acs_entrance_id: "55555555-5555-5555-5555-555555555555"
);

Response:

This response contains manufacturer-specific metadata that may vary by manufacturer.

[
  {
    "acs_credential_id": "77777777-7777-7777-7777-777777777777",
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "access_method": "mobile_key",
    "starts_at": "2024-04-09T14:30:55.688Z",
    "ends_at": "2024-03-04T10:40:00.000Z",
    ...
  },
  ...
]

Request:

seam.EntrancesAcs.ListCredentialsWithAccess(
  acsEntranceId: "55555555-5555-5555-5555-555555555555"
);

Response:

This response contains manufacturer-specific metadata that may vary by manufacturer.

{
  "acs_credential_id": "77777777-7777-7777-7777-777777777777",
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "access_method": "mobile_key",
  "starts_at": "2024-04-09T14:30:55.688Z",
  "ends_at": "2024-03-04T10:40:00.000Z",
  ...
}
...

Request:

// Coming soon!

Response:

// Coming soon!

Request:

acs_users, uErr := client.Acs.Entrances.ListCredentialsWithAccess(
  context.Background(), &acs.UsersListRequest{
    AcsEntranceId: api.String("55555555-5555-5555-5555-555555555555")
  },
)

Response:

This response contains manufacturer-specific metadata that may vary by manufacturer.

{
  "acs_credentials": [
    {
      "acs_credential_id": "77777777-7777-7777-7777-777777777777",
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "access_method": "mobile_key",
      "starts_at": "2024-04-09T14:30:55.688Z",
      "ends_at": "2024-03-04T10:40:00.000Z",
      ...
    },
    ...
  ],
  "ok": true
}

List Entrances Associated with a Credential

To list the entrances to which a specific credential grants access, use list_accessible_entrances method for the acs_credential object and provide the acs_credential_id. For details, see Managing Credentials.

Get an Entrance

You can get the details of a specific acs_entrance. Note that entrance details include manufacturer-specific metadata that may vary by manufacturer.

Request:

seam.acs.entrances.get(
  acs_entrance_id="55555555-5555-5555-5555-555555555555"
)

Response:

AcsEntrance(
  acs_entrance_id: '55555555-5555-5555-5555-555555555555',
  acs_system_id: '11111111-1111-1111-1111-111111111111',
  workspace_id: '00000000-0000-0000-0000-000000000000',
  display_name: 'Guest Lock 2',
  ...
)

Request:

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

Response:

{
  "acs_entrance": {
    "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "display_name": "Guest Lock 2",
    ...
  },
  "ok": true
}

Request:

await seam.acs.entrances.get({
  acs_entrance_id: "55555555-5555-5555-5555-555555555555"
});

Response:

{
  acs_entrance_id: '55555555-5555-5555-5555-555555555555',
  acs_system_id: '11111111-1111-1111-1111-111111111111',
  workspace_id: '00000000-0000-0000-0000-000000000000',
  display_name: 'Guest Lock 2',
  ...
}

Request:

# Coming soon!

Response:

# Coming soon!

Request:

$seam->acs->entrances->get(
  acs_entrance_id: "55555555-5555-5555-5555-555555555555"
);

Response:

{
  "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "display_name": "Guest Lock 2",
  ...
}

Request:

seam.EntrancesAcs.Get(
  acsEntranceId: "55555555-5555-5555-5555-555555555555"
);

Response:

{
  "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "display_name": "Guest Lock 2",
  ...
}

Request:

// Coming soon!

Response:

// Coming soon!

Request:

acs_entrance, uErr := client.Acs.Entrances.Get(
  context.Background(), &acs.EntrancesGetRequest{
    AcsEntranceId: "55555555-5555-5555-5555-555555555555",
  },
)

Response:

{
  "acs_entrance": {
    "acs_entrance_id": "55555555-5555-5555-5555-555555555555",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "display_name": "Guest Lock 2",
    ...
  },
  "ok": true
}

PreviousAssigning ACS Users to Access Groups NextManaging Credentials

Last updated 1 month ago