Skip to content

incident_io_client.api.incidents_v2.incidents_v2_list

asyncio async 

asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
    status: Union[Unset, Any] = UNSET,
    status_category: Union[Unset, Any] = UNSET,
    created_at: Union[Unset, Any] = UNSET,
    severity: Union[Unset, Any] = UNSET,
    incident_type: Union[Unset, Any] = UNSET,
    incident_role: Union[Unset, Any] = UNSET,
    custom_field: Union[Unset, Any] = UNSET,
    mode: Union[Unset, Any] = UNSET
) -> Optional[IncidentsV2ListResponseBody]

List Incidents V2

List all incidents for an organisation.

This endpoint supports a number of filters, which can help find incidents matching certain criteria.

Filters are provided as query parameters, but due to the dynamic nature of what you can query by (different accounts have different custom fields, statuses, etc) they are more complex than most.

To help, here are some exemplar curl requests with a human description of what they search for.

Note that: - Filters may be used together, and the result will be incidents that match all filters. - IDs are normally in UUID format, but have been replaced with shorter strings to improve readability. - All query parameters must be URI encoded.

By status

With status of id=ABC, find all incidents that are set to that status:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status[one_of]=ABC'

Or all incidents that are not set to status with id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status[not_in]=ABC'
By created_at

Find all incidents created_at before or after a given date. Possible values are \"gte\" (greater than or equal to) and \"lte\" (less than or equal to). The following example finds all incidents created before or on 2021-01-02:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'created_at[lte]=2021-01-02'
By status category

Find all incidents that are in a status category. Possible values are \"triage\", \"declined\", \"merged\", \"canceled\", \"live\", \"learning\" and \"closed\":

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status_category[one_of]=live'

Or all incidents that are not in a status category:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status_category[not_in]=live'
By severity

With severity of id=ABC, find all incidents that are set to that severity:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[one_of]=ABC'

Or all incidents where severity rank is greater-than-or-equal-to the rank of severity id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[gte]=ABC'

Or all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[lte]=ABC'
By incident type

With incident type of id=ABC, find all incidents that are of that type:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_type[one_of]=ABC'

Or all incidents not of that type:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_type[not_in]=ABC'
By incident mode

By default, we return standard and retrospective incidents. This means that test and tutorial incidents are filtered out. To override this behaviour, you can use the mode filter to specify which modes you want to get.

To find incidents of all modes:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'mode[one_of]=standard&mode[one_of]=retrospective&mode[one_of]=test&mode[one_of]=tutorial'

To find just test incidents:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'mode[one_of]=test'
By incident role

Roles and custom fields have another nested layer in the query parameter, to account for operations against any of the roles or custom fields created in the account.

With incident role id=ABC, find all incidents where that role is unset:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_role[ABC][is_blank]=true'

Or where the role has been set:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_role[ABC][is_blank]=false'
By option custom fields

With an option custom field id=ABC, all incidents that have field ABC set to the custom field option of id=XYZ:

        curl \
                --get 'https://api.incident.io/v2/incidents' \
                --data 'custom_field[ABC][one_of]=XYZ'

Or all incidents that do not have custom field id=ABC set to option id=XYZ:

        curl \
                --get 'https://api.incident.io/v2/incidents' \
                --data 'custom_field[ABC][not_in]=XYZ'

Parameters:

Name Type Description Default
page_size Union[Unset, int]

Default: 25.

 25
after Union[Unset, str]
UNSET
status Union[Unset, Any]
UNSET
status_category Union[Unset, Any]
UNSET
created_at Union[Unset, Any]
UNSET
severity Union[Unset, Any]
UNSET
incident_type Union[Unset, Any]
UNSET
incident_role Union[Unset, Any]
UNSET
custom_field Union[Unset, Any]
UNSET
mode Union[Unset, Any]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[IncidentsV2ListResponseBody]

