Card assignments

Fetch card assignments

get/card_assignments

Request

  • Base URL
    https://api.kisi.io
  • URL
    https://api.kisi.io/card_assignments
  • 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

assignee_type'User' | 'Guest'

Filter by assignee type

assignee_idinteger

Filter by assignee ID. Must be used with assignee_type

status'activated' | 'deactivated'

Filter by status

card_idstring

Filter by card IDs

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

integer
OR
string

Filter by user ID or by current user if value is me.

guest_idinteger

Filter by guest ID

Response

OK

idinteger required

The ID of the card assignment

resource_type'CardAssignment' required

The resource type of the card assignment

created_atstring date-time required

When the card assignment was created

updated_atstring date-time required

When the card assignment was updated

status'activated' | 'deactivated' required

The status of the card assignment.

two_factor_pinstring nullable required

Pin code used as two factor authentication for the card assignment.

send_two_factor_pin_notificationboolean required

Whether to send a notification to the assignee when the two factor pin is set/changed.

assignee_type'User' | 'Guest' required

The assignee type of the card assignment

assignee_idinteger required

The assignee ID of the card assignment

card_idinteger required

The card ID of the card assignment

created_by_type'null' | 'User' nullable required

The created_by type of the card assignment

created_by_idinteger nullable required

The created_by ID of the card assignment

guest_idinteger nullable required

The guest ID of the card assignment

user_idinteger nullable required

The user ID of the card assignment

Changes

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