Exploring the Graviti api

The overview of Graviti api fundamental sections

Unlock the potential for effective membership management and customization through Graviti api

The Graviti API endpoints includes the following sections:

Connect

The endpoints enable administrators to manage and create content that is accessible to members. This content can include articles, videos, tutorials, webinars, courses, and other digital resources. By offering valuable content, the membership becomes more valuable and keeps members engaged, leading to increased loyalty and satisfaction. Furthermore, the endpoints provide a way to generate revenue by offering premium content to members and charging for access to it.

Members

The endpoints focus on the management and registration of members through the Graviti Admin interface.

Organization

The endpoints allow for effective management and customization of the membership system. Administrators can customize various system settings and configurations that impact the functionality and behaviour of the membership system.

Next | Get api v1 connect announcements

Related topics

Get api v1 connect announcements

Get a list of all announcements

GET/api/v1/Connect/announcements

Get a list of announcements that are available on the administration portal, draft, published and unpublished announcements.

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Announcement Status Id	Integer
Key	String
Page Size	Integer
Page	Integer
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{

"totalItems": 0,

"pageNumber": 0,

"pageSize": 0,

"data": [

{

"id": "string",

"isActive": true,

"title": "string",

"description": "string",

"organizationId": "string",

"accessTypeId": 0,

"expiresAfterDays": 0,

"announcementStatusId": 0,

"created": "2023-12-06T11:23:03.221Z",

"updated": "2023-12-06T11:23:03.221Z",

"user": "string",

"accessType": "string",

"announcementStatus": "string",

"active": "string"

}

"totalPages": 0,

"hasPreviousPage": true,

"hasNextPage": true,

"nextPageNumber": 0,

"previousPageNumber": 0

}

Field	Type	Description
Id	String	Internal ID to identify announcement
Is active	Boolean	indication if the announcement is active or inactive
Title	String	Title of the announcement
Description	String	Description of the announcement
Organization	String	Name of the organization
Access type id	Integer	Access type id to identify announcement access
Expires after days	Integer	The number of days which the announcement is valid for
Announcement status id	Integer	Announcement status ID to identify announcement status
Created	Datetime	Datetime when the announcement was created in the system
Updated	Datetime	Datetime when the announcement was last updated.
User	String	The name of the person who wrote the announcement
Access type	String	Announcement access type
Announcement status	String	Status of the announcement: draft, published, unpublished)
Active	String	indication if the announcement is active or inactive

Previous | The overview of Graviti api fundamental sections

Next | Get api v1 connect announcements by id

Related topics

Get Api V1 Connect Announcements By Id

Get api v1 connect announcements by id

Get an announcement by its identification number

GET/api/v1/Connect/announcements/{id}

Get an announcement by its identification number

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{

"id": "string",

"isActive": true,

"title": "string",

"description": "string",

"organizationId": "string",

"accessTypeId": 0,

"expiresAfterDays": 0,

"announcementStatusId": 0,

"created": "2023-12-06T11:23:03.221Z",

"updated": "2023-12-06T11:23:03.221Z",

"user": "string",

"accessType": "string",

"announcementStatus": "string",

"active": "string"

}

Field	Type	Description
Id	String	Internal ID to identify announcement
Is active	Boolean	indication if the announcement is active or inactive
Title	String	Title of the announcement
Description	String	Description of the announcement
Organization	String	Name of the organization
Access type id	Integer	Access type id to identify announcement access
Expires after days	Integer	The number of days which the announcement is valid for
Announcement status id	Integer	Announcement status ID to identify announcement status
Created	Datetime	Datetime when the announcement was created in the system
Updated	Datetime	Datetime when the announcement was last updated.
User	String	The name of the person who wrote the announcement
Access type	String	Announcement access type
Announcement tatus	String	Status of the announcement: draft, published, unpublished)
Active	String	indication if the announcement is active or inactive

Previous | Get api v1 connect announcements

Next | Get api v1 connect components

Related topics

Get Api V1 Connect Announcements

Get api v1 connect components

Get a list of components that are available on the administration portal

GET/api/v1/Connect/components