IncidentsV2ListResponseBody
Source code in incident_io_client/api/incidents_v2/incidents_v2_list.py 
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
    status: Union[Unset, Any] = UNSET,
    status_category: Union[Unset, Any] = UNSET,
    created_at: Union[Unset, Any] = UNSET,
    severity: Union[Unset, Any] = UNSET,
    incident_type: Union[Unset, Any] = UNSET,
    incident_role: Union[Unset, Any] = UNSET,
    custom_field: Union[Unset, Any] = UNSET,
    mode: Union[Unset, Any] = UNSET,
) -> Optional[IncidentsV2ListResponseBody]:
    r""" List Incidents V2

     List all incidents for an organisation.

    This endpoint supports a number of filters, which can help find incidents matching certain
    criteria.

    Filters are provided as query parameters, but due to the dynamic nature of what you can
    query by (different accounts have different custom fields, statuses, etc) they are more
    complex than most.

    To help, here are some exemplar curl requests with a human description of what they search
    for.

    Note that:
    - Filters may be used together, and the result will be incidents that match all filters.
    - IDs are normally in UUID format, but have been replaced with shorter strings to improve
    readability.
    - All query parameters must be URI encoded.

    ### By status

    With status of id=ABC, find all incidents that are set to that status:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status[one_of]=ABC'

    Or all incidents that are not set to status with id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status[not_in]=ABC'

    ### By created_at

    Find all incidents created_at before or after a given date.
    Possible values are \"gte\" (greater than or equal to) and \"lte\" (less than or equal to). The
    following example finds all incidents created before or on 2021-01-02:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'created_at[lte]=2021-01-02'

    ### By status category

    Find all incidents that are in a status category. Possible values are \"triage\",
    \"declined\", \"merged\", \"canceled\", \"live\", \"learning\" and \"closed\":

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status_category[one_of]=live'

    Or all incidents that are not in a status category:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status_category[not_in]=live'


    ### By severity

    With severity of id=ABC, find all incidents that are set to that severity:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[one_of]=ABC'

    Or all incidents where severity rank is greater-than-or-equal-to the rank of severity
    id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[gte]=ABC'

    Or all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[lte]=ABC'

    ### By incident type

    With incident type of id=ABC, find all incidents that are of that type:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_type[one_of]=ABC'

    Or all incidents not of that type:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_type[not_in]=ABC'

    ### By incident mode

    By default, we return standard and retrospective incidents. This means that test and
    tutorial incidents are filtered out. To override this behaviour, you can use the
    mode filter to specify which modes you want to get.

    To find incidents of all modes:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'mode[one_of]=standard&mode[one_of]=retrospective&mode[one_of]=test&mode[one_of]=tutorial'

    To find just test incidents:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'mode[one_of]=test'


    ### By incident role

    Roles and custom fields have another nested layer in the query parameter, to account for
    operations against any of the roles or custom fields created in the account.

    With incident role id=ABC, find all incidents where that role is unset:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_role[ABC][is_blank]=true'

    Or where the role has been set:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_role[ABC][is_blank]=false'

    ### By option custom fields

    With an option custom field id=ABC, all incidents that have field ABC set to the custom
    field option of id=XYZ:

    		curl \
    			--get 'https://api.incident.io/v2/incidents' \
    			--data 'custom_field[ABC][one_of]=XYZ'

    Or all incidents that do not have custom field id=ABC set to option id=XYZ:

    		curl \
    			--get 'https://api.incident.io/v2/incidents' \
    			--data 'custom_field[ABC][not_in]=XYZ'

    Args:
        page_size (Union[Unset, int]):  Default: 25.
        after (Union[Unset, str]):
        status (Union[Unset, Any]):
        status_category (Union[Unset, Any]):
        created_at (Union[Unset, Any]):
        severity (Union[Unset, Any]):
        incident_type (Union[Unset, Any]):
        incident_role (Union[Unset, Any]):
        custom_field (Union[Unset, Any]):
        mode (Union[Unset, Any]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        IncidentsV2ListResponseBody
     """

    return (
        await asyncio_detailed(
            client=client,
            page_size=page_size,
            after=after,
            status=status,
            status_category=status_category,
            created_at=created_at,
            severity=severity,
            incident_type=incident_type,
            incident_role=incident_role,
            custom_field=custom_field,
            mode=mode,
        )
    ).parsed

asyncio_detailed async 

asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
    status: Union[Unset, Any] = UNSET,
    status_category: Union[Unset, Any] = UNSET,
    created_at: Union[Unset, Any] = UNSET,
    severity: Union[Unset, Any] = UNSET,
    incident_type: Union[Unset, Any] = UNSET,
    incident_role: Union[Unset, Any] = UNSET,
    custom_field: Union[Unset, Any] = UNSET,
    mode: Union[Unset, Any] = UNSET
) -> Response[IncidentsV2ListResponseBody]

List Incidents V2

List all incidents for an organisation.

This endpoint supports a number of filters, which can help find incidents matching certain criteria.

Filters are provided as query parameters, but due to the dynamic nature of what you can query by (different accounts have different custom fields, statuses, etc) they are more complex than most.

To help, here are some exemplar curl requests with a human description of what they search for.

Note that: - Filters may be used together, and the result will be incidents that match all filters. - IDs are normally in UUID format, but have been replaced with shorter strings to improve readability. - All query parameters must be URI encoded.

By status

With status of id=ABC, find all incidents that are set to that status:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status[one_of]=ABC'

Or all incidents that are not set to status with id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status[not_in]=ABC'
By created_at

Find all incidents created_at before or after a given date. Possible values are \"gte\" (greater than or equal to) and \"lte\" (less than or equal to). The following example finds all incidents created before or on 2021-01-02:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'created_at[lte]=2021-01-02'
By status category

Find all incidents that are in a status category. Possible values are \"triage\", \"declined\", \"merged\", \"canceled\", \"live\", \"learning\" and \"closed\":

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status_category[one_of]=live'

Or all incidents that are not in a status category:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status_category[not_in]=live'
By severity

With severity of id=ABC, find all incidents that are set to that severity:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[one_of]=ABC'

Or all incidents where severity rank is greater-than-or-equal-to the rank of severity id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[gte]=ABC'

Or all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[lte]=ABC'
By incident type

With incident type of id=ABC, find all incidents that are of that type:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_type[one_of]=ABC'

Or all incidents not of that type:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_type[not_in]=ABC'
By incident mode

By default, we return standard and retrospective incidents. This means that test and tutorial incidents are filtered out. To override this behaviour, you can use the mode filter to specify which modes you want to get.

To find incidents of all modes:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'mode[one_of]=standard&mode[one_of]=retrospective&mode[one_of]=test&mode[one_of]=tutorial'

To find just test incidents:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'mode[one_of]=test'
By incident role

Roles and custom fields have another nested layer in the query parameter, to account for operations against any of the roles or custom fields created in the account.

With incident role id=ABC, find all incidents where that role is unset:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_role[ABC][is_blank]=true'

Or where the role has been set:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_role[ABC][is_blank]=false'
By option custom fields

With an option custom field id=ABC, all incidents that have field ABC set to the custom field option of id=XYZ:

        curl \
                --get 'https://api.incident.io/v2/incidents' \
                --data 'custom_field[ABC][one_of]=XYZ'

Or all incidents that do not have custom field id=ABC set to option id=XYZ:

        curl \
                --get 'https://api.incident.io/v2/incidents' \
                --data 'custom_field[ABC][not_in]=XYZ'

Parameters:

Name Type Description Default
page_size Union[Unset, int]

Default: 25.

 25
after Union[Unset, str]
UNSET
status Union[Unset, Any]
UNSET
status_category Union[Unset, Any]
UNSET
created_at Union[Unset, Any]
UNSET
severity Union[Unset, Any]
UNSET
incident_type Union[Unset, Any]
UNSET
incident_role Union[Unset, Any]
UNSET
custom_field Union[Unset, Any]
UNSET
mode Union[Unset, Any]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[IncidentsV2ListResponseBody]

