@seamapi/http - v2.1.0
    Preparing search index...

    Type Alias AccessCodesListParameters

    type AccessCodesListParameters = {
        access_code_ids?: string[];
        access_grant_id?: string;
        access_grant_key?: string;
        access_method_id?: string;
        customer_key?: string;
        device_id?: string;
        limit?: number;
        page_cursor?: string;
        search?: string;
        user_identifier_key?: string;
    }
    Index
    access_code_ids? access_grant_id? access_grant_key? access_method_id? customer_key? device_id? limit? page_cursor? search? user_identifier_key?
    access_code_ids?: string[]

    IDs of the access codes that you want to retrieve. Specify device_id, access_code_ids, access_method_id, access_grant_id, or access_grant_key.

    access_grant_id?: string

    ID of the access grant for which you want to list access codes. Specify device_id, access_code_ids, access_method_id, access_grant_id, or access_grant_key.

    access_grant_key?: string

    Key of the access grant for which you want to list access codes. Specify device_id, access_code_ids, access_method_id, access_grant_id, or access_grant_key.

    access_method_id?: string

    ID of the access method for which you want to list access codes. Specify device_id, access_code_ids, access_method_id, access_grant_id, or access_grant_key.

    customer_key?: string

    Customer key for which you want to list access codes.

    device_id?: string

    ID of the device for which you want to list access codes. Specify device_id, access_code_ids, access_method_id, access_grant_id, or access_grant_key.

    limit?: number

    Numerical limit on the number of access codes to return.

    Optionalpage_cursor

    page_cursor?: string

    Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    search?: string

    String for which to search. Filters returned access codes to include all records that satisfy a partial match using name, code or access_code_id.

    user_identifier_key?: string

    Your user ID for the user by which to filter access codes.

    Settings
    Member Visibility

    On This Page
    Properties