Skip to main content

List invites

GET https://www.digicert.com/services/v2/account/subaccount/invite

Use this endpoint to list all subaccount invites.

Example requests and responses

Filters and URL query parameters

This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see Services API – Filters, sorting, and pagination parameters.

Name

Req/Opt

Type

Description

filters[{{property_name}}]

optional

string

Filters results by the specified property.

Replace {{property_name}} in your request with the property to use for filtering. This endpoint supports filtering by the following properties:

  • filters[email]

  • filters[subaccount_type]: See Glossary – Subaccount types.

  • filters[date_created]

  • filters[last_sent_date]

  • filters[status]: Use accepted, expired, or cancelled.

filters[search]

optional

string

Limits response to results where the value of the email property matches or contains a specific string of characters.

To search for values that contain a specific string of characters, prefix the string with a URL encoded (percent-encoded) % character: %25. To search for values that are an exact match for a string of characters, omit the %25 from the request.

Examples:

  • filters[search]=%25gmail

    Limits response to results where the value of a searched property contains the string gmail

  • filters[search]=myname@gmail.com

    Limits response to results where the value of a searched property is an exact match for the string myname@gmail.com.

sort

optional

string

Sorts results by the value of one or more properties.

By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus (-).

To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list.

This endpoint supports sorting by the following properties:

  • id

  • email

  • subaccount_type

  • invite_note

  • date_created

  • last_sent_date

  • status

  • firstname

  • lastname

offset

optional

int

Index of the first result to include in the response.

Default: 0

limit

optional

int

Total number of results to include in the response.

Max: 1000 (default)

Response parameters

Name

Type

Description

subaccount_invites

array

List of subaccount invites.

.. id

int

Invitation ID.

.. email

string

Email address where the invitation was sent.

.. subaccount_type

string

Defines the subaccount type. See Glossary – Subaccount types

.. invite_note

string

Custom invitation message sent with the invite.

.. date_created

string

Date the invite was first sent.

Format: yyyy-MM-dd HH:mm:ss

.. last_sent_date

string

Date the invite was last resent.

Format: yyyy-MM-dd HH:mm:ss

.. status

string

Status of the invitation.

Possible values: accepted, pending, canceled, expired

page

object

Details about results. Modified using URL query strings.