Response[IncidentsV2ListResponseBody]
Source code in incident_io_client/api/incidents_v2/incidents_v2_list.py 
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
    status: Union[Unset, Any] = UNSET,
    status_category: Union[Unset, Any] = UNSET,
    created_at: Union[Unset, Any] = UNSET,
    severity: Union[Unset, Any] = UNSET,
    incident_type: Union[Unset, Any] = UNSET,
    incident_role: Union[Unset, Any] = UNSET,
    custom_field: Union[Unset, Any] = UNSET,
    mode: Union[Unset, Any] = UNSET,
) -> Response[IncidentsV2ListResponseBody]:
    r""" List Incidents V2

     List all incidents for an organisation.

    This endpoint supports a number of filters, which can help find incidents matching certain
    criteria.

    Filters are provided as query parameters, but due to the dynamic nature of what you can
    query by (different accounts have different custom fields, statuses, etc) they are more
    complex than most.

    To help, here are some exemplar curl requests with a human description of what they search
    for.

    Note that:
    - Filters may be used together, and the result will be incidents that match all filters.
    - IDs are normally in UUID format, but have been replaced with shorter strings to improve
    readability.
    - All query parameters must be URI encoded.

    ### By status

    With status of id=ABC, find all incidents that are set to that status:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status[one_of]=ABC'

    Or all incidents that are not set to status with id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status[not_in]=ABC'

    ### By created_at

    Find all incidents created_at before or after a given date.
    Possible values are \"gte\" (greater than or equal to) and \"lte\" (less than or equal to). The
    following example finds all incidents created before or on 2021-01-02:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'created_at[lte]=2021-01-02'

    ### By status category

    Find all incidents that are in a status category. Possible values are \"triage\",
    \"declined\", \"merged\", \"canceled\", \"live\", \"learning\" and \"closed\":

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status_category[one_of]=live'

    Or all incidents that are not in a status category:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status_category[not_in]=live'


    ### By severity

    With severity of id=ABC, find all incidents that are set to that severity:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[one_of]=ABC'

    Or all incidents where severity rank is greater-than-or-equal-to the rank of severity
    id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[gte]=ABC'

    Or all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[lte]=ABC'

    ### By incident type

    With incident type of id=ABC, find all incidents that are of that type:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_type[one_of]=ABC'

    Or all incidents not of that type:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_type[not_in]=ABC'

    ### By incident mode

    By default, we return standard and retrospective incidents. This means that test and
    tutorial incidents are filtered out. To override this behaviour, you can use the
    mode filter to specify which modes you want to get.

    To find incidents of all modes:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'mode[one_of]=standard&mode[one_of]=retrospective&mode[one_of]=test&mode[one_of]=tutorial'

    To find just test incidents:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'mode[one_of]=test'


    ### By incident role

    Roles and custom fields have another nested layer in the query parameter, to account for
    operations against any of the roles or custom fields created in the account.

    With incident role id=ABC, find all incidents where that role is unset:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_role[ABC][is_blank]=true'

    Or where the role has been set:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_role[ABC][is_blank]=false'

    ### By option custom fields

    With an option custom field id=ABC, all incidents that have field ABC set to the custom
    field option of id=XYZ:

    		curl \
    			--get 'https://api.incident.io/v2/incidents' \
    			--data 'custom_field[ABC][one_of]=XYZ'

    Or all incidents that do not have custom field id=ABC set to option id=XYZ:

    		curl \
    			--get 'https://api.incident.io/v2/incidents' \
    			--data 'custom_field[ABC][not_in]=XYZ'

    Args:
        page_size (Union[Unset, int]):  Default: 25.
        after (Union[Unset, str]):
        status (Union[Unset, Any]):
        status_category (Union[Unset, Any]):
        created_at (Union[Unset, Any]):
        severity (Union[Unset, Any]):
        incident_type (Union[Unset, Any]):
        incident_role (Union[Unset, Any]):
        custom_field (Union[Unset, Any]):
        mode (Union[Unset, Any]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[IncidentsV2ListResponseBody]
     """

    kwargs = _get_kwargs(
        page_size=page_size,
        after=after,
        status=status,
        status_category=status_category,
        created_at=created_at,
        severity=severity,
        incident_type=incident_type,
        incident_role=incident_role,
        custom_field=custom_field,
        mode=mode,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync 

sync(
    *,
    client: Union[AuthenticatedClient, Client],
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
    status: Union[Unset, Any] = UNSET,
    status_category: Union[Unset, Any] = UNSET,
    created_at: Union[Unset, Any] = UNSET,
    severity: Union[Unset, Any] = UNSET,
    incident_type: Union[Unset, Any] = UNSET,
    incident_role: Union[Unset, Any] = UNSET,
    custom_field: Union[Unset, Any] = UNSET,
    mode: Union[Unset, Any] = UNSET
) -> Optional[IncidentsV2ListResponseBody]

List Incidents V2

List all incidents for an organisation.

This endpoint supports a number of filters, which can help find incidents matching certain criteria.

Filters are provided as query parameters, but due to the dynamic nature of what you can query by (different accounts have different custom fields, statuses, etc) they are more complex than most.

To help, here are some exemplar curl requests with a human description of what they search for.

Note that: - Filters may be used together, and the result will be incidents that match all filters. - IDs are normally in UUID format, but have been replaced with shorter strings to improve readability. - All query parameters must be URI encoded.

By status

With status of id=ABC, find all incidents that are set to that status:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status[one_of]=ABC'

Or all incidents that are not set to status with id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status[not_in]=ABC'
By created_at

Find all incidents created_at before or after a given date. Possible values are \"gte\" (greater than or equal to) and \"lte\" (less than or equal to). The following example finds all incidents created before or on 2021-01-02:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'created_at[lte]=2021-01-02'
By status category

Find all incidents that are in a status category. Possible values are \"triage\", \"declined\", \"merged\", \"canceled\", \"live\", \"learning\" and \"closed\":

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status_category[one_of]=live'

Or all incidents that are not in a status category:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status_category[not_in]=live'
By severity

With severity of id=ABC, find all incidents that are set to that severity:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[one_of]=ABC'

Or all incidents where severity rank is greater-than-or-equal-to the rank of severity id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[gte]=ABC'

Or all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[lte]=ABC'
By incident type

With incident type of id=ABC, find all incidents that are of that type:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_type[one_of]=ABC'

Or all incidents not of that type:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_type[not_in]=ABC'
By incident mode

By default, we return standard and retrospective incidents. This means that test and tutorial incidents are filtered out. To override this behaviour, you can use the mode filter to specify which modes you want to get.

To find incidents of all modes:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'mode[one_of]=standard&mode[one_of]=retrospective&mode[one_of]=test&mode[one_of]=tutorial'

To find just test incidents:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'mode[one_of]=test'
By incident role

Roles and custom fields have another nested layer in the query parameter, to account for operations against any of the roles or custom fields created in the account.

With incident role id=ABC, find all incidents where that role is unset:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_role[ABC][is_blank]=true'

Or where the role has been set:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_role[ABC][is_blank]=false'
By option custom fields

With an option custom field id=ABC, all incidents that have field ABC set to the custom field option of id=XYZ:

        curl \
                --get 'https://api.incident.io/v2/incidents' \
                --data 'custom_field[ABC][one_of]=XYZ'

Or all incidents that do not have custom field id=ABC set to option id=XYZ:

        curl \
                --get 'https://api.incident.io/v2/incidents' \
                --data 'custom_field[ABC][not_in]=XYZ'

Parameters:

Name Type Description Default
page_size Union[Unset, int]

Default: 25.

 25
after Union[Unset, str]
UNSET
status Union[Unset, Any]
UNSET
status_category Union[Unset, Any]
UNSET
created_at Union[Unset, Any]
UNSET
severity Union[Unset, Any]
UNSET
incident_type Union[Unset, Any]
UNSET
incident_role Union[Unset, Any]
UNSET
custom_field Union[Unset, Any]
UNSET
mode Union[Unset, Any]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[IncidentsV2ListResponseBody]

IncidentsV2ListResponseBody
Source code in incident_io_client/api/incidents_v2/incidents_v2_list.py 
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
    status: Union[Unset, Any] = UNSET,
    status_category: Union[Unset, Any] = UNSET,
    created_at: Union[Unset, Any] = UNSET,
    severity: Union[Unset, Any] = UNSET,
    incident_type: Union[Unset, Any] = UNSET,
    incident_role: Union[Unset, Any] = UNSET,
    custom_field: Union[Unset, Any] = UNSET,
    mode: Union[Unset, Any] = UNSET,
) -> Optional[IncidentsV2ListResponseBody]:
    r""" List Incidents V2

     List all incidents for an organisation.

    This endpoint supports a number of filters, which can help find incidents matching certain
    criteria.

    Filters are provided as query parameters, but due to the dynamic nature of what you can
    query by (different accounts have different custom fields, statuses, etc) they are more
    complex than most.

    To help, here are some exemplar curl requests with a human description of what they search
    for.

    Note that:
    - Filters may be used together, and the result will be incidents that match all filters.
    - IDs are normally in UUID format, but have been replaced with shorter strings to improve
    readability.
    - All query parameters must be URI encoded.

    ### By status

    With status of id=ABC, find all incidents that are set to that status:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status[one_of]=ABC'

    Or all incidents that are not set to status with id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status[not_in]=ABC'

    ### By created_at

    Find all incidents created_at before or after a given date.
    Possible values are \"gte\" (greater than or equal to) and \"lte\" (less than or equal to). The
    following example finds all incidents created before or on 2021-01-02:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'created_at[lte]=2021-01-02'

    ### By status category

    Find all incidents that are in a status category. Possible values are \"triage\",
    \"declined\", \"merged\", \"canceled\", \"live\", \"learning\" and \"closed\":

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status_category[one_of]=live'

    Or all incidents that are not in a status category:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status_category[not_in]=live'


    ### By severity

    With severity of id=ABC, find all incidents that are set to that severity:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[one_of]=ABC'

    Or all incidents where severity rank is greater-than-or-equal-to the rank of severity
    id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[gte]=ABC'

    Or all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[lte]=ABC'

    ### By incident type

    With incident type of id=ABC, find all incidents that are of that type:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_type[one_of]=ABC'

    Or all incidents not of that type:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_type[not_in]=ABC'

    ### By incident mode

    By default, we return standard and retrospective incidents. This means that test and
    tutorial incidents are filtered out. To override this behaviour, you can use the
    mode filter to specify which modes you want to get.

    To find incidents of all modes:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'mode[one_of]=standard&mode[one_of]=retrospective&mode[one_of]=test&mode[one_of]=tutorial'

    To find just test incidents:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'mode[one_of]=test'


    ### By incident role

    Roles and custom fields have another nested layer in the query parameter, to account for
    operations against any of the roles or custom fields created in the account.

    With incident role id=ABC, find all incidents where that role is unset:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_role[ABC][is_blank]=true'

    Or where the role has been set:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_role[ABC][is_blank]=false'

    ### By option custom fields

    With an option custom field id=ABC, all incidents that have field ABC set to the custom
    field option of id=XYZ:

    		curl \
    			--get 'https://api.incident.io/v2/incidents' \
    			--data 'custom_field[ABC][one_of]=XYZ'

    Or all incidents that do not have custom field id=ABC set to option id=XYZ:

    		curl \
    			--get 'https://api.incident.io/v2/incidents' \
    			--data 'custom_field[ABC][not_in]=XYZ'

    Args:
        page_size (Union[Unset, int]):  Default: 25.
        after (Union[Unset, str]):
        status (Union[Unset, Any]):
        status_category (Union[Unset, Any]):
        created_at (Union[Unset, Any]):
        severity (Union[Unset, Any]):
        incident_type (Union[Unset, Any]):
        incident_role (Union[Unset, Any]):
        custom_field (Union[Unset, Any]):
        mode (Union[Unset, Any]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        IncidentsV2ListResponseBody
     """

    return sync_detailed(
        client=client,
        page_size=page_size,
        after=after,
        status=status,
        status_category=status_category,
        created_at=created_at,
        severity=severity,
        incident_type=incident_type,
        incident_role=incident_role,
        custom_field=custom_field,
        mode=mode,
    ).parsed

