Exploring the Graviti api
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 |
Related topics