Skip to main content

Identity Summaries for Campaign Certification

GET 

/certifications/:id/identity-summaries

This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API.

Request

Path Parameters

    id stringrequired

    The identity campaign certification ID

    Example: ef38f94347e94562b5bb8424a56397d8

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq, in

    completed: eq, ne

    name: eq, sw

    Example: id eq "ef38f94347e94562b5bb8424a56397d8"
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: name

    Example: name

Responses

List of identity summaries

Schema

  • Array [

  • id string

    The ID of the identity summary

    name string

    Name of the linked identity

    identityId string

    The ID of the identity being certified

    completed boolean

    Indicates whether the review items for the linked identity's certification have been completed

  • ]

Loading...