sync_detailed 

sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
    status: Union[Unset, Any] = UNSET,
    status_category: Union[Unset, Any] = UNSET,
    created_at: Union[Unset, Any] = UNSET,
    severity: Union[Unset, Any] = UNSET,
    incident_type: Union[Unset, Any] = UNSET,
    incident_role: Union[Unset, Any] = UNSET,
    custom_field: Union[Unset, Any] = UNSET,
    mode: Union[Unset, Any] = UNSET
) -> Response[IncidentsV2ListResponseBody]

List Incidents V2

List all incidents for an organisation.

This endpoint supports a number of filters, which can help find incidents matching certain criteria.

Filters are provided as query parameters, but due to the dynamic nature of what you can query by (different accounts have different custom fields, statuses, etc) they are more complex than most.

To help, here are some exemplar curl requests with a human description of what they search for.

Note that: - Filters may be used together, and the result will be incidents that match all filters. - IDs are normally in UUID format, but have been replaced with shorter strings to improve readability. - All query parameters must be URI encoded.

By status

With status of id=ABC, find all incidents that are set to that status:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status[one_of]=ABC'

Or all incidents that are not set to status with id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status[not_in]=ABC'
By created_at

Find all incidents created_at before or after a given date. Possible values are \"gte\" (greater than or equal to) and \"lte\" (less than or equal to). The following example finds all incidents created before or on 2021-01-02:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'created_at[lte]=2021-01-02'
By status category