Get a list of components that are available on the administration portal.

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Access Type Id	Integer
Content Source Type Id	Integer
Key	String
Entity Id	String
Page size	Integer
Page	Integer
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{

"totalItems": 0,

"pageNumber": 0,

"pageSize": 0,

"data": [

{

"id": "string",

"name": "string",

"title": "string",

"contentSource": "string",

"displayOrder": 0,

"orgnizationId": "string",

"accessTypeId": 0,

"created": "2023-12-06T11:23:03.221Z",

"updated": "2023-12-06T11:23:03.221Z",

"user": "string",

"contentSourceTypeId": 0,

"accessType": "string",

"contentSourceType": "string"

}

"totalPages": 0,

"hasPreviousPage": true,

"hasNextPage": true,

"nextPageNumber": 0,

"previousPageNumber": 0

}

Field	Type	Description
Id	String	Internal ID to identify announcement
Name	Boolean	The name of the component
Title	String	Title of the component
Content Source	String	The content source of the component
Display order	integer	The display order of the component
Organization id	String	Id to identify the organization
Access type id	Integer	Access type id to identify component access type
Created	Datetime	Datetime when the component was created in the system
Updated	Datetime	Datetime when the component was last updated.
User	String	The name of the person who wrote the component
Content source type id	Integer	The content source type id of the component
Access type	String	component access type
Content source type	String	The content source type of the component

Previous | Get api v1 connect announcements by id

Next | Get api v1 connect components by id

Related topics

Get Api V1 Connect Components By Id

Get api v1 connect components by id

Get a component by its identification number

GET/api/v1/Connect/components/{id}

Get a component by its identification number

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{

"id": "string",

"name": "string",

"title": "string",

"contentSource": "string",

"displayOrder": 0,

"orgnizationId": "string",

"accessTypeId": 0,

"created": "2023-12-06T11:23:03.221Z",

"updated": "2023-12-06T11:23:03.221Z",

"user": "string",

"contentSourceTypeId": 0,

"accessType": "string",

"contentSourceType": "string"

}

Field	Type	Description
Id	String	Internal ID to identify announcement
Name	Boolean	The name of the component
Title	String	Title of the component
Content Source	String	The content source of the component
Display order	Integer	The display order of the component
Organization id	String	Id to identify the organization
Access type id	Integer	Access type id to identify component access
Created	Datetime	Datetime when the component was created in the system
Updated	Datetime	Datetime when the component was last updated.
User	String	The name of the person who wrote the component
Content source type id	Integer	The content source type id of the component
Access type	String	Component access type
Content source type	String	The content source type of the component

Previous | Get api v1 connect components

Next | Get api v1 members

Related topics

Get Api V1 Connect Components

Get api v1 members

Get a list of members available on the administration portal

GET/api/v1/Members

Get a list of members that are available on the administration portal

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Membership Status Id	Integer
Active Only	Boolean
Member Group Id	String
Chapter Id	String
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "membership": {
        "id": "string",
        "created": "2023-12-08T07:22:50.509Z",
        "firstName": "string",
        "memberId": "string",
        "gender": "string",
        "genderId": 0,
        "identificationNumber": "string",
        "identificationType": "string",
        "identificationTypeId": 0,
        "isActive": true,
        "knownAs": "string",
        "lastName": "string",
        "middleName": "string",
        "pictureUrl": "string",
        "race": "string",
        "raceId": 0,
        "updated": "2023-12-08T07:22:50.509Z",
        "userIdentifier": "string",
        "organizationId": "string",
        "accountNumber": "string",
        "dateJoined": "2023-12-08T07:22:50.509Z",
        "startDate": "2023-12-08T07:22:50.509Z",
        "endDate": "2023-12-08T07:22:50.509Z",
        "group": "string",
        "membershipNumber": "string",
        "professionalNumber": "string",
        "membershipStatusId": 0,
        "membershipStatus": "string"
      },
      "memberContacts": [
        {
          "contactType": "string",
          "contactTypeId": 0,
          "created": "2023-12-08T07:22:50.509Z",
          "id": "string",
          "member": "string",
          "memberId": "string",
          "organization": "string",
          "organizationId": "string",
          "memberOrganizationId": "string",
          "updated": "2023-12-08T07:22:50.509Z",
          "value": "string",
          "usageTypeId": 0,
          "usageType": "string"
        }
      ],
      "memberAddresses": [
        {
          "addressLine1": "string",
          "addressLine2": "string",
          "addressLine3": "string",
          "addressLine4": "string",
          "addressType": "string",
          "addressTypeId": 0,
          "code": "string",
          "created": "2023-12-08T07:22:50.509Z",
          "id": "string",
          "member": "string",
          "memberId": "string",
          "organization": "string",
          "organizationId": "string",
          "memberOrganizationId": "string",
          "countryId": "string",
          "country": "string",
          "region": "string",
          "usageTypeId": 0,
          "usageType": "string",
          "updated": "2023-12-08T07:22:50.509Z"
        }
      ],
      "memberDocuments": [
        {
          "created": "2023-12-08T07:22:50.509Z",
          "documentUrl": "string",
          "title": "string",
          "id": "string",
          "member": "string",
          "memberId": "string",
          "memberOrganizationId": "string",
          "organizationId": "string",
          "documentType": "string",
          "documentTypeId": "string",
          "updated": "2023-12-08T07:22:50.509Z",
          "uploadedBy": "string"
        }
      ],
      "memberNotes": [
        {
          "id": "string",
          "note": "string",
          "memberOrganizationId": "string",
          "author": "string",
          "tags": "string",
          "user": "string",
          "isActive": true,
          "created": "2023-12-08T07:22:50.509Z",
          "updated": "2023-12-08T07:22:50.509Z"
        }
      ],
      "memberEmployments": [
        {
          "id": "string",
          "employerName": "string",
          "employerTypeId": "string",
          "position": "string",
          "startDate": "2023-12-08T07:22:50.509Z",
          "endDate": "2023-12-08T07:22:50.509Z",
          "contactPerson": "string",
          "memberOrganizationId": "string",
          "created": "2023-12-08T07:22:50.509Z",
          "updated": "2023-12-08T07:22:50.509Z",
          "user": "string",
          "employerType": "string"
        }
      ]
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Membership
Id	String	Internal ID to identify member
Created	Datetime	Datetime when the member record was created in the system
First name	String	First name of a member
Member id	String	Member identification number to identify member
Gender	String	Gender of a member
Gender id	Integer	Gender identification number to identify member gender type
Identification number	String	Identification number of a member
Identification type	String	Identification type of a member
Identification type id	Integer	Identification type id to identify member ID type
Is active	Boolean	Status of the member profile
Known as	String	Another name of a member
Last name	String	Last name of a member
Middle name	String	middle name of a member
Picture url	String	Picture url of a member
Race	String	Race of a member
Race id	Integer	Race identification number to identify member’s race
Updated	Datetime	Datetime when the member record was last updated.
User identifier	String	Email address of a member
Organization id	String	Organization id to identify the organization the member belongs to
Account number	String	Account number assigned to the member
Date joined	Datetime	Datetime when the member join the organization. While often the same as 'created', these values can be adjusted by admins or backdated during import.
Start date	Datetime	Datetime when the member started with the organization
End date	Datetime	Datetime when a membership is set to expire (can be null for lifetime or automatically re-billing Memberships)
Group	String	Group the member belongs to
Membership number	String	Membership number assigned to the member for identification
Membership status id	Integer	Membership number id to identify the membership number
Membership status	String	The membership status of the member profile
Member contacts
Contact type	String	Contact type of the member contact
Contact type id	Integer	Contact type Id of the contact type
Created	Datetime	Datetime when the member contact record was created in the system
Id	String	Internal ID to identify member contacts
Member	String	The name of the member
Member id	String	The member id number to identify the member
Organization	String	The name of the organization the member belongs to
Organization id	String	The organization id number to identify the organization
Updated	Datetime	Datetime when the member contact record was last updated.
Value	String	The value of the contact
Usage type id	Integer	The contact usage type id
Usage type	String	The contact usage type
Member addresses
Address line 1	String	Complex name
Address line 2	String	Street address
Address line 3	String	Suburb
Address line 4	String	Town or city
Address type	String	Address type
Address line type id	Integer	Address line type id
Code	String	Address code
Created	Datetime	Datetime when the member address record was created in the system
Id	String	Address id to identify the address
Member	String	Name of the member
Member id	String	The member id number to identify the member
Organization	String	The name of the organization the member belongs to
Organization id	String	The organization id number to identify the organization
Member organization id	String	Member organization id to identify the member
Country id	String	Country id to identify the country
Country	String	Name of the country
Region	String	Region in the country
Usage type id	Integer	Usage type id to identify the address
Usage type	String	Usage type of the address
Updated	Datetime	Datetime when the member address record was last updated.
Member documents
Created	Datetime	Datetime when the member document record was created in the system
Document url	String	Member document link
Title	String	Member document title
Id	String	Document id to identify the document
Member	String	Name of the member
Member id	String	Member id to identify the member
Member organization id	String	Member organization id to identify the member
Organization id	String	Id to identify the organization
Document type	String	Member document type
Document type id	String	Document type id to identify the document
Updated	Datetime	Datetime when the member document record was last updated.
Uploaded by	String	Name of the person who uploaded the record
Member notes
Id	String	Member notes id to identify the notes
Note	String	The note content
Member organization id	String	Member organization id to identify the member
Author	String	Note author
Tags	String	Note tags
User	String	Note user
Is active	Boolean	Indication whether the note is active or not
Created	Datetime	Datetime when the member note record was created in the system
Updated	Datetime	Datetime when the member note record was last updated.
Member employments
Id	String	Member employment record id to identify the employment record
Employer name	String	Name of the employer
Employer type id	String	Employer type id to identify the employer type
Position	String	Position held by the employer
Start date	Datetime	Datetime when a member’s employment period started
End date	Datetime	Datetime when a member’s employment ended
Contact person	String	Contact person
Member organization id	String	Member organization id to identify the member
Created	Datetime	Datetime when the member employment record was created in the system
Updated	Datetime	Datetime when the member employment record was last updated.
User	String	Name of the user
Employer type	String	Employer type

Previous | Get api v1 connect components by id

Next | Get api v1 members by id

Related topics

Get api v1 members by id

Get a record of a member using member record id that is available on the administration portal

GET/api/v1/Members/{id}

Get a record of a member, by member record ID that is available on the administration portal

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "membership": {
    "id": "string",
    "created": "2023-12-08T07:26:34.270Z",
    "firstName": "string",
    "memberId": "string",
    "gender": "string",
    "genderId": 0,
    "identificationNumber": "string",
    "identificationType": "string",
    "identificationTypeId": 0,
    "isActive": true,
    "knownAs": "string",
    "lastName": "string",
    "middleName": "string",
    "pictureUrl": "string",
    "race": "string",
    "raceId": 0,
    "updated": "2023-12-08T07:26:34.270Z",
    "userIdentifier": "string",
    "organizationId": "string",
    "accountNumber": "string",
    "dateJoined": "2023-12-08T07:26:34.270Z",
    "startDate": "2023-12-08T07:26:34.270Z",
    "endDate": "2023-12-08T07:26:34.270Z",
    "group": "string",
    "membershipNumber": "string",
    "professionalNumber": "string",
    "membershipStatusId": 0,
    "membershipStatus": "string"
  },
  "memberContacts": [
    {
      "contactType": "string",
      "contactTypeId": 0,
      "created": "2023-12-08T07:26:34.270Z",
      "id": "string",
      "member": "string",
      "memberId": "string",
      "organization": "string",
      "organizationId": "string",
      "memberOrganizationId": "string",
      "updated": "2023-12-08T07:26:34.270Z",
      "value": "string",
      "usageTypeId": 0,
      "usageType": "string"
    }
  ],
  "memberAddresses": [
    {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "addressLine4": "string",
      "addressType": "string",
      "addressTypeId": 0,
      "code": "string",
      "created": "2023-12-08T07:26:34.270Z",
      "id": "string",
      "member": "string",
      "memberId": "string",
      "organization": "string",
      "organizationId": "string",
      "memberOrganizationId": "string",
      "countryId": "string",
      "country": "string",
      "region": "string",
      "usageTypeId": 0,
      "usageType": "string",
      "updated": "2023-12-08T07:26:34.271Z"
    }
  ],
  "memberDocuments": [
    {
      "created": "2023-12-08T07:26:34.271Z",
      "documentUrl": "string",
      "title": "string",
      "id": "string",
      "member": "string",
      "memberId": "string",
      "memberOrganizationId": "string",
      "organizationId": "string",
      "documentType": "string",
      "documentTypeId": "string",
      "updated": "2023-12-08T07:26:34.271Z",
      "uploadedBy": "string"
    }
  ],
  "memberNotes": [
    {
      "id": "string",
      "note": "string",
      "memberOrganizationId": "string",
      "author": "string",
      "tags": "string",
      "user": "string",
      "isActive": true,
      "created": "2023-12-08T07:26:34.271Z",
      "updated": "2023-12-08T07:26:34.271Z"
    }
  ],
  "memberEmployments": [
    {
      "id": "string",
      "employerName": "string",
      "employerTypeId": "string",
      "position": "string",
      "startDate": "2023-12-08T07:26:34.271Z",
      "endDate": "2023-12-08T07:26:34.271Z",
      "contactPerson": "string",
      "memberOrganizationId": "string",
      "created": "2023-12-08T07:26:34.271Z",
      "updated": "2023-12-08T07:26:34.271Z",
      "user": "string",
      "employerType": "string"
    }
  ]
}

