Skip to main content
GET
Get Invitation List

Authorizations

Authorization
string
header
required

OAuth 2.0 bearer token obtained from POST /oauth2/token. Tokens expire after 30 minutes. Include in the Authorization header as Bearer {access_token}.

Path Parameters

invitation_list_id
integer
required

integer - required - The ID of the invitation list

Example:

34

Query Parameters

fields
string

string - optional - Comma separated list of fields you want to return (e.g., 'id,name,notes')

Example:

"id,name"

expand
string

string - optional - Comma separated list of related objects to include

Example:

""

Response

Detail

id
integer
Example:

34

name
string
Example:

"test list update"

notes
string

Only included when fields parameter includes 'notes'

Example:

"random notes"

module
string | null

The module type ('main' or 'cfs') - only included when fields parameter includes 'module'

Example:

"main"

reg_type_id
integer | null

Only included when fields parameter includes 'reg_type_id'

Example:

null

package_id
integer | null

Only included when fields parameter includes 'package_id'

Example:

null

cfs_role_id
integer | null

Only included when fields parameter includes 'cfs_role_id'

Example:

null

created_at
string

Only included when fields parameter includes 'created_at'

Example:

"2025-10-06 20:49:50"

updated_at
string

Only included when fields parameter includes 'updated_at'

Example:

"2025-10-06 21:10:41"