Find all incidents that are in a status category. Possible values are \"triage\", \"declined\", \"merged\", \"canceled\", \"live\", \"learning\" and \"closed\":

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status_category[one_of]=live'

Or all incidents that are not in a status category:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'status_category[not_in]=live'
By severity

With severity of id=ABC, find all incidents that are set to that severity:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[one_of]=ABC'

Or all incidents where severity rank is greater-than-or-equal-to the rank of severity id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[gte]=ABC'

Or all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'severity[lte]=ABC'
By incident type

With incident type of id=ABC, find all incidents that are of that type:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_type[one_of]=ABC'

Or all incidents not of that type:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_type[not_in]=ABC'
By incident mode

By default, we return standard and retrospective incidents. This means that test and tutorial incidents are filtered out. To override this behaviour, you can use the mode filter to specify which modes you want to get.

To find incidents of all modes:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'mode[one_of]=standard&mode[one_of]=retrospective&mode[one_of]=test&mode[one_of]=tutorial'

To find just test incidents:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'mode[one_of]=test'
By incident role

Roles and custom fields have another nested layer in the query parameter, to account for operations against any of the roles or custom fields created in the account.

With incident role id=ABC, find all incidents where that role is unset:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_role[ABC][is_blank]=true'

Or where the role has been set:

        curl --get 'https://api.incident.io/v2/incidents' \
                --data 'incident_role[ABC][is_blank]=false'