Field	Type	Description
Membership
Id	String	Internal ID to identify member
Created	Datetime	Datetime when the member record was created in the system
First name	String	First name of a member
Member id	String	Member identification number to identify member
Gender	String	Gender of a member
Gender id	Integer	Gender identification number to identify member gender type
Identification number	String	Identification number of a member
Identification type	String	Identification type of a member
Identification type id	Integer	Identification type id to identify member ID type
Is active	Boolean	Status of the member profile
Known as	String	Another name of a member
Last name	String	Last name of a member
Middle name	String	Middle name of a member
Picture url	String	Picture url of a member
Race	String	Race of a member
Race id	Integer	Race identification number to identify member’s race
Updated	Datetime	Datetime when the member record was last updated.
User identifier	String	Email address of a member
Organization id	String	Organization id to identify the organization the member belongs to
Account number	String	Account number assigned to the member
Date joined	Datetime	Datetime when the member join the organization. While often the same as 'created', these values can be adjusted by admins or backdated during import.
Start date	Datetime	Datetime when the member started with the organization
End date	Datetime	Datetime when a membership is set to expire (can be null for lifetime or automatically re-billing Memberships)
Group	String	Group the member belongs to
Membership number	String	Membership number assigned to the member for identification
Membership status id	Integer	Membership number id to identify the membership number
Membership status	String	The membership status of the member profile
Member contacts
Contact type	String	Contact type of the member contact
Contact type id	Integer	Contact type Id of the contact type
Created	Datetime	Datetime when the member contact record was created in the system
Id	String	Internal ID to identify member contacts
Member	String	The name of the member
Member id	String	The member id number to identify the member
Organization	String	The name of the organization the member belongs to
Organization id	String	The organization id number to identify the organization
Updated	Datetime	Datetime when the member contact record was last updated.
Value	String	The value of the contact
Usage type id	Integer	The contact usage type id
Usage type	String	The contact usage type
Member addresses
Address line 1	String	Complex name
Address line 2	String	Street address
Address line 3	String	Suburb
Address line 4	String	Town or city
Address type	String	Address type
Address line type id	Integer	Address line type id
Code	String	Address code
Created	Datetime	Datetime when the member address record was created in the system
Id	String	Address id to identify the address
Member	String	Name of the member
Member id	String	The member id number to identify the member
Organization	String	The name of the organization the member belongs to
Organization id	String	The organization id number to identify the organization
Member organization id	String	Member organization id to identify the member
Country id	String	Country id to identify the country
Country	String	Name of the country
Region	String	Region in the country
Usage type id	Integer	Usage type id to identify the address
Usage type	String	Usage type of the address
Updated	Datetime	Datetime when the member address record was last updated.
Member documents
Created	Datetime	Datetime when the member document record was created in the system
Document url	String	Member document link
Title	String	Member document title
Id	String	Document id to identify the document
Member	String	Name of the member
Member id	String	Member id to identify the member
Member organization id	String	Member organization id to identify the member
Organization id	String	id to identify the organization
Document type	String	Member document type
Document type id	String	Document type id to identify the document
Updated	Datetime	Datetime when the member document record was last updated.
Uploaded by	String	Name of the person who uploaded the record
Member notes
Id	String	Member notes id to identify the notes
Note	String	The note content
Member organization id	String	Member organization id to identify the member
Author	String	Note author
Tags	String	Note tags
User	String	Note user
Is active	Boolean	Indication whether the note is active or not
Created	Datetime	Datetime when the member note record was created in the system
Updated	Datetime	Datetime when the member note record was last updated.
Member employments
Id	String	Member employment record id to identify the employment record
Employer name	String	Name of the employer
Employer type id	String	Employer type id to identify the employer type
Position	String	Position held by the employer
Start date	Datetime	Datetime when a member’s employment period started
End date	Datetime	Datetime when a member’s employment ended
Contact person	String	Contact person
Member organization id	String	Member organization id to identify the member
Created	Datetime	Datetime when the member employment record was created in the system
Updated	Datetime	Datetime when the member employment record was last updated.
User	String	Name of the user
Employer type	String	Employer type

