Group links

Fetch group links

get/group_links

Request

  • Base URL
    https://api.kisi.io
  • URL
    https://api.kisi.io/group_links
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization code: https://api.kisi.io/oauth/authorize
      Token URL: https://api.kisi.io/oauth/token

Query parameters

idsstring

Filter by object IDs

group_idinteger

Filter by group ID

querystring

Filter by the name, email or phone of the record. Also filters on the group's name.

sort'name' | '-name' | 'unlock' | '-unlock' | 'valid_until' | '-valid_until' | 'group_name' | '-group_name'

Sort the results. Prepend - to sort in reverse order.

name - sort by group link name, alphabetically<br> unlock - sort by last unlock; no unlocks first, then oldest to most recent<br> valid_until - Sort by group link valid_until; earliest to final, then no expiration

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

Response

OK

idinteger required

The ID of the group link

resource_type'GroupLink' required

The resource type of the group link

namestring required

The name of the group link

emailstring email nullable required

The email to the person who should have access.

phonestring nullable required

The phone number of the person who should have access. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted.

last_used_atstring date-time nullable required

When the group link was last used.

link_enabledboolean required

Will generate a link that can be used for access.

quick_response_code_type'online' | 'offline' | 'null' nullable required

Will generate a QR code (optionally offline capable) that can be scanned with compatible Kisi readers. Will be sent as part of the access link email, if an email address is provided. Will never be sent as part of SMS.

valid_fromstring date-time nullable required
valid_untilstring date-time nullable required
created_atstring date-time required

When the group link was created

updated_atstring date-time required

When the group link was updated

group_idinteger required

The group ID of the group link

created_by_type'null' | 'User' | 'MarketplaceInstallation' nullable required

The created_by type of the group link

created_by_idinteger nullable required

The created_by ID of the group link

issued_by_idinteger nullable required

The issued_by ID of the group link

Changes

No recorded changes to this operation across all 9 revisions of this API.