By option custom fields

With an option custom field id=ABC, all incidents that have field ABC set to the custom field option of id=XYZ:

        curl \
                --get 'https://api.incident.io/v2/incidents' \
                --data 'custom_field[ABC][one_of]=XYZ'

Or all incidents that do not have custom field id=ABC set to option id=XYZ:

        curl \
                --get 'https://api.incident.io/v2/incidents' \
                --data 'custom_field[ABC][not_in]=XYZ'

Parameters:

Name Type Description Default
page_size Union[Unset, int]

Default: 25.

 25
after Union[Unset, str]
UNSET
status Union[Unset, Any]
UNSET
status_category Union[Unset, Any]
UNSET
created_at Union[Unset, Any]
UNSET
severity Union[Unset, Any]
UNSET
incident_type Union[Unset, Any]
UNSET
incident_role Union[Unset, Any]
UNSET
custom_field Union[Unset, Any]
UNSET
mode Union[Unset, Any]
UNSET

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[IncidentsV2ListResponseBody]

Response[IncidentsV2ListResponseBody]
Source code in incident_io_client/api/incidents_v2/incidents_v2_list.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
    page_size: Union[Unset, int] = 25,
    after: Union[Unset, str] = UNSET,
    status: Union[Unset, Any] = UNSET,
    status_category: Union[Unset, Any] = UNSET,
    created_at: Union[Unset, Any] = UNSET,
    severity: Union[Unset, Any] = UNSET,
    incident_type: Union[Unset, Any] = UNSET,
    incident_role: Union[Unset, Any] = UNSET,
    custom_field: Union[Unset, Any] = UNSET,
    mode: Union[Unset, Any] = UNSET,
) -> Response[IncidentsV2ListResponseBody]:
    r""" List Incidents V2

     List all incidents for an organisation.

    This endpoint supports a number of filters, which can help find incidents matching certain
    criteria.

    Filters are provided as query parameters, but due to the dynamic nature of what you can
    query by (different accounts have different custom fields, statuses, etc) they are more
    complex than most.

    To help, here are some exemplar curl requests with a human description of what they search
    for.

    Note that:
    - Filters may be used together, and the result will be incidents that match all filters.
    - IDs are normally in UUID format, but have been replaced with shorter strings to improve
    readability.
    - All query parameters must be URI encoded.

    ### By status

    With status of id=ABC, find all incidents that are set to that status:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status[one_of]=ABC'

    Or all incidents that are not set to status with id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status[not_in]=ABC'

    ### By created_at

    Find all incidents created_at before or after a given date.
    Possible values are \"gte\" (greater than or equal to) and \"lte\" (less than or equal to). The
    following example finds all incidents created before or on 2021-01-02:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'created_at[lte]=2021-01-02'

    ### By status category

    Find all incidents that are in a status category. Possible values are \"triage\",
    \"declined\", \"merged\", \"canceled\", \"live\", \"learning\" and \"closed\":

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status_category[one_of]=live'

    Or all incidents that are not in a status category:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'status_category[not_in]=live'


    ### By severity

    With severity of id=ABC, find all incidents that are set to that severity:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[one_of]=ABC'

    Or all incidents where severity rank is greater-than-or-equal-to the rank of severity
    id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[gte]=ABC'

    Or all incidents where severity rank is less-than-or-equal-to the rank of severity id=ABC:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'severity[lte]=ABC'

    ### By incident type

    With incident type of id=ABC, find all incidents that are of that type:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_type[one_of]=ABC'

    Or all incidents not of that type:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_type[not_in]=ABC'

    ### By incident mode

    By default, we return standard and retrospective incidents. This means that test and
    tutorial incidents are filtered out. To override this behaviour, you can use the
    mode filter to specify which modes you want to get.

    To find incidents of all modes:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'mode[one_of]=standard&mode[one_of]=retrospective&mode[one_of]=test&mode[one_of]=tutorial'

    To find just test incidents:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'mode[one_of]=test'


    ### By incident role

    Roles and custom fields have another nested layer in the query parameter, to account for
    operations against any of the roles or custom fields created in the account.

    With incident role id=ABC, find all incidents where that role is unset:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_role[ABC][is_blank]=true'

    Or where the role has been set:

    		curl --get 'https://api.incident.io/v2/incidents' \
    			--data 'incident_role[ABC][is_blank]=false'

    ### By option custom fields

    With an option custom field id=ABC, all incidents that have field ABC set to the custom
    field option of id=XYZ:

    		curl \
    			--get 'https://api.incident.io/v2/incidents' \
    			--data 'custom_field[ABC][one_of]=XYZ'

    Or all incidents that do not have custom field id=ABC set to option id=XYZ:

    		curl \
    			--get 'https://api.incident.io/v2/incidents' \
    			--data 'custom_field[ABC][not_in]=XYZ'

    Args:
        page_size (Union[Unset, int]):  Default: 25.
        after (Union[Unset, str]):
        status (Union[Unset, Any]):
        status_category (Union[Unset, Any]):
        created_at (Union[Unset, Any]):
        severity (Union[Unset, Any]):
        incident_type (Union[Unset, Any]):
        incident_role (Union[Unset, Any]):
        custom_field (Union[Unset, Any]):
        mode (Union[Unset, Any]):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[IncidentsV2ListResponseBody]
     """

    kwargs = _get_kwargs(
        page_size=page_size,
        after=after,
        status=status,
        status_category=status_category,
        created_at=created_at,
        severity=severity,
        incident_type=incident_type,
        incident_role=incident_role,
        custom_field=custom_field,
        mode=mode,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)