Previous | Get api v1 members

Next | Get api v1 members contacts by id

Related topics

Get Api V1 Members

Get api v1 members contacts by id

Get contact records of members using the contact record id that is available on the administration portal

GET/api/v1/Members/contacts/{id}

Get a record of a member’s contact record by contact record ID that is available on the administration portal

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "contactType": "string",
  "contactTypeId": 0,
  "created": "2023-12-08T07:32:00.827Z",
  "id": "string",
  "member": "string",
  "memberId": "string",
  "organization": "string",
  "organizationId": "string",
  "memberOrganizationId": "string",
  "updated": "2023-12-08T07:32:00.827Z",
  "value": "string",
  "usageTypeId": 0,
  "usageType": "string"
}

Field	Type	Description
Contact type	String	Contact type of the member contact
Contact type id	Integer	Contact type Id of the contact type
Created	Datetime	Datetime when the member contact record was created in the system
Id	String	Internal ID to identify member contacts
Member	String	The name of the member
Member id	String	The member id number to identify the member
Organization	String	The name of the organization the member belongs to
Organization id	String	The organization id number to identify the organization
Updated	Datetime	Datetime when the member contact record was last updated.
Value	String	The value of the contact
Usage type id	Integer	The contact usage type id
Usage type	String	The contact usage type

Previous | Get api v1 members by id

Next | Get api v1 members addresses by id

Related topics

Get Api V1 Members By Id

Get api v1 members addresses by id

Get address records of members using the address record id that is available on the administration portal

GET/api/v1/Members/addresses/{id}

Get a record of a member’s address record by address record ID that is available on the administration portal

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "addressType": "string",
  "addressTypeId": 0,
  "code": "string",
  "created": "2023-12-08T07:37:56.574Z",
  "id": "string",
  "member": "string",
  "memberId": "string",
  "organization": "string",
  "organizationId": "string",
  "memberOrganizationId": "string",
  "countryId": "string",
  "country": "string",
  "region": "string",
  "usageTypeId": 0,
  "usageType": "string",
  "updated": "2023-12-08T07:37:56.574Z"
}

Field	Type	Description
Address line 1	String	Complex name
Address line 2	String	Street address
Address line 3	String	Suburb
Address line 4	String	Town or city
Address type	String	Address type
Address line type id	Integer	Address line type id
Code	String	Address code
Created	Datetime	Datetime when the member address record was created in the system
Id	String	Address id to identify the address
Member	String	Name of the member
Member id	String	The member id number to identify the member
Organization	String	The name of the organization the member belongs to
Organization id	String	The organization id number to identify the organization
Member organization id	String	Member organization id to identify the member

Previous | Get api v1 members contacts by id

Next | Get api v1 members documents by id

Related topics

Get Api V1 Members By Id

Get api v1 members documents by id

Get documents records of members using the documents record id that is available on the administration portal

GET/api/v1/Members/documents/{id}

Get a record of a member’s documents record by document record ID that is available on the administration portal

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "created": "2023-12-08T07:43:13.892Z",
  "documentUrl": "string",
  "title": "string",
  "id": "string",
  "member": "string",
  "memberId": "string",
  "memberOrganizationId": "string",
  "organizationId": "string",
  "documentType": "string",
  "documentTypeId": "string",
  "updated": "2023-12-08T07:43:13.892Z",
  "uploadedBy": "string"
}

Field	Type	Description
Created	Datetime	Datetime when the member document record was created in the system
Document url	String	Member document link
Title	String	Member document title
Id	String	Document id to identify the document
Member	String	Name of the member
Member id	String	Member id to identify the member
Member organization id	String	Member organization id to identify the member
Organization id	String	Id to identify the organization
Document type	String	Member document type
Document type id	String	Document type id to identify the document
Updated	Datetime	Datetime when the member document record was last updated.
Uploaded by	String	Name of the person who uploaded the record

Previous | Get api v1 members addresses by id

Next | Get api v1 members notes by id

Related topics

Get Api V1 Members By Id

Get api v1 members notes by id

Get notes records of members using the notes record id that is available on the administration portal

GET/Api/V1/Members/Notes/{Id}

Get a record of a member’s notes record by note record ID that is available on the administration portal

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "id": "string",
  "note": "string",
  "memberOrganizationId": "string",
  "author": "string",
  "tags": "string",
  "user": "string",
  "isActive": true,
  "created": "2023-12-08T07:47:17.372Z",
  "updated": "2023-12-08T07:47:17.372Z"
}

Field	Type	Description
Id	String	Member notes id to identify the notes
Note	String	The note content
Member organization id	String	Member organization id to identify the member
Author	String	Note author
Tags	String	Note tags
User	String	Note user
Is active	Boolean	Indication whether the note is active or not
Created	Datetime	Datetime when the member note record was created in the system
Updated	Datetime	Datetime when the member note record was last updated.

Previous | Get api v1 members documents by id

Next | Get api v1 members employments by id

Related topics

Get Api V1 Members By Id

Get api v1 members employments by id

Get employments records of members using the employments record id that is available on the administration portal

GET/api/v1/Members/employments/{id}

Get a record of a member’s employment record by employment record ID that is available on the administration portal

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "id": "string",
  "employerName": "string",
  "employerTypeId": "string",
  "position": "string",
  "startDate": "2023-12-08T08:00:57.551Z",
  "endDate": "2023-12-08T08:00:57.551Z",
  "contactPerson": "string",
  "memberOrganizationId": "string",
  "created": "2023-12-08T08:00:57.551Z",
  "updated": "2023-12-08T08:00:57.551Z",
  "user": "string",
  "employerType": "string"
}

Field	Type	Description
Id	String	Member employment record id to identify the employment record
Employer name	String	Name of the employer
Employer type id	String	Employer type id to identify the employer type
Position	String	Position held by the employer
Start date	Datetime	Datetime when a member’s employment period started
End date	Datetime	Datetime when a member’s employment ended
Contact person	String	Contact person
Member organization id	String	Member organization id to identify the member
Created	Datetime	Datetime when the Member employment record was created in the system
Updated	Datetime	Datetime when the Member employment record was last updated.
User	String	Name of the user
Employer type	String	Employer type

Previous | Get api v1 members notes by id

Next | Get api v1 members docs by members id

Related topics

Get Api V1 Members By Id

Get api v1 members docs by members id

Get member docs records by using member id that is available on the administration portal

GET/API/V1/MEMBERS/{ID}/DOCS

Get a list of the document records of a member, by member record ID.

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Member Id	Integer
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "created": "2023-12-08T08:05:35.367Z",
      "documentUrl": "string",
      "title": "string",
      "id": "string",
      "member": "string",
      "memberId": "string",
      "memberOrganizationId": "string",
      "organizationId": "string",
      "documentType": "string",
      "documentTypeId": "string",
      "updated": "2023-12-08T08:05:35.367Z",
      "uploadedBy": "string"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Created	Datetime	Datetime when the member document record was created in the system
Document url	String	Member document link
Title	String	Member document title
Id	String	Document id to identify the document
Member	String	Name of the member
Member id	String	Member id to identify the member
Member organization id	String	Member organization id to identify the member
Organization id	String	Id to identify the organization
Document type	String	Member document type
Document type id	String	Document type id to identify the document
Updated	Datetime	Datetime when the member document record was last updated.
Uploaded by	String	Name of the person who uploaded the record

Previous | Get api v1 members employments by id

Next | Get api v1 members contacts by members id

Related topics

Get Api V1 Members By Id

Get api v1 members contacts by members id

Get member contact records by using member id that is available on the administration portal

GET/api/v1/Members/{id}/contacts

Get a list of the contact records of a member, by member record ID.

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Contact Type Id	Integer
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "contactType": "string",
      "contactTypeId": 0,
      "created": "2023-12-08T08:12:56.430Z",
      "id": "string",
      "member": "string",
      "memberId": "string",
      "organization": "string",
      "organizationId": "string",
      "memberOrganizationId": "string",
      "updated": "2023-12-08T08:12:56.430Z",
      "value": "string",
      "usageTypeId": 0,
      "usageType": "string"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Contact type	String	Contact type of the member contact
Contact type id	Integer	Contact type Id of the contact type
Created	Datetime	Datetime when the member contact record was created in the system
Id	String	Internal ID to identify member contacts
Member	String	The name of the member
Member id	String	The member id number to identify the member
Organization	String	The name of the organization the member belongs to
Organization id	String	the organization id number to identify the organization
Updated	Datetime	Datetime when the member contact record was last updated.
Value	String	The value of the contact
Usage type id	Integer	The contact usage type id
Usage type	String	The contact usage type

Previous | Get api v1 members docs by members id

Next | Get api v1 members addresses by members id

Related topics

Get Api V1 Members By Id

Get api v1 members addresses by members id

Get member address records by using member id that is available on the administration portal

GET/api/v1/Members/{id}/addresses

Get a list of the address records of a member, by member record ID.

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Address Type Id	Integer
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "addressLine4": "string",
      "addressType": "string",
      "addressTypeId": 0,
      "code": "string",
      "created": "2023-12-08T08:15:27.726Z",
      "id": "string",
      "member": "string",
      "memberId": "string",
      "organization": "string",
      "organizationId": "string",
      "memberOrganizationId": "string",
      "countryId": "string",
      "country": "string",
      "region": "string",
      "usageTypeId": 0,
      "usageType": "string",
      "updated": "2023-12-08T08:15:27.726Z"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Address line 1	String	Complex name
Address line 2	String	Street address
Address line 3	String	Suburb
Address line 4	String	Town or city
Address type	String	Address type
Address line type id	Integer	address line type id
Code	String	Address code
Created	Datetime	Datetime when the member address record was created in the system
Id	String	Address id to identify the address
Member	String	Name of the member
Member id	String	The member id number to identify the member
Organization	String	The name of the organization the member belongs to
Organization id	String	The organization id number to identify the organization
Member organization id	String	Member organization id to identify the member
Country id	String	Country id to identify the country
Country	String	Name of the country
Region	String	Region in the country
Usage type id	Integer	Usage type id to identify the address
Usage type	String	Usage type of the address
Updated	Datetime	Datetime when the member address record was last updated.

Previous | Get api v1 members contacts by members id

Next | Get api v1 members notes by members id

Related topics

Get Api V1 Members By Id

Get api v1 members notes by members id

Get member notes records by using member id that is available on the administration portal

GET/api/v1/Members/{id}/notes

Get a list of the notes records of a member by member record ID.

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "id": "string",
      "note": "string",
      "memberOrganizationId": "string",
      "author": "string",
      "tags": "string",
      "user": "string",
      "isActive": true,
      "created": "2023-12-08T08:19:56.909Z",
      "updated": "2023-12-08T08:19:56.909Z"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Id	String	Member notes id to identify the notes
Note	String	The note content
Member organization id	String	Member organization id to identify the member
Author	String	Note author
Tags	String	Note tags
User	String	Note user
Is active	Boolean	Indication whether the note is active or not
Created	Datetime	Datetime when the member note record was created in the system
Updated	Datetime	Datetime when the member note record was last updated.

Previous | Get api v1 members addresses by members id

Next | Get api v1 members employments by members id

Related topics

Get Api V1 Members By Id

Get api v1 members employments by members id

Get member employment records by using member id that is available on the administration portal

GET/api/v1/Members/{id}/employments

Get a list of the employment records of a member, by member record ID.

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Employment Type Id	Integer
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "id": "string",
      "employerName": "string",
      "employerTypeId": "string",
      "position": "string",
      "startDate": "2023-12-08T08:23:27.743Z",
      "endDate": "2023-12-08T08:23:27.743Z",
      "contactPerson": "string",
      "memberOrganizationId": "string",
      "created": "2023-12-08T08:23:27.743Z",
      "updated": "2023-12-08T08:23:27.743Z",
      "user": "string",
      "employerType": "string"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Id	String	Member employment record id to identify the employment record
Employer name	String	Name of the employer
Employer type id	String	Employer type id to identify the employer type
Position	String	Position held by the employer
Start date	Datetime	Datetime when a member’s employment period started
End date	Datetime	Datetime when a member’s employment ended
Contact person	String	Contact person
Member organization id	String	Member organization id to identify the member
Created	Datetime	Datetime when the member employment record was created in the system
Updated	Datetime	Datetime when the member employment record was last updated.
User	String	Name of the user
Employer type	String	Employer type

Previous | Get api v1 members notes by members id

Next | Get api v1 organizations by id

Related topics

Get Api V1 Members By Id

Get api v1 organizations by id

Get the organization details by using the organization id

GET/API/V1/ORGANIZATIONS/{ID}

Get The Organization Details By Organization ID

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "chapters": [
    {
      "id": "string",
      "name": "string",
      "organizationId": "string",
      "managedByFirstName": "string",
      "managedByLastName": "string",
      "managedByMiddleName": "string",
      "contactPersonMiddleName": "string",
      "contactNumber": "string",
      "contactEmail": "string",
      "city": "string",
      "region": "string",
      "countryId": "string",
      "managingPersonTitleId": 0,
      "created": "2023-12-08T08:33:25.063Z",
      "updated": "2023-12-08T08:33:25.063Z",
      "user": "string",
      "contactPersonFirstName": "string",
      "contactPersonLastName": "string",
      "organization": "string",
      "country": "string",
      "managingTitle": "string",
      "members": 0
    }
  ],
  "memberGroups": [
    {
      "id": "string",
      "description": "string",
      "organizationId": "string",
      "user": "string",
      "membersCount": 0,
      "created": "2023-12-08T08:33:25.063Z",
      "updated": "2023-12-08T08:33:25.063Z"
    }
  ],
  "organizationPaymentProviders": [
    {
      "baseUrl": "string",
      "confirmationEmailAddress": "string",
      "displayText": "string",
      "id": "string",
      "isActive": true,
      "active": "string",
      "isSystemDefault": true,
      "systemDefault": "string",
      "paymentProvider": "string",
      "merchantId": "string",
      "merchantKey": "string",
      "merchantPassPhrase": "string",
      "organizationId": "string",
      "paymentNotifyUrl": "string",
      "paymentProcessingUrl": "string",
      "paymentProviderId": 0
    }
  ],
  "documentTypes": [
    {
      "created": "2023-12-08T08:33:25.063Z",
      "description": "string",
      "id": "string",
      "user": "string",
      "organizationId": "string",
      "updated": "2023-12-08T08:33:25.063Z",
      "documentsCount": 0
    }
  ],
  "organizationFeatures": [
    {
      "id": "string",
      "organizationId": "string",
      "featureId": "string",
      "customLabel": "string",
      "controller": "string",
      "icon": "string",
      "hasSubmenu": true,
      "hasLink": true,
      "link": "string",
      "displayorder": 0,
      "created": "2023-12-08T08:33:25.063Z",
      "updated": "2023-12-08T08:33:25.063Z"
    }
  ],
  "organizationLabels": [
    {
      "id": "string",
      "systemLabelId": "string",
      "organizationId": "string",
      "created": "2023-12-08T08:33:25.063Z",
      "updated": "2023-12-08T08:33:25.063Z",
      "user": "string",
      "defaultName": "string",
      "customName": "string"
    }
  ],
  "accountId": "string",
  "contactName": "string",
  "created": "2023-12-08T08:33:25.063Z",
  "email": "string",
  "id": "string",
  "logo": "string",
  "members": 0,
  "name": "string",
  "registrationNumber": "string",
  "telephone": "string",
  "updated": "2023-12-08T08:33:25.063Z",
  "vatNumber": "string",
  "website": "string"
}

Field	Type	Description
Id	String	Internal id to identify the organization
Name	String	Name of the organization
Organization id	String	Organization id number
Managed by first name	String	Name of the person managing the organization
Managed by last name	String	Last name of the person managing the organization
Managed by middle name	String	Middle name of the person managing the organization
Contact personal middle name	String	Middle name of the contact person managing the organization
Contact number	String	Contact number of the person managing the organization
Contact email	String	Contact email of the person managing the organization
City	String	City where the organization is located
Region	String	Region where the organization is located
Country id	String	Country id where the organization is located
Managing person title id	Integer	Managing person title id
Created	Datetime	Datetime when the organization was created in the system
Updated	Datetime	Datetime when the organization was last updated.
User	String	Name of the user
Contact person first name	String	Contact person first name
Contact person last name	String	Contact person last name
Organization	String	Name of the organization
Country	String	Name of the country
Managing title	String	Managing title
Members	Integer	Members within the organization

Previous | Get api v1 members employments by members id

Next | Get api v1 organizations groups by organizations id

Related topics

Get Api V1 Organizations By Id

Get api v1 organizations groups by organizations id

Get a list of the groups within the organization by using organization id

GET/api/v1/Organizations/{id}/groups

Get a list of the groups within the organization, by organization ID

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "id": "string",
      "description": "string",
      "organizationId": "string",
      "user": "string",
      "membersCount": 0,
      "created": "2023-12-08T08:43:11.992Z",
      "updated": "2023-12-08T08:43:11.992Z"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Id	String	Internal id to identify the organization
Description	String	Description of the group
Organization id	String	Organization id number
User	String	Name of the user
Member count	Integer	Members within the group
Created	Datetime	Datetime when the organization was created in the system
Updated	Datetime	Datetime when the organization was last updated.

Previous | Get api v1 organizations by id

Next | Get api v1 organizations payment providers by organizations id

Related topics

Get Api V1 Organizations By Id

Get api v1 organizations payment providers by organizations id

Get a list of the payment providers within the organization by using organization id

GET/api/v1/Organizations/{id}/paymentProviders

Get a list of the payment providers within the organization, by organization ID

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "baseUrl": "string",
      "confirmationEmailAddress": "string",
      "displayText": "string",
      "id": "string",
      "isActive": true,
      "active": "string",
      "isSystemDefault": true,
      "systemDefault": "string",
      "paymentProvider": "string",
      "merchantId": "string",
      "merchantKey": "string",
      "merchantPassPhrase": "string",
      "organizationId": "string",
      "paymentNotifyUrl": "string",
      "paymentProcessingUrl": "string",
      "paymentProviderId": 0
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Base url	String	Base link of the payment
Confirmation email address	String	Confirmation email address used for the payment
Display text	String	Payment display text
Id	String	Internal ID to identify payments
Is active	Boolean	Status of the payment provider
Active	String	Status of the payment provider
Is system default	Boolean	System default status of the payment provider
System default	String	System default status
Payment provider	String	Payment provider name
Merchant id	String	Merchant id to identify merchant
Merchant key	String	Merchant key to identify merchant
Merchant pass phrase	String	Merchant pass phrase
Organization id	String	Unique ID identifying the organization associated with the Payment
Payment notify url	String	Payment notify url
Payment processing url	String	Payment processing url
Payment provider id	Integer	Payment provider id to identify payment provider

Previous | Get api v1 organizations groups by organizations id

Next | Get api v1 organizations document types by organizations id

Related topics

Get Api V1 Organizations By Id

Get api v1 organizations document types by organizations id

Get a list of the document types within the organization by using organization id

GET/api/v1/Organizations/{id}/documentTypes

Get a list of the document types within the organization, by organization ID

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "created": "2023-12-08T08:52:57.440Z",
      "description": "string",
      "id": "string",
      "user": "string",
      "organizationId": "string",
      "updated": "2023-12-08T08:52:57.440Z",
      "documentsCount": 0
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Created	Datetime	Datetime when the document type was created in the system
Description	String	Description of the group
Id	String	Internal id to identify the document type
User	String	Name of the user
Organization id	String	Organization id number
Updated	Datetime	Datetime when the organization was last updated.
Documents count	Integer	Documents within the document type

Previous | Get api v1 organizations payment providers by organizations id

Next | Get api v1 organizations features by organizations id

Related topics

Get Api V1 Organizations By Id

Get api v1 organizations features by organizations id

Get a list of the features within the organization by using organization id

GET/api/v1/Organizations/{id}/features

Get A List Of The Features Within The Organization, By Organization ID

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "id": "string",
      "organizationId": "string",
      "featureId": "string",
      "customLabel": "string",
      "controller": "string",
      "icon": "string",
      "hasSubmenu": true,
      "hasLink": true,
      "link": "string",
      "displayorder": 0,
      "created": "2023-12-08T08:57:02.176Z",
      "updated": "2023-12-08T08:57:02.176Z"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Id	String	Internal ID to identify feature
Organization id	Boolean	Internal ID to identify organization
Feature id	Boolean	Feature id
Custom label	Boolean	Custom label
Controller	Boolean	Controller
Icon	Boolean	Icon
Hs sub menu	Boolean	Has sub menu
Hs link	Boolean	Has link
Link	String	Feature Link
Display order	Integer	Display order number
Created	Datetime	Datetime when the feature record was created in the system
Updated	Datetime	Datetime when the feature record was last updated in the system

Previous | Get api v1 organizations document types by organizations id

Next | Get api v1 organizations labels by organizations id

Related topics

Get Api V1 Organizations By Id

Get api v1 organizations labels by organizations id

Get a list of the labels within the organization by using organization id

GET/api/v1/Organizations/{id}/labels

Get a list of the labels within the organization, by organization ID

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "id": "string",
      "systemLabelId": "string",
      "organizationId": "string",
      "created": "2023-12-08T09:04:58.453Z",
      "updated": "2023-12-08T09:04:58.453Z",
      "user": "string",
      "defaultName": "string",
      "customName": "string"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Id	String	Internal id to identify the document type
System label id	String	Internal id to identify the system label
Organization id	String	Organization id number
Created	Datetime	Datetime when the label was created in the system
Updated	Datetime	Datetime when the label was last updated.
User	String	Name of the user
Custom name	String	The custom name of the label

Previous | Get api v1 organizations features by organizations id

Next | Get api v1 organizations chapters by organizations id

Related topics

Get Api V1 Organizations By Id

Get api v1 organizations chapters by organizations id

Get a list of the chapters within the organization by using organization id

GET/api/v1/Organizations/{id}/chapters

Get a list of the chapters within the organization, by organization ID

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

RESPONSE INFORMATION

Code: 200
Description: successful
Media type: text/plain; application/json; text/json
Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "id": "string",
      "name": "string",
      "organizationId": "string",
      "managedByFirstName": "string",
      "managedByLastName": "string",
      "managedByMiddleName": "string",
      "contactPersonMiddleName": "string",
      "contactNumber": "string",
      "contactEmail": "string",
      "city": "string",
      "region": "string",
      "countryId": "string",
      "managingPersonTitleId": 0,
      "created": "2023-12-08T09:08:31.422Z",
      "updated": "2023-12-08T09:08:31.422Z",
      "user": "string",
      "contactPersonFirstName": "string",
      "contactPersonLastName": "string",
      "organization": "string",
      "country": "string",
      "managingTitle": "string",
      "members": 0
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Id	String	Internal id to identify the organization chapter
Name	String	Name of the organization chapter
Organization id	String	Organization id number
managed by first name	String	Name of the person managing the organization chapter
Managed by last name	String	Last name of the person managing the organization chapter
Managed by middle name	String	Middle name of the person managing the organization chapter
Contact personal middle name	String	Middle name of the contact person managing the organization chapter
Contact number	String	Contact number of the person managing the organization chapter
Contact email	String	Contact email of the person managing the organization chapter
City	String	City where the organization chapter is located
Region	String	Region where the organization chapter is located
Country id	String	Country id where the organization chapter is located
Managing person title id	Integer	Managing person title id
Created	Datetime	Datetime when the chapter was created in the system
Updated	Datetime	Datetime when the chapter was last updated.
User	String	Name of the user
Contact person first name	String	Contact person first name
Contact person last name	String	Contact person last name
Organization	String	Name of the organization
Country	String	Name of the country
Managing title	String	Managing title
Members	Integer	Members within the chapter

Previous | Get api v1 organizations labels by organizations id

Related topics

Get Api V1 Organizations By Id